diff --git a/sdk/search/Azure.Search.Documents.Indexes/Azure.Search.Documents.Indexes.sln b/sdk/search/Azure.Search.Documents.Indexes/Azure.Search.Documents.Indexes.sln new file mode 100644 index 000000000000..c6e4d8616b88 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/Azure.Search.Documents.Indexes.sln @@ -0,0 +1,56 @@ +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.29709.97 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Core.TestFramework", "..\..\core\Azure.Core.TestFramework\src\Azure.Core.TestFramework.csproj", "{ECC730C1-4AEA-420C-916A-66B19B79E4DC}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Azure.Search.Documents.Indexes", "src\Azure.Search.Documents.Indexes.csproj", "{28FF4005-4467-4E36-92E7-DEA27DEB1519}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Azure.Search.Documents.Indexes.Tests", "tests\Azure.Search.Documents.Indexes.Tests.csproj", "{1F1CD1D4-9932-4B73-99D8-C252A67D4B46}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {B0C276D1-2930-4887-B29A-D1A33E7009A2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {B0C276D1-2930-4887-B29A-D1A33E7009A2}.Debug|Any CPU.Build.0 = Debug|Any CPU + {B0C276D1-2930-4887-B29A-D1A33E7009A2}.Release|Any CPU.ActiveCfg = Release|Any CPU + {B0C276D1-2930-4887-B29A-D1A33E7009A2}.Release|Any CPU.Build.0 = Release|Any CPU + {8E9A77AC-792A-4432-8320-ACFD46730401}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {8E9A77AC-792A-4432-8320-ACFD46730401}.Debug|Any CPU.Build.0 = Debug|Any CPU + {8E9A77AC-792A-4432-8320-ACFD46730401}.Release|Any CPU.ActiveCfg = Release|Any CPU + {8E9A77AC-792A-4432-8320-ACFD46730401}.Release|Any CPU.Build.0 = Release|Any CPU + {ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Debug|Any CPU.Build.0 = Debug|Any CPU + {ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Release|Any CPU.ActiveCfg = Release|Any CPU + {ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Release|Any CPU.Build.0 = Release|Any CPU + {A4241C1F-A53D-474C-9E4E-075054407E74}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {A4241C1F-A53D-474C-9E4E-075054407E74}.Debug|Any CPU.Build.0 = Debug|Any CPU + {A4241C1F-A53D-474C-9E4E-075054407E74}.Release|Any CPU.ActiveCfg = Release|Any CPU + {A4241C1F-A53D-474C-9E4E-075054407E74}.Release|Any CPU.Build.0 = Release|Any CPU + {FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Debug|Any CPU.Build.0 = Debug|Any CPU + {FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Release|Any CPU.ActiveCfg = Release|Any CPU + {FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Release|Any CPU.Build.0 = Release|Any CPU + {85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Debug|Any CPU.Build.0 = Debug|Any CPU + {85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Release|Any CPU.ActiveCfg = Release|Any CPU + {85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Release|Any CPU.Build.0 = Release|Any CPU + {28FF4005-4467-4E36-92E7-DEA27DEB1519}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {28FF4005-4467-4E36-92E7-DEA27DEB1519}.Debug|Any CPU.Build.0 = Debug|Any CPU + {28FF4005-4467-4E36-92E7-DEA27DEB1519}.Release|Any CPU.ActiveCfg = Release|Any CPU + {28FF4005-4467-4E36-92E7-DEA27DEB1519}.Release|Any CPU.Build.0 = Release|Any CPU + {1F1CD1D4-9932-4B73-99D8-C252A67D4B46}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {1F1CD1D4-9932-4B73-99D8-C252A67D4B46}.Debug|Any CPU.Build.0 = Debug|Any CPU + {1F1CD1D4-9932-4B73-99D8-C252A67D4B46}.Release|Any CPU.ActiveCfg = Release|Any CPU + {1F1CD1D4-9932-4B73-99D8-C252A67D4B46}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {A97F4B90-2591-4689-B1F8-5F21FE6D6CAE} + EndGlobalSection +EndGlobal diff --git a/sdk/search/Azure.Search.Documents.Indexes/CHANGELOG.md b/sdk/search/Azure.Search.Documents.Indexes/CHANGELOG.md new file mode 100644 index 000000000000..8b33f0fedccc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/CHANGELOG.md @@ -0,0 +1,11 @@ +# Release History + +## 1.0.0-beta.1 (Unreleased) + +### Features Added + +### Breaking Changes + +### Bugs Fixed + +### Other Changes \ No newline at end of file diff --git a/sdk/search/Azure.Search.Documents.Indexes/Directory.Build.props b/sdk/search/Azure.Search.Documents.Indexes/Directory.Build.props new file mode 100644 index 000000000000..63bd836ad44b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/Directory.Build.props @@ -0,0 +1,6 @@ + + + + diff --git a/sdk/search/Azure.Search.Documents.Indexes/README.md b/sdk/search/Azure.Search.Documents.Indexes/README.md new file mode 100644 index 000000000000..3f49cbf0a8d0 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/README.md @@ -0,0 +1,107 @@ +# Azure.Search.Documents.Indexes client library for .NET + +Azure.Search.Documents.Indexes is a managed service that helps developers get secret simply and securely. + +Use the client library for to: + +* [Get secret](https://docs.microsoft.com/azure) + +[Source code][source_root] | [Package (NuGet)][package] | [API reference documentation][reference_docs] | [Product documentation][azconfig_docs] | [Samples][source_samples] + + [Source code](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/search/Azure.Search.Documents.Indexes/src) | [Package (NuGet)](https://www.nuget.org/packages) | [API reference documentation](https://azure.github.io/azure-sdk-for-net) | [Product documentation](https://docs.microsoft.com/azure) + +## Getting started + +This section should include everything a developer needs to do to install and create their first client connection *very quickly*. + +### Install the package + +First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `dotnet add package package-name`, but should enable a developer to successfully install the package from NuGet, npm, or even cloning a GitHub repository. + +Install the client library for .NET with [NuGet](https://www.nuget.org/ ): + +```dotnetcli +dotnet add package Azure.Search.Documents.Indexes --prerelease +``` + +### Prerequisites + +Include a section after the install command that details any requirements that must be satisfied before a developer can [authenticate](#authenticate-the-client) and test all of the snippets in the [Examples](#examples) section. For example, for Cosmos DB: + +> You must have an [Azure subscription](https://azure.microsoft.com/free/dotnet/) and [Cosmos DB account](https://docs.microsoft.com/azure/cosmos-db/account-overview) (SQL API). In order to take advantage of the C# 8.0 syntax, it is recommended that you compile using the [.NET Core SDK](https://dotnet.microsoft.com/download) 3.0 or higher with a [language version](https://docs.microsoft.com/dotnet/csharp/language-reference/configure-language-version#override-a-default) of `latest`. It is also possible to compile with the .NET Core SDK 2.1.x using a language version of `preview`. + +### Authenticate the client + +If your library requires authentication for use, such as for Azure services, include instructions and example code needed for initializing and authenticating. + +For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object. + +### Service API versions + +The client library targets the latest service API version by default. A client instance accepts an optional service API version parameter from its options to specify which API version service to communicate. + +#### Select a service API version + +You have the flexibility to explicitly select a supported service API version when instantiating a client by configuring its associated options. This ensures that the client can communicate with services using the specified API version. + +For example, + +```C# Snippet:CreateClientForSpecificApiVersion +Uri endpoint = new Uri(""); +DefaultAzureCredential credential = new DefaultAzureCredential(); +ClientOptions options = new ClientOptions(ClientOptions.ServiceVersion.) +var client = new Client(endpoint, credential, options); +``` + +When selecting an API version, it's important to verify that there are no breaking changes compared to the latest API version. If there are significant differences, API calls may fail due to incompatibility. + +Always ensure that the chosen API version is fully supported and operational for your specific use case and that it aligns with the service's versioning policy. + +## Key concepts + +The *Key concepts* section should describe the functionality of the main classes. Point out the most important and useful classes in the package (with links to their reference pages) and explain how those classes work together. Feel free to use bulleted lists, tables, code blocks, or even diagrams for clarity. + +Include the *Thread safety* and *Additional concepts* sections below at the end of your *Key concepts* section. You may remove or add links depending on what your library makes use of: + +### Thread safety + +We guarantee that all client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that the recommendation of reusing client instances is always safe, even across threads. + +### Additional concepts + +[Client options](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) | +[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) | +[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) | +[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) | +[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md) | +[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#mocking) | +[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/) + + +## Examples + +You can familiarize yourself with different APIs using [Samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/search/Azure.Search.Documents.Indexes/samples). + +## Troubleshooting + +Describe common errors and exceptions, how to "unpack" them if necessary, and include guidance for graceful handling and recovery. + +Provide information to help developers avoid throttling or other service-enforced errors they might encounter. For example, provide guidance and examples for using retry or connection policies in the API. + +If the package or a related package supports it, include tips for logging or enabling instrumentation to help them debug their code. + +## Next steps + +* Provide a link to additional code examples, ideally to those sitting alongside the README in the package's `/samples` directory. +* If appropriate, point users to other packages that might be useful. +* If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for. + +## Contributing + +This is a template, but your SDK readme should include details on how to contribute code to the repo/package. + + +[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization +[style-guide-cloud]: https://aka.ms/azsdk/cloud-style-guide + +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net/sdk/search/Azure.Search.Documents.Indexes/README.png) \ No newline at end of file diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Azure.Search.Documents.Indexes.csproj b/sdk/search/Azure.Search.Documents.Indexes/src/Azure.Search.Documents.Indexes.csproj new file mode 100644 index 000000000000..7f6a7e205dc5 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Azure.Search.Documents.Indexes.csproj @@ -0,0 +1,20 @@ + + + This is the Azure.Search.Documents.Indexes client library for developing .NET applications with rich experience. + Azure SDK Code Generation Azure.Search.Documents.Indexes for Azure Data Plane + 1.0.0-beta.1 + Azure.Search.Documents.Indexes + $(RequiredTargetFrameworks) + true + + + + + + + + + + + + diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIFoundryModelCatalogName.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIFoundryModelCatalogName.cs new file mode 100644 index 000000000000..36b4265b67b3 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIFoundryModelCatalogName.cs @@ -0,0 +1,66 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// The name of the embedding model from the Azure AI Foundry Catalog that will be + /// called. + /// + public readonly partial struct AIFoundryModelCatalogName : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public AIFoundryModelCatalogName(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string OpenAICLIPImageTextEmbeddingsVitBasePatch32Value = "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32"; + private const string OpenAICLIPImageTextEmbeddingsViTLargePatch14336Value = "OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336"; + private const string FacebookDinoV2ImageEmbeddingsViTBaseValue = "Facebook-DinoV2-Image-Embeddings-ViT-Base"; + private const string FacebookDinoV2ImageEmbeddingsViTGiantValue = "Facebook-DinoV2-Image-Embeddings-ViT-Giant"; + private const string CohereEmbedV3EnglishValue = "Cohere-embed-v3-english"; + private const string CohereEmbedV3MultilingualValue = "Cohere-embed-v3-multilingual"; + + /// OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32. + public static AIFoundryModelCatalogName OpenAICLIPImageTextEmbeddingsVitBasePatch32 { get; } = new AIFoundryModelCatalogName(OpenAICLIPImageTextEmbeddingsVitBasePatch32Value); + /// OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336. + public static AIFoundryModelCatalogName OpenAICLIPImageTextEmbeddingsViTLargePatch14336 { get; } = new AIFoundryModelCatalogName(OpenAICLIPImageTextEmbeddingsViTLargePatch14336Value); + /// Facebook-DinoV2-Image-Embeddings-ViT-Base. + public static AIFoundryModelCatalogName FacebookDinoV2ImageEmbeddingsViTBase { get; } = new AIFoundryModelCatalogName(FacebookDinoV2ImageEmbeddingsViTBaseValue); + /// Facebook-DinoV2-Image-Embeddings-ViT-Giant. + public static AIFoundryModelCatalogName FacebookDinoV2ImageEmbeddingsViTGiant { get; } = new AIFoundryModelCatalogName(FacebookDinoV2ImageEmbeddingsViTGiantValue); + /// Cohere-embed-v3-english. + public static AIFoundryModelCatalogName CohereEmbedV3English { get; } = new AIFoundryModelCatalogName(CohereEmbedV3EnglishValue); + /// Cohere-embed-v3-multilingual. + public static AIFoundryModelCatalogName CohereEmbedV3Multilingual { get; } = new AIFoundryModelCatalogName(CohereEmbedV3MultilingualValue); + /// Determines if two values are the same. + public static bool operator ==(AIFoundryModelCatalogName left, AIFoundryModelCatalogName right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(AIFoundryModelCatalogName left, AIFoundryModelCatalogName right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator AIFoundryModelCatalogName(string value) => new AIFoundryModelCatalogName(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is AIFoundryModelCatalogName other && Equals(other); + /// + public bool Equals(AIFoundryModelCatalogName other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesAccountIdentity.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesAccountIdentity.Serialization.cs new file mode 100644 index 000000000000..abee52322831 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesAccountIdentity.Serialization.cs @@ -0,0 +1,155 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AIServicesAccountIdentity : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AIServicesAccountIdentity)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(Identity)) + { + writer.WritePropertyName("identity"u8); + writer.WriteObjectValue(Identity, options); + } + writer.WritePropertyName("subdomainUrl"u8); + writer.WriteStringValue(SubdomainUrl); + } + + AIServicesAccountIdentity IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AIServicesAccountIdentity)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAIServicesAccountIdentity(document.RootElement, options); + } + + internal static AIServicesAccountIdentity DeserializeAIServicesAccountIdentity(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + SearchIndexerDataIdentity identity = default; + string subdomainUrl = default; + string odataType = default; + string description = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("identity"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + identity = SearchIndexerDataIdentity.DeserializeSearchIndexerDataIdentity(property.Value, options); + continue; + } + if (property.NameEquals("subdomainUrl"u8)) + { + subdomainUrl = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AIServicesAccountIdentity(odataType, description, serializedAdditionalRawData, identity, subdomainUrl); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AIServicesAccountIdentity)} does not support writing '{options.Format}' format."); + } + } + + AIServicesAccountIdentity IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAIServicesAccountIdentity(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AIServicesAccountIdentity)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new AIServicesAccountIdentity FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAIServicesAccountIdentity(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesAccountIdentity.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesAccountIdentity.cs new file mode 100644 index 000000000000..c38ca1eecb20 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesAccountIdentity.cs @@ -0,0 +1,66 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// The multi-region account of an Azure AI service resource that's attached to a + /// skillset. + /// + public partial class AIServicesAccountIdentity : CognitiveServicesAccount + { + /// Initializes a new instance of . + /// The subdomain url for the corresponding AI Service. + /// is null. + public AIServicesAccountIdentity(string subdomainUrl) + { + Argument.AssertNotNull(subdomainUrl, nameof(subdomainUrl)); + + OdataType = "#Microsoft.Azure.Search.AIServicesByIdentity"; + SubdomainUrl = subdomainUrl; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Description of the Azure AI service resource attached to a skillset. + /// Keeps track of any properties unknown to the library. + /// + /// The user-assigned managed identity used for connections to AI Service. If not + /// specified, the system-assigned managed identity is used. On updates to the + /// skillset, if the identity is unspecified, the value remains unchanged. If set + /// to "none", the value of this property is cleared. + /// 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 . + /// + /// The subdomain url for the corresponding AI Service. + internal AIServicesAccountIdentity(string odataType, string description, IDictionary serializedAdditionalRawData, SearchIndexerDataIdentity identity, string subdomainUrl) : base(odataType, description, serializedAdditionalRawData) + { + Identity = identity; + SubdomainUrl = subdomainUrl; + } + + /// Initializes a new instance of for deserialization. + internal AIServicesAccountIdentity() + { + } + + /// + /// The user-assigned managed identity used for connections to AI Service. If not + /// specified, the system-assigned managed identity is used. On updates to the + /// skillset, if the identity is unspecified, the value remains unchanged. If set + /// to "none", the value of this property is cleared. + /// 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 SearchIndexerDataIdentity Identity { get; set; } + /// The subdomain url for the corresponding AI Service. + public string SubdomainUrl { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesAccountKey.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesAccountKey.Serialization.cs new file mode 100644 index 000000000000..3351198056a7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesAccountKey.Serialization.cs @@ -0,0 +1,148 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AIServicesAccountKey : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AIServicesAccountKey)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("key"u8); + writer.WriteStringValue(Key); + writer.WritePropertyName("subdomainUrl"u8); + writer.WriteStringValue(SubdomainUrl); + } + + AIServicesAccountKey IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AIServicesAccountKey)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAIServicesAccountKey(document.RootElement, options); + } + + internal static AIServicesAccountKey DeserializeAIServicesAccountKey(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string key = default; + string subdomainUrl = default; + string odataType = default; + string description = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("key"u8)) + { + key = property.Value.GetString(); + continue; + } + if (property.NameEquals("subdomainUrl"u8)) + { + subdomainUrl = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AIServicesAccountKey(odataType, description, serializedAdditionalRawData, key, subdomainUrl); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AIServicesAccountKey)} does not support writing '{options.Format}' format."); + } + } + + AIServicesAccountKey IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAIServicesAccountKey(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AIServicesAccountKey)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new AIServicesAccountKey FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAIServicesAccountKey(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesAccountKey.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesAccountKey.cs new file mode 100644 index 000000000000..3082412e9e17 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesAccountKey.cs @@ -0,0 +1,55 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// The account key of an Azure AI service resource that's attached to a skillset, + /// to be used with the resource's subdomain. + /// + public partial class AIServicesAccountKey : CognitiveServicesAccount + { + /// Initializes a new instance of . + /// The key used to provision the Azure AI service resource attached to a skillset. + /// The subdomain url for the corresponding AI Service. + /// or is null. + public AIServicesAccountKey(string key, string subdomainUrl) + { + Argument.AssertNotNull(key, nameof(key)); + Argument.AssertNotNull(subdomainUrl, nameof(subdomainUrl)); + + OdataType = "#Microsoft.Azure.Search.AIServicesByKey"; + Key = key; + SubdomainUrl = subdomainUrl; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Description of the Azure AI service resource attached to a skillset. + /// Keeps track of any properties unknown to the library. + /// The key used to provision the Azure AI service resource attached to a skillset. + /// The subdomain url for the corresponding AI Service. + internal AIServicesAccountKey(string odataType, string description, IDictionary serializedAdditionalRawData, string key, string subdomainUrl) : base(odataType, description, serializedAdditionalRawData) + { + Key = key; + SubdomainUrl = subdomainUrl; + } + + /// Initializes a new instance of for deserialization. + internal AIServicesAccountKey() + { + } + + /// The key used to provision the Azure AI service resource attached to a skillset. + public string Key { get; set; } + /// The subdomain url for the corresponding AI Service. + public string SubdomainUrl { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesVisionParameters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesVisionParameters.Serialization.cs new file mode 100644 index 000000000000..b8d189dc68b6 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesVisionParameters.Serialization.cs @@ -0,0 +1,176 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AIServicesVisionParameters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AIServicesVisionParameters)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("modelVersion"u8); + writer.WriteStringValue(ModelVersion); + writer.WritePropertyName("resourceUri"u8); + writer.WriteStringValue(ResourceUri.AbsoluteUri); + if (Optional.IsDefined(ApiKey)) + { + writer.WritePropertyName("apiKey"u8); + writer.WriteStringValue(ApiKey); + } + if (Optional.IsDefined(AuthIdentity)) + { + writer.WritePropertyName("authIdentity"u8); + writer.WriteObjectValue(AuthIdentity, options); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + AIServicesVisionParameters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AIServicesVisionParameters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAIServicesVisionParameters(document.RootElement, options); + } + + internal static AIServicesVisionParameters DeserializeAIServicesVisionParameters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string modelVersion = default; + Uri resourceUri = default; + string apiKey = default; + SearchIndexerDataIdentity authIdentity = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("modelVersion"u8)) + { + modelVersion = property.Value.GetString(); + continue; + } + if (property.NameEquals("resourceUri"u8)) + { + resourceUri = new Uri(property.Value.GetString()); + continue; + } + if (property.NameEquals("apiKey"u8)) + { + apiKey = property.Value.GetString(); + continue; + } + if (property.NameEquals("authIdentity"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + authIdentity = SearchIndexerDataIdentity.DeserializeSearchIndexerDataIdentity(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AIServicesVisionParameters(modelVersion, resourceUri, apiKey, authIdentity, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AIServicesVisionParameters)} does not support writing '{options.Format}' format."); + } + } + + AIServicesVisionParameters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAIServicesVisionParameters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AIServicesVisionParameters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static AIServicesVisionParameters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAIServicesVisionParameters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesVisionParameters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesVisionParameters.cs new file mode 100644 index 000000000000..6b9c4aef999a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesVisionParameters.cs @@ -0,0 +1,118 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Specifies the AI Services Vision parameters for vectorizing a query image or + /// text. + /// + public partial class AIServicesVisionParameters + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// The version of the model to use when calling the AI Services Vision service. It + /// will default to the latest available when not specified. + /// + /// The resource URI of the AI Services resource. + /// or is null. + public AIServicesVisionParameters(string modelVersion, Uri resourceUri) + { + Argument.AssertNotNull(modelVersion, nameof(modelVersion)); + Argument.AssertNotNull(resourceUri, nameof(resourceUri)); + + ModelVersion = modelVersion; + ResourceUri = resourceUri; + } + + /// Initializes a new instance of . + /// + /// The version of the model to use when calling the AI Services Vision service. It + /// will default to the latest available when not specified. + /// + /// The resource URI of the AI Services resource. + /// API key of the designated AI Services resource. + /// + /// The user-assigned managed identity used for outbound connections. If an + /// authResourceId is provided and it's not specified, the system-assigned managed + /// identity is used. On updates to the index, if the identity is unspecified, the + /// value remains unchanged. If set to "none", the value of this property is + /// cleared. + /// 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 . + /// + /// Keeps track of any properties unknown to the library. + internal AIServicesVisionParameters(string modelVersion, Uri resourceUri, string apiKey, SearchIndexerDataIdentity authIdentity, IDictionary serializedAdditionalRawData) + { + ModelVersion = modelVersion; + ResourceUri = resourceUri; + ApiKey = apiKey; + AuthIdentity = authIdentity; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal AIServicesVisionParameters() + { + } + + /// + /// The version of the model to use when calling the AI Services Vision service. It + /// will default to the latest available when not specified. + /// + public string ModelVersion { get; set; } + /// The resource URI of the AI Services resource. + public Uri ResourceUri { get; set; } + /// API key of the designated AI Services resource. + public string ApiKey { get; set; } + /// + /// The user-assigned managed identity used for outbound connections. If an + /// authResourceId is provided and it's not specified, the system-assigned managed + /// identity is used. On updates to the index, if the identity is unspecified, the + /// value remains unchanged. If set to "none", the value of this property is + /// cleared. + /// 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 SearchIndexerDataIdentity AuthIdentity { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesVisionVectorizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesVisionVectorizer.Serialization.cs new file mode 100644 index 000000000000..4ff27f503702 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesVisionVectorizer.Serialization.cs @@ -0,0 +1,147 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AIServicesVisionVectorizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AIServicesVisionVectorizer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(AIServicesVisionParameters)) + { + writer.WritePropertyName("AIServicesVisionParameters"u8); + writer.WriteObjectValue(AIServicesVisionParameters, options); + } + } + + AIServicesVisionVectorizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AIServicesVisionVectorizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAIServicesVisionVectorizer(document.RootElement, options); + } + + internal static AIServicesVisionVectorizer DeserializeAIServicesVisionVectorizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + AIServicesVisionParameters aiServicesVisionParameters = default; + string name = default; + VectorSearchVectorizerKind kind = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("AIServicesVisionParameters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + aiServicesVisionParameters = AIServicesVisionParameters.DeserializeAIServicesVisionParameters(property.Value, options); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorSearchVectorizerKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AIServicesVisionVectorizer(name, kind, serializedAdditionalRawData, aiServicesVisionParameters); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AIServicesVisionVectorizer)} does not support writing '{options.Format}' format."); + } + } + + AIServicesVisionVectorizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAIServicesVisionVectorizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AIServicesVisionVectorizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new AIServicesVisionVectorizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAIServicesVisionVectorizer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesVisionVectorizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesVisionVectorizer.cs new file mode 100644 index 000000000000..2b7037cfe19e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AIServicesVisionVectorizer.cs @@ -0,0 +1,44 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Clears the identity property of a datasource. + public partial class AIServicesVisionVectorizer : VectorSearchVectorizer + { + /// Initializes a new instance of . + /// The name to associate with this particular vectorization method. + /// is null. + public AIServicesVisionVectorizer(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + Kind = VectorSearchVectorizerKind.AIServicesVision; + } + + /// Initializes a new instance of . + /// The name to associate with this particular vectorization method. + /// Type of VectorSearchVectorizer. + /// Keeps track of any properties unknown to the library. + /// Contains the parameters specific to AI Services Vision embedding vectorization. + internal AIServicesVisionVectorizer(string name, VectorSearchVectorizerKind kind, IDictionary serializedAdditionalRawData, AIServicesVisionParameters aiServicesVisionParameters) : base(name, kind, serializedAdditionalRawData) + { + AIServicesVisionParameters = aiServicesVisionParameters; + } + + /// Initializes a new instance of for deserialization. + internal AIServicesVisionVectorizer() + { + } + + /// Contains the parameters specific to AI Services Vision embedding vectorization. + public AIServicesVisionParameters AIServicesVisionParameters { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AMLParameters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AMLParameters.Serialization.cs new file mode 100644 index 000000000000..699e5cbbab03 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AMLParameters.Serialization.cs @@ -0,0 +1,212 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AMLParameters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AMLParameters)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("uri"u8); + writer.WriteStringValue(Uri.AbsoluteUri); + if (Optional.IsDefined(Key)) + { + writer.WritePropertyName("key"u8); + writer.WriteStringValue(Key); + } + if (Optional.IsDefined(ResourceId)) + { + writer.WritePropertyName("resourceId"u8); + writer.WriteStringValue(ResourceId); + } + if (Optional.IsDefined(Timeout)) + { + writer.WritePropertyName("timeout"u8); + writer.WriteStringValue(Timeout.Value, "P"); + } + if (Optional.IsDefined(Region)) + { + writer.WritePropertyName("region"u8); + writer.WriteStringValue(Region); + } + if (Optional.IsDefined(ModelName)) + { + writer.WritePropertyName("modelName"u8); + writer.WriteStringValue(ModelName.Value.ToString()); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + AMLParameters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AMLParameters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAMLParameters(document.RootElement, options); + } + + internal static AMLParameters DeserializeAMLParameters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + Uri uri = default; + string key = default; + string resourceId = default; + TimeSpan? timeout = default; + string region = default; + AIFoundryModelCatalogName? modelName = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("uri"u8)) + { + uri = new Uri(property.Value.GetString()); + continue; + } + if (property.NameEquals("key"u8)) + { + key = property.Value.GetString(); + continue; + } + if (property.NameEquals("resourceId"u8)) + { + resourceId = property.Value.GetString(); + continue; + } + if (property.NameEquals("timeout"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + timeout = property.Value.GetTimeSpan("P"); + continue; + } + if (property.NameEquals("region"u8)) + { + region = property.Value.GetString(); + continue; + } + if (property.NameEquals("modelName"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + modelName = new AIFoundryModelCatalogName(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AMLParameters( + uri, + key, + resourceId, + timeout, + region, + modelName, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AMLParameters)} does not support writing '{options.Format}' format."); + } + } + + AMLParameters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAMLParameters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AMLParameters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static AMLParameters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAMLParameters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AMLParameters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AMLParameters.cs new file mode 100644 index 000000000000..e07746d1312b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AMLParameters.cs @@ -0,0 +1,127 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Specifies the properties for connecting to an AML vectorizer. + public partial class AMLParameters + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// (Required for no authentication or key authentication) The scoring URI of the + /// AML service to which the JSON payload will be sent. Only the https URI scheme + /// is allowed. + /// + /// is null. + public AMLParameters(Uri uri) + { + Argument.AssertNotNull(uri, nameof(uri)); + + Uri = uri; + } + + /// Initializes a new instance of . + /// + /// (Required for no authentication or key authentication) The scoring URI of the + /// AML service to which the JSON payload will be sent. Only the https URI scheme + /// is allowed. + /// + /// (Required for key authentication) The key for the AML service. + /// + /// (Required for token authentication). The Azure Resource Manager resource ID of + /// the AML service. It should be in the format + /// subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}. + /// + /// + /// (Optional) When specified, indicates the timeout for the http client making the + /// API call. + /// + /// (Optional for token authentication). The region the AML service is deployed in. + /// + /// The name of the embedding model from the Azure AI Foundry Catalog that is + /// deployed at the provided endpoint. + /// + /// Keeps track of any properties unknown to the library. + internal AMLParameters(Uri uri, string key, string resourceId, TimeSpan? timeout, string region, AIFoundryModelCatalogName? modelName, IDictionary serializedAdditionalRawData) + { + Uri = uri; + Key = key; + ResourceId = resourceId; + Timeout = timeout; + Region = region; + ModelName = modelName; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal AMLParameters() + { + } + + /// + /// (Required for no authentication or key authentication) The scoring URI of the + /// AML service to which the JSON payload will be sent. Only the https URI scheme + /// is allowed. + /// + public Uri Uri { get; set; } + /// (Required for key authentication) The key for the AML service. + public string Key { get; set; } + /// + /// (Required for token authentication). The Azure Resource Manager resource ID of + /// the AML service. It should be in the format + /// subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}. + /// + public string ResourceId { get; set; } + /// + /// (Optional) When specified, indicates the timeout for the http client making the + /// API call. + /// + public TimeSpan? Timeout { get; set; } + /// (Optional for token authentication). The region the AML service is deployed in. + public string Region { get; set; } + /// + /// The name of the embedding model from the Azure AI Foundry Catalog that is + /// deployed at the provided endpoint. + /// + public AIFoundryModelCatalogName? ModelName { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AMLVectorizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AMLVectorizer.Serialization.cs new file mode 100644 index 000000000000..75ebdad4b893 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AMLVectorizer.Serialization.cs @@ -0,0 +1,147 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AMLVectorizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AMLVectorizer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(AmlParameters)) + { + writer.WritePropertyName("amlParameters"u8); + writer.WriteObjectValue(AmlParameters, options); + } + } + + AMLVectorizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AMLVectorizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAMLVectorizer(document.RootElement, options); + } + + internal static AMLVectorizer DeserializeAMLVectorizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + AMLParameters amlParameters = default; + string name = default; + VectorSearchVectorizerKind kind = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("amlParameters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + amlParameters = AMLParameters.DeserializeAMLParameters(property.Value, options); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorSearchVectorizerKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AMLVectorizer(name, kind, serializedAdditionalRawData, amlParameters); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AMLVectorizer)} does not support writing '{options.Format}' format."); + } + } + + AMLVectorizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAMLVectorizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AMLVectorizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new AMLVectorizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAMLVectorizer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AMLVectorizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AMLVectorizer.cs new file mode 100644 index 000000000000..30b9f6b4effb --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AMLVectorizer.cs @@ -0,0 +1,47 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Specifies an Azure Machine Learning endpoint deployed via the Azure AI Foundry + /// Model Catalog for generating the vector embedding of a query string. + /// + public partial class AMLVectorizer : VectorSearchVectorizer + { + /// Initializes a new instance of . + /// The name to associate with this particular vectorization method. + /// is null. + public AMLVectorizer(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + Kind = VectorSearchVectorizerKind.AML; + } + + /// Initializes a new instance of . + /// The name to associate with this particular vectorization method. + /// Type of VectorSearchVectorizer. + /// Keeps track of any properties unknown to the library. + /// Specifies the properties of the AML vectorizer. + internal AMLVectorizer(string name, VectorSearchVectorizerKind kind, IDictionary serializedAdditionalRawData, AMLParameters amlParameters) : base(name, kind, serializedAdditionalRawData) + { + AmlParameters = amlParameters; + } + + /// Initializes a new instance of for deserialization. + internal AMLVectorizer() + { + } + + /// Specifies the properties of the AML vectorizer. + public AMLParameters AmlParameters { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Aliases.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Aliases.cs new file mode 100644 index 000000000000..507eb6d2511c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Aliases.cs @@ -0,0 +1,656 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading; +using System.Threading.Tasks; +using Autorest.CSharp.Core; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Search.Documents.Indexes +{ + // Data plane generated sub-client. + /// The Aliases sub-client. + public partial class Aliases + { + private const string AuthorizationHeader = "api-key"; + private readonly AzureKeyCredential _keyCredential; + private static readonly string[] AuthorizationScopes = new string[] { "https://search.azure.com/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + private readonly string _apiVersion; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of Aliases for mocking. + protected Aliases() + { + } + + /// Initializes a new instance of Aliases. + /// The handler for diagnostic messaging in the client. + /// The HTTP pipeline for sending and receiving REST requests and responses. + /// The key credential to copy. + /// The token credential to copy. + /// Service host. + /// The API version to use for this operation. + internal Aliases(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, AzureKeyCredential keyCredential, TokenCredential tokenCredential, Uri endpoint, string apiVersion) + { + ClientDiagnostics = clientDiagnostics; + _pipeline = pipeline; + _keyCredential = keyCredential; + _tokenCredential = tokenCredential; + _endpoint = endpoint; + _apiVersion = apiVersion; + } + + /// Creates a new search alias. + /// The definition of the alias to create. + /// The cancellation token to use. + /// is null. + /// + public virtual async Task> CreateAsync(SearchAlias @alias, CancellationToken cancellationToken = default) + { + Argument.AssertNotNull(@alias, nameof(@alias)); + + using RequestContent content = @alias.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await CreateAsync(content, context).ConfigureAwait(false); + return Response.FromValue(SearchAlias.FromResponse(response), response); + } + + /// Creates a new search alias. + /// The definition of the alias to create. + /// The cancellation token to use. + /// is null. + /// + public virtual Response Create(SearchAlias @alias, CancellationToken cancellationToken = default) + { + Argument.AssertNotNull(@alias, nameof(@alias)); + + using RequestContent content = @alias.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = Create(content, context); + return Response.FromValue(SearchAlias.FromResponse(response), response); + } + + /// + /// [Protocol Method] Creates a new search alias. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task CreateAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Aliases.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Creates a new search alias. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Create(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Aliases.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates a new search alias or updates an alias if it already exists. + /// The name of the alias. + /// The definition of the alias to create or update. + /// The content to send as the request conditions of the request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> CreateOrUpdateAsync(string aliasName, SearchAlias @alias, MatchConditions matchConditions = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(aliasName, nameof(aliasName)); + Argument.AssertNotNull(@alias, nameof(@alias)); + + using RequestContent content = @alias.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await CreateOrUpdateAsync(aliasName, content, matchConditions, context).ConfigureAwait(false); + return Response.FromValue(SearchAlias.FromResponse(response), response); + } + + /// Creates a new search alias or updates an alias if it already exists. + /// The name of the alias. + /// The definition of the alias to create or update. + /// The content to send as the request conditions of the request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response CreateOrUpdate(string aliasName, SearchAlias @alias, MatchConditions matchConditions = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(aliasName, nameof(aliasName)); + Argument.AssertNotNull(@alias, nameof(@alias)); + + using RequestContent content = @alias.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = CreateOrUpdate(aliasName, content, matchConditions, context); + return Response.FromValue(SearchAlias.FromResponse(response), response); + } + + /// + /// [Protocol Method] Creates a new search alias or updates an alias if it already exists. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the alias. + /// The content to send as the body of the request. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task CreateOrUpdateAsync(string aliasName, RequestContent content, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(aliasName, nameof(aliasName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Aliases.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(aliasName, content, matchConditions, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Creates a new search alias or updates an alias if it already exists. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the alias. + /// The content to send as the body of the request. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response CreateOrUpdate(string aliasName, RequestContent content, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(aliasName, nameof(aliasName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Aliases.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(aliasName, content, matchConditions, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Deletes a search alias and its associated mapping to an index. This operation + /// is permanent, with no recovery option. The mapped index is untouched by this + /// operation. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the alias. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteAsync(string aliasName, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(aliasName, nameof(aliasName)); + + using var scope = ClientDiagnostics.CreateScope("Aliases.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(aliasName, matchConditions, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Deletes a search alias and its associated mapping to an index. This operation + /// is permanent, with no recovery option. The mapped index is untouched by this + /// operation. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the alias. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Delete(string aliasName, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(aliasName, nameof(aliasName)); + + using var scope = ClientDiagnostics.CreateScope("Aliases.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(aliasName, matchConditions, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Retrieves an alias definition. + /// The name of the alias. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> GetAliasAsync(string aliasName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(aliasName, nameof(aliasName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await GetAliasAsync(aliasName, context).ConfigureAwait(false); + return Response.FromValue(SearchAlias.FromResponse(response), response); + } + + /// Retrieves an alias definition. + /// The name of the alias. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response GetAlias(string aliasName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(aliasName, nameof(aliasName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = GetAlias(aliasName, context); + return Response.FromValue(SearchAlias.FromResponse(response), response); + } + + /// + /// [Protocol Method] Retrieves an alias definition. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the alias. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task GetAliasAsync(string aliasName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(aliasName, nameof(aliasName)); + + using var scope = ClientDiagnostics.CreateScope("Aliases.GetAlias"); + scope.Start(); + try + { + using HttpMessage message = CreateGetAliasRequest(aliasName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Retrieves an alias definition. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the alias. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response GetAlias(string aliasName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(aliasName, nameof(aliasName)); + + using var scope = ClientDiagnostics.CreateScope("Aliases.GetAlias"); + scope.Start(); + try + { + using HttpMessage message = CreateGetAliasRequest(aliasName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Lists all aliases available for a search service. + /// The cancellation token to use. + /// + public virtual AsyncPageable GetAliasesAsync(CancellationToken cancellationToken = default) + { + RequestContext context = cancellationToken.CanBeCanceled ? new RequestContext { CancellationToken = cancellationToken } : null; + HttpMessage FirstPageRequest(int? pageSizeHint) => CreateGetAliasesRequest(context); + return GeneratorPageableHelpers.CreateAsyncPageable(FirstPageRequest, null, e => SearchAlias.DeserializeSearchAlias(e), ClientDiagnostics, _pipeline, "Aliases.GetAliases", "value", null, context); + } + + /// Lists all aliases available for a search service. + /// The cancellation token to use. + /// + public virtual Pageable GetAliases(CancellationToken cancellationToken = default) + { + RequestContext context = cancellationToken.CanBeCanceled ? new RequestContext { CancellationToken = cancellationToken } : null; + HttpMessage FirstPageRequest(int? pageSizeHint) => CreateGetAliasesRequest(context); + return GeneratorPageableHelpers.CreatePageable(FirstPageRequest, null, e => SearchAlias.DeserializeSearchAlias(e), ClientDiagnostics, _pipeline, "Aliases.GetAliases", "value", null, context); + } + + /// + /// [Protocol Method] Lists all aliases available for a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetAliasesAsync(RequestContext context) + { + HttpMessage FirstPageRequest(int? pageSizeHint) => CreateGetAliasesRequest(context); + return GeneratorPageableHelpers.CreateAsyncPageable(FirstPageRequest, null, e => BinaryData.FromString(e.GetRawText()), ClientDiagnostics, _pipeline, "Aliases.GetAliases", "value", null, context); + } + + /// + /// [Protocol Method] Lists all aliases available for a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetAliases(RequestContext context) + { + HttpMessage FirstPageRequest(int? pageSizeHint) => CreateGetAliasesRequest(context); + return GeneratorPageableHelpers.CreatePageable(FirstPageRequest, null, e => BinaryData.FromString(e.GetRawText()), ClientDiagnostics, _pipeline, "Aliases.GetAliases", "value", null, context); + } + + internal HttpMessage CreateCreateRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier201); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/aliases", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetAliasesRequest(RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/aliases", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateOrUpdateRequest(string aliasName, RequestContent content, MatchConditions matchConditions, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200201); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/aliases('", false); + uri.AppendPath(aliasName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Prefer", "return=representation"); + request.Headers.Add("Accept", "application/json"); + if (matchConditions != null) + { + request.Headers.Add(matchConditions); + } + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteRequest(string aliasName, MatchConditions matchConditions, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204404); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/aliases('", false); + uri.AppendPath(aliasName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + if (matchConditions != null) + { + request.Headers.Add(matchConditions); + } + return message; + } + + internal HttpMessage CreateGetAliasRequest(string aliasName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/aliases('", false); + uri.AppendPath(aliasName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static RequestContext DefaultRequestContext = new RequestContext(); + internal static RequestContext FromCancellationToken(CancellationToken cancellationToken = default) + { + if (!cancellationToken.CanBeCanceled) + { + return DefaultRequestContext; + } + + return new RequestContext() { CancellationToken = cancellationToken }; + } + + private static ResponseClassifier _responseClassifier201; + private static ResponseClassifier ResponseClassifier201 => _responseClassifier201 ??= new StatusCodeClassifier(stackalloc ushort[] { 201 }); + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier200201; + private static ResponseClassifier ResponseClassifier200201 => _responseClassifier200201 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 201 }); + private static ResponseClassifier _responseClassifier204404; + private static ResponseClassifier ResponseClassifier204404 => _responseClassifier204404 ??= new StatusCodeClassifier(stackalloc ushort[] { 204, 404 }); + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzeRequest.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzeRequest.Serialization.cs new file mode 100644 index 000000000000..53e7ca28d72e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzeRequest.Serialization.cs @@ -0,0 +1,244 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AnalyzeRequest : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AnalyzeRequest)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("text"u8); + writer.WriteStringValue(Text); + if (Optional.IsDefined(Analyzer)) + { + writer.WritePropertyName("analyzer"u8); + writer.WriteStringValue(Analyzer.Value.ToString()); + } + if (Optional.IsDefined(Tokenizer)) + { + writer.WritePropertyName("tokenizer"u8); + writer.WriteStringValue(Tokenizer.Value.ToString()); + } + if (Optional.IsDefined(Normalizer)) + { + writer.WritePropertyName("normalizer"u8); + writer.WriteStringValue(Normalizer.Value.ToString()); + } + if (Optional.IsCollectionDefined(TokenFilters)) + { + writer.WritePropertyName("tokenFilters"u8); + writer.WriteStartArray(); + foreach (var item in TokenFilters) + { + writer.WriteStringValue(item.ToString()); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(CharFilters)) + { + writer.WritePropertyName("charFilters"u8); + writer.WriteStartArray(); + foreach (var item in CharFilters) + { + writer.WriteStringValue(item.ToString()); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + AnalyzeRequest IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AnalyzeRequest)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAnalyzeRequest(document.RootElement, options); + } + + internal static AnalyzeRequest DeserializeAnalyzeRequest(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string text = default; + LexicalAnalyzerName? analyzer = default; + LexicalTokenizerName? tokenizer = default; + LexicalNormalizerName? normalizer = default; + IList tokenFilters = default; + IList charFilters = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("text"u8)) + { + text = property.Value.GetString(); + continue; + } + if (property.NameEquals("analyzer"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + analyzer = new LexicalAnalyzerName(property.Value.GetString()); + continue; + } + if (property.NameEquals("tokenizer"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + tokenizer = new LexicalTokenizerName(property.Value.GetString()); + continue; + } + if (property.NameEquals("normalizer"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + normalizer = new LexicalNormalizerName(property.Value.GetString()); + continue; + } + if (property.NameEquals("tokenFilters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(new TokenFilterName(item.GetString())); + } + tokenFilters = array; + continue; + } + if (property.NameEquals("charFilters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(new CharFilterName(item.GetString())); + } + charFilters = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AnalyzeRequest( + text, + analyzer, + tokenizer, + normalizer, + tokenFilters ?? new ChangeTrackingList(), + charFilters ?? new ChangeTrackingList(), + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AnalyzeRequest)} does not support writing '{options.Format}' format."); + } + } + + AnalyzeRequest IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAnalyzeRequest(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AnalyzeRequest)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static AnalyzeRequest FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAnalyzeRequest(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzeRequest.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzeRequest.cs new file mode 100644 index 000000000000..2d38383406a9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzeRequest.cs @@ -0,0 +1,125 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Specifies some text and analysis components used to break that text into tokens. + public partial class AnalyzeRequest + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The text to break into tokens. + /// is null. + public AnalyzeRequest(string text) + { + Argument.AssertNotNull(text, nameof(text)); + + Text = text; + TokenFilters = new ChangeTrackingList(); + CharFilters = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The text to break into tokens. + /// + /// The name of the analyzer to use to break the given text. If this parameter is + /// not specified, you must specify a tokenizer instead. The tokenizer and analyzer + /// parameters are mutually exclusive. + /// + /// + /// The name of the tokenizer to use to break the given text. If this parameter is + /// not specified, you must specify an analyzer instead. The tokenizer and analyzer + /// parameters are mutually exclusive. + /// + /// The name of the normalizer to use to normalize the given text. + /// + /// An optional list of token filters to use when breaking the given text. This + /// parameter can only be set when using the tokenizer parameter. + /// + /// + /// An optional list of character filters to use when breaking the given text. This + /// parameter can only be set when using the tokenizer parameter. + /// + /// Keeps track of any properties unknown to the library. + internal AnalyzeRequest(string text, LexicalAnalyzerName? analyzer, LexicalTokenizerName? tokenizer, LexicalNormalizerName? normalizer, IList tokenFilters, IList charFilters, IDictionary serializedAdditionalRawData) + { + Text = text; + Analyzer = analyzer; + Tokenizer = tokenizer; + Normalizer = normalizer; + TokenFilters = tokenFilters; + CharFilters = charFilters; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal AnalyzeRequest() + { + } + + /// The text to break into tokens. + public string Text { get; } + /// + /// The name of the analyzer to use to break the given text. If this parameter is + /// not specified, you must specify a tokenizer instead. The tokenizer and analyzer + /// parameters are mutually exclusive. + /// + public LexicalAnalyzerName? Analyzer { get; set; } + /// + /// The name of the tokenizer to use to break the given text. If this parameter is + /// not specified, you must specify an analyzer instead. The tokenizer and analyzer + /// parameters are mutually exclusive. + /// + public LexicalTokenizerName? Tokenizer { get; set; } + /// The name of the normalizer to use to normalize the given text. + public LexicalNormalizerName? Normalizer { get; set; } + /// + /// An optional list of token filters to use when breaking the given text. This + /// parameter can only be set when using the tokenizer parameter. + /// + public IList TokenFilters { get; } + /// + /// An optional list of character filters to use when breaking the given text. This + /// parameter can only be set when using the tokenizer parameter. + /// + public IList CharFilters { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzeResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzeResult.Serialization.cs new file mode 100644 index 000000000000..1fa42f39c00c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzeResult.Serialization.cs @@ -0,0 +1,152 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AnalyzeResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AnalyzeResult)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("tokens"u8); + writer.WriteStartArray(); + foreach (var item in Tokens) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + AnalyzeResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AnalyzeResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAnalyzeResult(document.RootElement, options); + } + + internal static AnalyzeResult DeserializeAnalyzeResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IReadOnlyList tokens = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("tokens"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(AnalyzedTokenInfo.DeserializeAnalyzedTokenInfo(item, options)); + } + tokens = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AnalyzeResult(tokens, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AnalyzeResult)} does not support writing '{options.Format}' format."); + } + } + + AnalyzeResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAnalyzeResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AnalyzeResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static AnalyzeResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAnalyzeResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzeResult.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzeResult.cs new file mode 100644 index 000000000000..0239a8f2ec5a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzeResult.cs @@ -0,0 +1,76 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// The result of testing an analyzer on text. + public partial class AnalyzeResult + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The list of tokens returned by the analyzer specified in the request. + /// is null. + internal AnalyzeResult(IEnumerable tokens) + { + Argument.AssertNotNull(tokens, nameof(tokens)); + + Tokens = tokens.ToList(); + } + + /// Initializes a new instance of . + /// The list of tokens returned by the analyzer specified in the request. + /// Keeps track of any properties unknown to the library. + internal AnalyzeResult(IReadOnlyList tokens, IDictionary serializedAdditionalRawData) + { + Tokens = tokens; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal AnalyzeResult() + { + } + + /// The list of tokens returned by the analyzer specified in the request. + public IReadOnlyList Tokens { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzedTokenInfo.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzedTokenInfo.Serialization.cs new file mode 100644 index 000000000000..e270286b89b9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzedTokenInfo.Serialization.cs @@ -0,0 +1,166 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AnalyzedTokenInfo : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AnalyzedTokenInfo)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("token"u8); + writer.WriteStringValue(Token); + writer.WritePropertyName("startOffset"u8); + writer.WriteNumberValue(StartOffset); + writer.WritePropertyName("endOffset"u8); + writer.WriteNumberValue(EndOffset); + writer.WritePropertyName("position"u8); + writer.WriteNumberValue(Position); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + AnalyzedTokenInfo IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AnalyzedTokenInfo)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAnalyzedTokenInfo(document.RootElement, options); + } + + internal static AnalyzedTokenInfo DeserializeAnalyzedTokenInfo(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string token = default; + int startOffset = default; + int endOffset = default; + int position = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("token"u8)) + { + token = property.Value.GetString(); + continue; + } + if (property.NameEquals("startOffset"u8)) + { + startOffset = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("endOffset"u8)) + { + endOffset = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("position"u8)) + { + position = property.Value.GetInt32(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AnalyzedTokenInfo(token, startOffset, endOffset, position, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AnalyzedTokenInfo)} does not support writing '{options.Format}' format."); + } + } + + AnalyzedTokenInfo IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAnalyzedTokenInfo(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AnalyzedTokenInfo)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static AnalyzedTokenInfo FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAnalyzedTokenInfo(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzedTokenInfo.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzedTokenInfo.cs new file mode 100644 index 000000000000..e981a23717e7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AnalyzedTokenInfo.cs @@ -0,0 +1,108 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Information about a token returned by an analyzer. + public partial class AnalyzedTokenInfo + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The token returned by the analyzer. + /// The index of the first character of the token in the input text. + /// The index of the last character of the token in the input text. + /// + /// The position of the token in the input text relative to other tokens. The first + /// token in the input text has position 0, the next has position 1, and so on. + /// Depending on the analyzer used, some tokens might have the same position, for + /// example if they are synonyms of each other. + /// + /// is null. + internal AnalyzedTokenInfo(string token, int startOffset, int endOffset, int position) + { + Argument.AssertNotNull(token, nameof(token)); + + Token = token; + StartOffset = startOffset; + EndOffset = endOffset; + Position = position; + } + + /// Initializes a new instance of . + /// The token returned by the analyzer. + /// The index of the first character of the token in the input text. + /// The index of the last character of the token in the input text. + /// + /// The position of the token in the input text relative to other tokens. The first + /// token in the input text has position 0, the next has position 1, and so on. + /// Depending on the analyzer used, some tokens might have the same position, for + /// example if they are synonyms of each other. + /// + /// Keeps track of any properties unknown to the library. + internal AnalyzedTokenInfo(string token, int startOffset, int endOffset, int position, IDictionary serializedAdditionalRawData) + { + Token = token; + StartOffset = startOffset; + EndOffset = endOffset; + Position = position; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal AnalyzedTokenInfo() + { + } + + /// The token returned by the analyzer. + public string Token { get; } + /// The index of the first character of the token in the input text. + public int StartOffset { get; } + /// The index of the last character of the token in the input text. + public int EndOffset { get; } + /// + /// The position of the token in the input text relative to other tokens. The first + /// token in the input text has position 0, the next has position 1, and so on. + /// Depending on the analyzer used, some tokens might have the same position, for + /// example if they are synonyms of each other. + /// + public int Position { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AsciiFoldingTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AsciiFoldingTokenFilter.Serialization.cs new file mode 100644 index 000000000000..65ede07fe0bb --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AsciiFoldingTokenFilter.Serialization.cs @@ -0,0 +1,147 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AsciiFoldingTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AsciiFoldingTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(PreserveOriginal)) + { + writer.WritePropertyName("preserveOriginal"u8); + writer.WriteBooleanValue(PreserveOriginal.Value); + } + } + + AsciiFoldingTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AsciiFoldingTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAsciiFoldingTokenFilter(document.RootElement, options); + } + + internal static AsciiFoldingTokenFilter DeserializeAsciiFoldingTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + bool? preserveOriginal = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("preserveOriginal"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + preserveOriginal = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AsciiFoldingTokenFilter(odataType, name, serializedAdditionalRawData, preserveOriginal); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AsciiFoldingTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + AsciiFoldingTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAsciiFoldingTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AsciiFoldingTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new AsciiFoldingTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAsciiFoldingTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AsciiFoldingTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AsciiFoldingTokenFilter.cs new file mode 100644 index 000000000000..726d5ca14f38 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AsciiFoldingTokenFilter.cs @@ -0,0 +1,57 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Converts alphabetic, numeric, and symbolic Unicode characters which are not in + /// the first 127 ASCII characters (the "Basic Latin" Unicode block) into their + /// ASCII equivalents, if such equivalents exist. This token filter is implemented + /// using Apache Lucene. + /// + public partial class AsciiFoldingTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public AsciiFoldingTokenFilter(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.AsciiFoldingTokenFilter"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// A value indicating whether the original token will be kept. Default is false. + internal AsciiFoldingTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, bool? preserveOriginal) : base(odataType, name, serializedAdditionalRawData) + { + PreserveOriginal = preserveOriginal; + } + + /// Initializes a new instance of for deserialization. + internal AsciiFoldingTokenFilter() + { + } + + /// A value indicating whether the original token will be kept. Default is false. + public bool? PreserveOriginal { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureActiveDirectoryApplicationCredentials.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureActiveDirectoryApplicationCredentials.Serialization.cs new file mode 100644 index 000000000000..452a76720415 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureActiveDirectoryApplicationCredentials.Serialization.cs @@ -0,0 +1,153 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AzureActiveDirectoryApplicationCredentials : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AzureActiveDirectoryApplicationCredentials)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("applicationId"u8); + writer.WriteStringValue(ApplicationId); + if (Optional.IsDefined(ApplicationSecret)) + { + writer.WritePropertyName("applicationSecret"u8); + writer.WriteStringValue(ApplicationSecret); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + AzureActiveDirectoryApplicationCredentials IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AzureActiveDirectoryApplicationCredentials)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAzureActiveDirectoryApplicationCredentials(document.RootElement, options); + } + + internal static AzureActiveDirectoryApplicationCredentials DeserializeAzureActiveDirectoryApplicationCredentials(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string applicationId = default; + string applicationSecret = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("applicationId"u8)) + { + applicationId = property.Value.GetString(); + continue; + } + if (property.NameEquals("applicationSecret"u8)) + { + applicationSecret = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AzureActiveDirectoryApplicationCredentials(applicationId, applicationSecret, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AzureActiveDirectoryApplicationCredentials)} does not support writing '{options.Format}' format."); + } + } + + AzureActiveDirectoryApplicationCredentials IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAzureActiveDirectoryApplicationCredentials(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AzureActiveDirectoryApplicationCredentials)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static AzureActiveDirectoryApplicationCredentials FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAzureActiveDirectoryApplicationCredentials(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureActiveDirectoryApplicationCredentials.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureActiveDirectoryApplicationCredentials.cs new file mode 100644 index 000000000000..74efc6941b70 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureActiveDirectoryApplicationCredentials.cs @@ -0,0 +1,97 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Credentials of a registered application created for your search service, used + /// for authenticated access to the encryption keys stored in Azure Key Vault. + /// + public partial class AzureActiveDirectoryApplicationCredentials + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// An AAD Application ID that was granted the required access permissions to the + /// Azure Key Vault that is to be used when encrypting your data at rest. The + /// Application ID should not be confused with the Object ID for your AAD + /// Application. + /// + /// is null. + public AzureActiveDirectoryApplicationCredentials(string applicationId) + { + Argument.AssertNotNull(applicationId, nameof(applicationId)); + + ApplicationId = applicationId; + } + + /// Initializes a new instance of . + /// + /// An AAD Application ID that was granted the required access permissions to the + /// Azure Key Vault that is to be used when encrypting your data at rest. The + /// Application ID should not be confused with the Object ID for your AAD + /// Application. + /// + /// The authentication key of the specified AAD application. + /// Keeps track of any properties unknown to the library. + internal AzureActiveDirectoryApplicationCredentials(string applicationId, string applicationSecret, IDictionary serializedAdditionalRawData) + { + ApplicationId = applicationId; + ApplicationSecret = applicationSecret; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal AzureActiveDirectoryApplicationCredentials() + { + } + + /// + /// An AAD Application ID that was granted the required access permissions to the + /// Azure Key Vault that is to be used when encrypting your data at rest. The + /// Application ID should not be confused with the Object ID for your AAD + /// Application. + /// + public string ApplicationId { get; set; } + /// The authentication key of the specified AAD application. + public string ApplicationSecret { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureMachineLearningSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureMachineLearningSkill.Serialization.cs new file mode 100644 index 000000000000..6788bf3c3eef --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureMachineLearningSkill.Serialization.cs @@ -0,0 +1,257 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AzureMachineLearningSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AzureMachineLearningSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(Uri)) + { + writer.WritePropertyName("uri"u8); + writer.WriteStringValue(Uri.AbsoluteUri); + } + if (Optional.IsDefined(Key)) + { + writer.WritePropertyName("key"u8); + writer.WriteStringValue(Key); + } + if (Optional.IsDefined(ResourceId)) + { + writer.WritePropertyName("resourceId"u8); + writer.WriteStringValue(ResourceId); + } + if (Optional.IsDefined(Timeout)) + { + writer.WritePropertyName("timeout"u8); + writer.WriteStringValue(Timeout.Value, "P"); + } + if (Optional.IsDefined(Region)) + { + writer.WritePropertyName("region"u8); + writer.WriteStringValue(Region); + } + if (Optional.IsDefined(DegreeOfParallelism)) + { + writer.WritePropertyName("degreeOfParallelism"u8); + writer.WriteNumberValue(DegreeOfParallelism.Value); + } + } + + AzureMachineLearningSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AzureMachineLearningSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAzureMachineLearningSkill(document.RootElement, options); + } + + internal static AzureMachineLearningSkill DeserializeAzureMachineLearningSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + Uri uri = default; + string key = default; + string resourceId = default; + TimeSpan? timeout = default; + string region = default; + int? degreeOfParallelism = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("uri"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + uri = new Uri(property.Value.GetString()); + continue; + } + if (property.NameEquals("key"u8)) + { + key = property.Value.GetString(); + continue; + } + if (property.NameEquals("resourceId"u8)) + { + resourceId = property.Value.GetString(); + continue; + } + if (property.NameEquals("timeout"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + timeout = property.Value.GetTimeSpan("P"); + continue; + } + if (property.NameEquals("region"u8)) + { + region = property.Value.GetString(); + continue; + } + if (property.NameEquals("degreeOfParallelism"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + degreeOfParallelism = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AzureMachineLearningSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + uri, + key, + resourceId, + timeout, + region, + degreeOfParallelism); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AzureMachineLearningSkill)} does not support writing '{options.Format}' format."); + } + } + + AzureMachineLearningSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAzureMachineLearningSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AzureMachineLearningSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new AzureMachineLearningSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAzureMachineLearningSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureMachineLearningSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureMachineLearningSkill.cs new file mode 100644 index 000000000000..95660ca2833f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureMachineLearningSkill.cs @@ -0,0 +1,133 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// The AML skill allows you to extend AI enrichment with a custom Azure Machine + /// Learning (AML) model. Once an AML model is trained and deployed, an AML skill + /// integrates it into AI enrichment. + /// + public partial class AzureMachineLearningSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public AzureMachineLearningSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Custom.AmlSkill"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// (Required for no authentication or key authentication) The scoring URI of the + /// AML service to which the JSON payload will be sent. Only the https URI scheme + /// is allowed. + /// + /// (Required for key authentication) The key for the AML service. + /// + /// (Required for token authentication). The Azure Resource Manager resource ID of + /// the AML service. It should be in the format + /// subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}. + /// + /// + /// (Optional) When specified, indicates the timeout for the http client making the + /// API call. + /// + /// (Optional for token authentication). The region the AML service is deployed in. + /// + /// (Optional) When specified, indicates the number of calls the indexer will make + /// in parallel to the endpoint you have provided. You can decrease this value if + /// your endpoint is failing under too high of a request load, or raise it if your + /// endpoint is able to accept more requests and you would like an increase in the + /// performance of the indexer. If not set, a default value of 5 is used. The + /// degreeOfParallelism can be set to a maximum of 10 and a minimum of 1. + /// + internal AzureMachineLearningSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData, Uri uri, string key, string resourceId, TimeSpan? timeout, string region, int? degreeOfParallelism) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + Uri = uri; + Key = key; + ResourceId = resourceId; + Timeout = timeout; + Region = region; + DegreeOfParallelism = degreeOfParallelism; + } + + /// Initializes a new instance of for deserialization. + internal AzureMachineLearningSkill() + { + } + + /// + /// (Required for no authentication or key authentication) The scoring URI of the + /// AML service to which the JSON payload will be sent. Only the https URI scheme + /// is allowed. + /// + public Uri Uri { get; set; } + /// (Required for key authentication) The key for the AML service. + public string Key { get; set; } + /// + /// (Required for token authentication). The Azure Resource Manager resource ID of + /// the AML service. It should be in the format + /// subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}. + /// + public string ResourceId { get; set; } + /// + /// (Optional) When specified, indicates the timeout for the http client making the + /// API call. + /// + public TimeSpan? Timeout { get; set; } + /// (Optional for token authentication). The region the AML service is deployed in. + public string Region { get; set; } + /// + /// (Optional) When specified, indicates the number of calls the indexer will make + /// in parallel to the endpoint you have provided. You can decrease this value if + /// your endpoint is failing under too high of a request load, or raise it if your + /// endpoint is able to accept more requests and you would like an increase in the + /// performance of the indexer. If not set, a default value of 5 is used. The + /// degreeOfParallelism can be set to a maximum of 10 and a minimum of 1. + /// + public int? DegreeOfParallelism { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIEmbeddingSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIEmbeddingSkill.Serialization.cs new file mode 100644 index 000000000000..539ee9fc7518 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIEmbeddingSkill.Serialization.cs @@ -0,0 +1,261 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AzureOpenAIEmbeddingSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AzureOpenAIEmbeddingSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(ResourceUri)) + { + writer.WritePropertyName("resourceUri"u8); + writer.WriteStringValue(ResourceUri.AbsoluteUri); + } + if (Optional.IsDefined(DeploymentId)) + { + writer.WritePropertyName("deploymentId"u8); + writer.WriteStringValue(DeploymentId); + } + if (Optional.IsDefined(ApiKey)) + { + writer.WritePropertyName("apiKey"u8); + writer.WriteStringValue(ApiKey); + } + if (Optional.IsDefined(AuthIdentity)) + { + writer.WritePropertyName("authIdentity"u8); + writer.WriteObjectValue(AuthIdentity, options); + } + if (Optional.IsDefined(ModelName)) + { + writer.WritePropertyName("modelName"u8); + writer.WriteStringValue(ModelName.Value.ToString()); + } + if (Optional.IsDefined(Dimensions)) + { + writer.WritePropertyName("dimensions"u8); + writer.WriteNumberValue(Dimensions.Value); + } + } + + AzureOpenAIEmbeddingSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AzureOpenAIEmbeddingSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAzureOpenAIEmbeddingSkill(document.RootElement, options); + } + + internal static AzureOpenAIEmbeddingSkill DeserializeAzureOpenAIEmbeddingSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + Uri resourceUri = default; + string deploymentId = default; + string apiKey = default; + SearchIndexerDataIdentity authIdentity = default; + AzureOpenAIModelName? modelName = default; + int? dimensions = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("resourceUri"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + resourceUri = new Uri(property.Value.GetString()); + continue; + } + if (property.NameEquals("deploymentId"u8)) + { + deploymentId = property.Value.GetString(); + continue; + } + if (property.NameEquals("apiKey"u8)) + { + apiKey = property.Value.GetString(); + continue; + } + if (property.NameEquals("authIdentity"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + authIdentity = SearchIndexerDataIdentity.DeserializeSearchIndexerDataIdentity(property.Value, options); + continue; + } + if (property.NameEquals("modelName"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + modelName = new AzureOpenAIModelName(property.Value.GetString()); + continue; + } + if (property.NameEquals("dimensions"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + dimensions = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AzureOpenAIEmbeddingSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + resourceUri, + deploymentId, + apiKey, + authIdentity, + modelName, + dimensions); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AzureOpenAIEmbeddingSkill)} does not support writing '{options.Format}' format."); + } + } + + AzureOpenAIEmbeddingSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAzureOpenAIEmbeddingSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AzureOpenAIEmbeddingSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new AzureOpenAIEmbeddingSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAzureOpenAIEmbeddingSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIEmbeddingSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIEmbeddingSkill.cs new file mode 100644 index 000000000000..070bba6d7378 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIEmbeddingSkill.cs @@ -0,0 +1,116 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// 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 . + /// + /// 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. + /// + /// or is null. + public AzureOpenAIEmbeddingSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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. + /// The available derived classes include and . + /// + /// + /// The name of the embedding model that is deployed at the provided deploymentId + /// path. + /// + /// + /// The number of dimensions the resulting output embeddings should have. Only + /// supported in text-embedding-3 and later models. + /// + internal AzureOpenAIEmbeddingSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData, Uri resourceUri, string deploymentId, string apiKey, SearchIndexerDataIdentity authIdentity, AzureOpenAIModelName? modelName, int? dimensions) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + ResourceUri = resourceUri; + DeploymentId = deploymentId; + ApiKey = apiKey; + AuthIdentity = authIdentity; + ModelName = modelName; + Dimensions = dimensions; + } + + /// Initializes a new instance of for deserialization. + internal AzureOpenAIEmbeddingSkill() + { + } + + /// The resource URI of the Azure OpenAI resource. + public Uri ResourceUri { get; set; } + /// ID of the Azure OpenAI model deployment on the designated resource. + public string DeploymentId { get; set; } + /// API key of the designated Azure OpenAI resource. + public string ApiKey { get; set; } + /// + /// 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. + /// The available derived classes include and . + /// + public SearchIndexerDataIdentity AuthIdentity { get; set; } + /// + /// The name of the embedding model that is deployed at the provided deploymentId + /// path. + /// + public AzureOpenAIModelName? ModelName { get; set; } + /// + /// The number of dimensions the resulting output embeddings should have. Only + /// supported in text-embedding-3 and later models. + /// + public int? Dimensions { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIModelName.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIModelName.cs new file mode 100644 index 000000000000..cd595cd31c52 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIModelName.cs @@ -0,0 +1,54 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The Azure Open AI model name that will be called. + public readonly partial struct AzureOpenAIModelName : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public AzureOpenAIModelName(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string TextEmbeddingAda002Value = "text-embedding-ada-002"; + private const string TextEmbedding3LargeValue = "text-embedding-3-large"; + private const string TextEmbedding3SmallValue = "text-embedding-3-small"; + + /// TextEmbeddingAda002 model. + public static AzureOpenAIModelName TextEmbeddingAda002 { get; } = new AzureOpenAIModelName(TextEmbeddingAda002Value); + /// TextEmbedding3Large model. + public static AzureOpenAIModelName TextEmbedding3Large { get; } = new AzureOpenAIModelName(TextEmbedding3LargeValue); + /// TextEmbedding3Small model. + public static AzureOpenAIModelName TextEmbedding3Small { get; } = new AzureOpenAIModelName(TextEmbedding3SmallValue); + /// Determines if two values are the same. + public static bool operator ==(AzureOpenAIModelName left, AzureOpenAIModelName right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(AzureOpenAIModelName left, AzureOpenAIModelName right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator AzureOpenAIModelName(string value) => new AzureOpenAIModelName(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is AzureOpenAIModelName other && Equals(other); + /// + public bool Equals(AzureOpenAIModelName other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAITokenizerParameters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAITokenizerParameters.Serialization.cs new file mode 100644 index 000000000000..588e1b35c748 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAITokenizerParameters.Serialization.cs @@ -0,0 +1,174 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AzureOpenAITokenizerParameters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AzureOpenAITokenizerParameters)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(EncoderModelName)) + { + writer.WritePropertyName("encoderModelName"u8); + writer.WriteStringValue(EncoderModelName.Value.ToString()); + } + if (Optional.IsCollectionDefined(AllowedSpecialTokens)) + { + writer.WritePropertyName("allowedSpecialTokens"u8); + writer.WriteStartArray(); + foreach (var item in AllowedSpecialTokens) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + AzureOpenAITokenizerParameters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AzureOpenAITokenizerParameters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAzureOpenAITokenizerParameters(document.RootElement, options); + } + + internal static AzureOpenAITokenizerParameters DeserializeAzureOpenAITokenizerParameters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + SplitSkillEncoderModelName? encoderModelName = default; + IList allowedSpecialTokens = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("encoderModelName"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + encoderModelName = new SplitSkillEncoderModelName(property.Value.GetString()); + continue; + } + if (property.NameEquals("allowedSpecialTokens"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + allowedSpecialTokens = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AzureOpenAITokenizerParameters(encoderModelName, allowedSpecialTokens ?? new ChangeTrackingList(), serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AzureOpenAITokenizerParameters)} does not support writing '{options.Format}' format."); + } + } + + AzureOpenAITokenizerParameters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAzureOpenAITokenizerParameters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AzureOpenAITokenizerParameters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static AzureOpenAITokenizerParameters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAzureOpenAITokenizerParameters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAITokenizerParameters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAITokenizerParameters.cs new file mode 100644 index 000000000000..c03e0ef21e82 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAITokenizerParameters.cs @@ -0,0 +1,84 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Azure OpenAI Tokenizer parameters. + public partial class AzureOpenAITokenizerParameters + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public AzureOpenAITokenizerParameters() + { + AllowedSpecialTokens = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// + /// Only applies if the unit is set to azureOpenAITokens. Options include + /// 'R50k_base', 'P50k_base', 'P50k_edit' and 'CL100k_base'. The default value is 'CL100k_base'. + /// + /// + /// (Optional) Only applies if the unit is set to azureOpenAITokens. This parameter + /// defines a collection of special tokens that are permitted within the + /// tokenization process. + /// + /// Keeps track of any properties unknown to the library. + internal AzureOpenAITokenizerParameters(SplitSkillEncoderModelName? encoderModelName, IList allowedSpecialTokens, IDictionary serializedAdditionalRawData) + { + EncoderModelName = encoderModelName; + AllowedSpecialTokens = allowedSpecialTokens; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// + /// Only applies if the unit is set to azureOpenAITokens. Options include + /// 'R50k_base', 'P50k_base', 'P50k_edit' and 'CL100k_base'. The default value is 'CL100k_base'. + /// + public SplitSkillEncoderModelName? EncoderModelName { get; set; } + /// + /// (Optional) Only applies if the unit is set to azureOpenAITokens. This parameter + /// defines a collection of special tokens that are permitted within the + /// tokenization process. + /// + public IList AllowedSpecialTokens { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIVectorizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIVectorizer.Serialization.cs new file mode 100644 index 000000000000..c92b8909214d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIVectorizer.Serialization.cs @@ -0,0 +1,147 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AzureOpenAIVectorizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AzureOpenAIVectorizer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(AzureOpenAIParameters)) + { + writer.WritePropertyName("azureOpenAIParameters"u8); + writer.WriteObjectValue(AzureOpenAIParameters, options); + } + } + + AzureOpenAIVectorizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AzureOpenAIVectorizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAzureOpenAIVectorizer(document.RootElement, options); + } + + internal static AzureOpenAIVectorizer DeserializeAzureOpenAIVectorizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + AzureOpenAIVectorizerParameters azureOpenAIParameters = default; + string name = default; + VectorSearchVectorizerKind kind = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("azureOpenAIParameters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + azureOpenAIParameters = AzureOpenAIVectorizerParameters.DeserializeAzureOpenAIVectorizerParameters(property.Value, options); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorSearchVectorizerKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AzureOpenAIVectorizer(name, kind, serializedAdditionalRawData, azureOpenAIParameters); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AzureOpenAIVectorizer)} does not support writing '{options.Format}' format."); + } + } + + AzureOpenAIVectorizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAzureOpenAIVectorizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AzureOpenAIVectorizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new AzureOpenAIVectorizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAzureOpenAIVectorizer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIVectorizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIVectorizer.cs new file mode 100644 index 000000000000..a6b3996b73a0 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIVectorizer.cs @@ -0,0 +1,44 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Specifies the Azure OpenAI resource used to vectorize a query string. + public partial class AzureOpenAIVectorizer : VectorSearchVectorizer + { + /// Initializes a new instance of . + /// The name to associate with this particular vectorization method. + /// is null. + public AzureOpenAIVectorizer(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + Kind = VectorSearchVectorizerKind.AzureOpenAI; + } + + /// Initializes a new instance of . + /// The name to associate with this particular vectorization method. + /// Type of VectorSearchVectorizer. + /// Keeps track of any properties unknown to the library. + /// Contains the parameters specific to Azure OpenAI embedding vectorization. + internal AzureOpenAIVectorizer(string name, VectorSearchVectorizerKind kind, IDictionary serializedAdditionalRawData, AzureOpenAIVectorizerParameters azureOpenAIParameters) : base(name, kind, serializedAdditionalRawData) + { + AzureOpenAIParameters = azureOpenAIParameters; + } + + /// Initializes a new instance of for deserialization. + internal AzureOpenAIVectorizer() + { + } + + /// Contains the parameters specific to Azure OpenAI embedding vectorization. + public AzureOpenAIVectorizerParameters AzureOpenAIParameters { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIVectorizerParameters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIVectorizerParameters.Serialization.cs new file mode 100644 index 000000000000..585afc04a0bb --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIVectorizerParameters.Serialization.cs @@ -0,0 +1,207 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class AzureOpenAIVectorizerParameters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AzureOpenAIVectorizerParameters)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(ResourceUri)) + { + writer.WritePropertyName("resourceUri"u8); + writer.WriteStringValue(ResourceUri.AbsoluteUri); + } + if (Optional.IsDefined(DeploymentId)) + { + writer.WritePropertyName("deploymentId"u8); + writer.WriteStringValue(DeploymentId); + } + if (Optional.IsDefined(ApiKey)) + { + writer.WritePropertyName("apiKey"u8); + writer.WriteStringValue(ApiKey); + } + if (Optional.IsDefined(AuthIdentity)) + { + writer.WritePropertyName("authIdentity"u8); + writer.WriteObjectValue(AuthIdentity, options); + } + if (Optional.IsDefined(ModelName)) + { + writer.WritePropertyName("modelName"u8); + writer.WriteStringValue(ModelName.Value.ToString()); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + AzureOpenAIVectorizerParameters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AzureOpenAIVectorizerParameters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAzureOpenAIVectorizerParameters(document.RootElement, options); + } + + internal static AzureOpenAIVectorizerParameters DeserializeAzureOpenAIVectorizerParameters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + Uri resourceUri = default; + string deploymentId = default; + string apiKey = default; + SearchIndexerDataIdentity authIdentity = default; + AzureOpenAIModelName? modelName = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("resourceUri"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + resourceUri = new Uri(property.Value.GetString()); + continue; + } + if (property.NameEquals("deploymentId"u8)) + { + deploymentId = property.Value.GetString(); + continue; + } + if (property.NameEquals("apiKey"u8)) + { + apiKey = property.Value.GetString(); + continue; + } + if (property.NameEquals("authIdentity"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + authIdentity = SearchIndexerDataIdentity.DeserializeSearchIndexerDataIdentity(property.Value, options); + continue; + } + if (property.NameEquals("modelName"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + modelName = new AzureOpenAIModelName(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AzureOpenAIVectorizerParameters( + resourceUri, + deploymentId, + apiKey, + authIdentity, + modelName, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AzureOpenAIVectorizerParameters)} does not support writing '{options.Format}' format."); + } + } + + AzureOpenAIVectorizerParameters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAzureOpenAIVectorizerParameters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AzureOpenAIVectorizerParameters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static AzureOpenAIVectorizerParameters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAzureOpenAIVectorizerParameters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIVectorizerParameters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIVectorizerParameters.cs new file mode 100644 index 000000000000..c6d660b564ed --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/AzureOpenAIVectorizerParameters.cs @@ -0,0 +1,95 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Specifies the parameters for connecting to the Azure OpenAI resource. + public partial class AzureOpenAIVectorizerParameters + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public AzureOpenAIVectorizerParameters() + { + } + + /// Initializes a new instance of . + /// 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. + /// The available derived classes include and . + /// + /// + /// The name of the embedding model that is deployed at the provided deploymentId + /// path. + /// + /// Keeps track of any properties unknown to the library. + internal AzureOpenAIVectorizerParameters(Uri resourceUri, string deploymentId, string apiKey, SearchIndexerDataIdentity authIdentity, AzureOpenAIModelName? modelName, IDictionary serializedAdditionalRawData) + { + ResourceUri = resourceUri; + DeploymentId = deploymentId; + ApiKey = apiKey; + AuthIdentity = authIdentity; + ModelName = modelName; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The resource URI of the Azure OpenAI resource. + public Uri ResourceUri { get; set; } + /// ID of the Azure OpenAI model deployment on the designated resource. + public string DeploymentId { get; set; } + /// API key of the designated Azure OpenAI resource. + public string ApiKey { get; set; } + /// + /// 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. + /// The available derived classes include and . + /// + public SearchIndexerDataIdentity AuthIdentity { get; set; } + /// + /// The name of the embedding model that is deployed at the provided deploymentId + /// path. + /// + public AzureOpenAIModelName? ModelName { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BM25SimilarityAlgorithm.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BM25SimilarityAlgorithm.Serialization.cs new file mode 100644 index 000000000000..4b44522d0941 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BM25SimilarityAlgorithm.Serialization.cs @@ -0,0 +1,156 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class BM25SimilarityAlgorithm : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(BM25SimilarityAlgorithm)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(K1)) + { + writer.WritePropertyName("k1"u8); + writer.WriteNumberValue(K1.Value); + } + if (Optional.IsDefined(B)) + { + writer.WritePropertyName("b"u8); + writer.WriteNumberValue(B.Value); + } + } + + BM25SimilarityAlgorithm IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(BM25SimilarityAlgorithm)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeBM25SimilarityAlgorithm(document.RootElement, options); + } + + internal static BM25SimilarityAlgorithm DeserializeBM25SimilarityAlgorithm(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + double? k1 = default; + double? b = default; + string odataType = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("k1"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + k1 = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("b"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + b = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new BM25SimilarityAlgorithm(odataType, serializedAdditionalRawData, k1, b); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(BM25SimilarityAlgorithm)} does not support writing '{options.Format}' format."); + } + } + + BM25SimilarityAlgorithm IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeBM25SimilarityAlgorithm(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(BM25SimilarityAlgorithm)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new BM25SimilarityAlgorithm FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeBM25SimilarityAlgorithm(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BM25SimilarityAlgorithm.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BM25SimilarityAlgorithm.cs new file mode 100644 index 000000000000..e5db97b66d00 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BM25SimilarityAlgorithm.cs @@ -0,0 +1,63 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a + /// TF-IDF-like algorithm that includes length normalization (controlled by the 'b' + /// parameter) as well as term frequency saturation (controlled by the 'k1' + /// parameter). + /// + public partial class BM25SimilarityAlgorithm : SimilarityAlgorithm + { + /// Initializes a new instance of . + public BM25SimilarityAlgorithm() + { + OdataType = "#Microsoft.Azure.Search.BM25Similarity"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Keeps track of any properties unknown to the library. + /// + /// This property controls the scaling function between the term frequency of each + /// matching terms and the final relevance score of a document-query pair. By + /// default, a value of 1.2 is used. A value of 0.0 means the score does not scale + /// with an increase in term frequency. + /// + /// + /// This property controls how the length of a document affects the relevance + /// score. By default, a value of 0.75 is used. A value of 0.0 means no length + /// normalization is applied, while a value of 1.0 means the score is fully + /// normalized by the length of the document. + /// + internal BM25SimilarityAlgorithm(string odataType, IDictionary serializedAdditionalRawData, double? k1, double? b) : base(odataType, serializedAdditionalRawData) + { + K1 = k1; + B = b; + } + + /// + /// This property controls the scaling function between the term frequency of each + /// matching terms and the final relevance score of a document-query pair. By + /// default, a value of 1.2 is used. A value of 0.0 means the score does not scale + /// with an increase in term frequency. + /// + public double? K1 { get; set; } + /// + /// This property controls how the length of a document affects the relevance + /// score. By default, a value of 0.75 is used. A value of 0.0 means no length + /// normalization is applied, while a value of 1.0 means the score is fully + /// normalized by the length of the document. + /// + public double? B { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BinaryQuantizationCompression.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BinaryQuantizationCompression.Serialization.cs new file mode 100644 index 000000000000..1ee73893099c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BinaryQuantizationCompression.Serialization.cs @@ -0,0 +1,179 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class BinaryQuantizationCompression : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(BinaryQuantizationCompression)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + BinaryQuantizationCompression IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(BinaryQuantizationCompression)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeBinaryQuantizationCompression(document.RootElement, options); + } + + internal static BinaryQuantizationCompression DeserializeBinaryQuantizationCompression(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + bool? rerankWithOriginalVectors = default; + double? defaultOversampling = default; + RescoringOptions rescoringOptions = default; + int? truncationDimension = default; + VectorSearchCompressionKind kind = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("rerankWithOriginalVectors"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + rerankWithOriginalVectors = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("defaultOversampling"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + defaultOversampling = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("rescoringOptions"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + rescoringOptions = RescoringOptions.DeserializeRescoringOptions(property.Value, options); + continue; + } + if (property.NameEquals("truncationDimension"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + truncationDimension = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorSearchCompressionKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new BinaryQuantizationCompression( + name, + rerankWithOriginalVectors, + defaultOversampling, + rescoringOptions, + truncationDimension, + kind, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(BinaryQuantizationCompression)} does not support writing '{options.Format}' format."); + } + } + + BinaryQuantizationCompression IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeBinaryQuantizationCompression(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(BinaryQuantizationCompression)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new BinaryQuantizationCompression FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeBinaryQuantizationCompression(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BinaryQuantizationCompression.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BinaryQuantizationCompression.cs new file mode 100644 index 000000000000..7987ce5edbd4 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BinaryQuantizationCompression.cs @@ -0,0 +1,66 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Contains configuration options specific to the binary quantization compression + /// method used during indexing and querying. + /// + public partial class BinaryQuantizationCompression : VectorSearchCompression + { + /// Initializes a new instance of . + /// The name to associate with this particular configuration. + /// is null. + public BinaryQuantizationCompression(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + Kind = VectorSearchCompressionKind.BinaryQuantization; + } + + /// Initializes a new instance of . + /// The name to associate with this particular configuration. + /// + /// If set to true, once the ordered set of results calculated using compressed + /// vectors are obtained, they will be reranked again by recalculating the + /// full-precision similarity scores. This will improve recall at the expense of + /// latency. + /// + /// + /// Default oversampling factor. Oversampling will internally request more + /// documents (specified by this multiplier) in the initial search. This increases + /// the set of results that will be reranked using recomputed similarity scores + /// from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). + /// This parameter can only be set when rerankWithOriginalVectors is true. Higher + /// values improve recall at the expense of latency. + /// + /// Contains the options for rescoring. + /// + /// The number of dimensions to truncate the vectors to. Truncating the vectors + /// reduces the size of the vectors and the amount of data that needs to be + /// transferred during search. This can save storage cost and improve search + /// performance at the expense of recall. It should be only used for embeddings + /// trained with Matryoshka Representation Learning (MRL) such as OpenAI + /// text-embedding-3-large (small). The default value is null, which means no + /// truncation. + /// + /// Type of VectorSearchCompression. + /// Keeps track of any properties unknown to the library. + internal BinaryQuantizationCompression(string name, bool? rerankWithOriginalVectors, double? defaultOversampling, RescoringOptions rescoringOptions, int? truncationDimension, VectorSearchCompressionKind kind, IDictionary serializedAdditionalRawData) : base(name, rerankWithOriginalVectors, defaultOversampling, rescoringOptions, truncationDimension, kind, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal BinaryQuantizationCompression() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BlobIndexerDataToExtract.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BlobIndexerDataToExtract.cs new file mode 100644 index 000000000000..9cda3f7c856b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BlobIndexerDataToExtract.cs @@ -0,0 +1,63 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Specifies the data to extract from Azure blob storage and tells the indexer + /// which data to extract from image content when "imageAction" is set to a value + /// other than "none". This applies to embedded image content in a .PDF or other + /// application, or image files such as .jpg and .png, in Azure blobs. + /// + public readonly partial struct BlobIndexerDataToExtract : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public BlobIndexerDataToExtract(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string StorageMetadataValue = "storageMetadata"; + private const string AllMetadataValue = "allMetadata"; + private const string ContentAndMetadataValue = "contentAndMetadata"; + + /// Indexes just the standard blob properties and user-specified metadata. + public static BlobIndexerDataToExtract StorageMetadata { get; } = new BlobIndexerDataToExtract(StorageMetadataValue); + /// + /// Extracts metadata provided by the Azure blob storage subsystem and the + /// content-type specific metadata (for example, metadata unique to just .png files + /// are indexed). + /// + public static BlobIndexerDataToExtract AllMetadata { get; } = new BlobIndexerDataToExtract(AllMetadataValue); + /// Extracts all metadata and textual content from each blob. + public static BlobIndexerDataToExtract ContentAndMetadata { get; } = new BlobIndexerDataToExtract(ContentAndMetadataValue); + /// Determines if two values are the same. + public static bool operator ==(BlobIndexerDataToExtract left, BlobIndexerDataToExtract right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(BlobIndexerDataToExtract left, BlobIndexerDataToExtract right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator BlobIndexerDataToExtract(string value) => new BlobIndexerDataToExtract(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is BlobIndexerDataToExtract other && Equals(other); + /// + public bool Equals(BlobIndexerDataToExtract other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BlobIndexerImageAction.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BlobIndexerImageAction.cs new file mode 100644 index 000000000000..144688d7f1c0 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BlobIndexerImageAction.cs @@ -0,0 +1,71 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Determines how to process embedded images and image files in Azure blob + /// storage. Setting the "imageAction" configuration to any value other than + /// "none" requires that a skillset also be attached to that indexer. + /// + public readonly partial struct BlobIndexerImageAction : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public BlobIndexerImageAction(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string NoneValue = "none"; + private const string GenerateNormalizedImagesValue = "generateNormalizedImages"; + private const string GenerateNormalizedImagePerPageValue = "generateNormalizedImagePerPage"; + + /// Ignores embedded images or image files in the data set. This is the default. + public static BlobIndexerImageAction None { get; } = new BlobIndexerImageAction(NoneValue); + /// + /// Extracts text from images (for example, the word "STOP" from a traffic stop + /// sign), and embeds it into the content field. This action requires that + /// "dataToExtract" is set to "contentAndMetadata". A normalized image refers to + /// additional processing resulting in uniform image output, sized and rotated to + /// promote consistent rendering when you include images in visual search results. + /// This information is generated for each image when you use this option. + /// + public static BlobIndexerImageAction GenerateNormalizedImages { get; } = new BlobIndexerImageAction(GenerateNormalizedImagesValue); + /// + /// Extracts text from images (for example, the word "STOP" from a traffic stop + /// sign), and embeds it into the content field, but treats PDF files differently + /// in that each page will be rendered as an image and normalized accordingly, + /// instead of extracting embedded images. Non-PDF file types will be treated the + /// same as if "generateNormalizedImages" was set. + /// + public static BlobIndexerImageAction GenerateNormalizedImagePerPage { get; } = new BlobIndexerImageAction(GenerateNormalizedImagePerPageValue); + /// Determines if two values are the same. + public static bool operator ==(BlobIndexerImageAction left, BlobIndexerImageAction right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(BlobIndexerImageAction left, BlobIndexerImageAction right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator BlobIndexerImageAction(string value) => new BlobIndexerImageAction(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is BlobIndexerImageAction other && Equals(other); + /// + public bool Equals(BlobIndexerImageAction other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BlobIndexerPDFTextRotationAlgorithm.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BlobIndexerPDFTextRotationAlgorithm.cs new file mode 100644 index 000000000000..84c5c4c27230 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BlobIndexerPDFTextRotationAlgorithm.cs @@ -0,0 +1,57 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Determines algorithm for text extraction from PDF files in Azure blob storage. + public readonly partial struct BlobIndexerPDFTextRotationAlgorithm : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public BlobIndexerPDFTextRotationAlgorithm(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string NoneValue = "none"; + private const string DetectAnglesValue = "detectAngles"; + + /// Leverages normal text extraction. This is the default. + public static BlobIndexerPDFTextRotationAlgorithm None { get; } = new BlobIndexerPDFTextRotationAlgorithm(NoneValue); + /// + /// May produce better and more readable text extraction from PDF files that have + /// rotated text within them. Note that there may be a small performance speed + /// impact when this parameter is used. This parameter only applies to PDF files, + /// and only to PDFs with embedded text. If the rotated text appears within an + /// embedded image in the PDF, this parameter does not apply. + /// + public static BlobIndexerPDFTextRotationAlgorithm DetectAngles { get; } = new BlobIndexerPDFTextRotationAlgorithm(DetectAnglesValue); + /// Determines if two values are the same. + public static bool operator ==(BlobIndexerPDFTextRotationAlgorithm left, BlobIndexerPDFTextRotationAlgorithm right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(BlobIndexerPDFTextRotationAlgorithm left, BlobIndexerPDFTextRotationAlgorithm right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator BlobIndexerPDFTextRotationAlgorithm(string value) => new BlobIndexerPDFTextRotationAlgorithm(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is BlobIndexerPDFTextRotationAlgorithm other && Equals(other); + /// + public bool Equals(BlobIndexerPDFTextRotationAlgorithm other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BlobIndexerParsingMode.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BlobIndexerParsingMode.cs new file mode 100644 index 000000000000..e17c319f7b4a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/BlobIndexerParsingMode.cs @@ -0,0 +1,72 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents the parsing mode for indexing from an Azure blob data source. + public readonly partial struct BlobIndexerParsingMode : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public BlobIndexerParsingMode(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string DefaultValue = "default"; + private const string TextValue = "text"; + private const string DelimitedTextValue = "delimitedText"; + private const string JsonValue = "json"; + private const string JsonArrayValue = "jsonArray"; + private const string JsonLinesValue = "jsonLines"; + private const string MarkdownValue = "markdown"; + + /// Set to default for normal file processing. + public static BlobIndexerParsingMode Default { get; } = new BlobIndexerParsingMode(DefaultValue); + /// Set to text to improve indexing performance on plain text files in blob storage. + public static BlobIndexerParsingMode Text { get; } = new BlobIndexerParsingMode(TextValue); + /// Set to delimitedText when blobs are plain CSV files. + 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. + /// + public static BlobIndexerParsingMode JsonArray { get; } = new BlobIndexerParsingMode(JsonArrayValue); + /// + /// Set to jsonLines to extract individual JSON entities, separated by a new line, + /// as separate documents. + /// + public static BlobIndexerParsingMode JsonLines { get; } = new BlobIndexerParsingMode(JsonLinesValue); + /// Set to markdown to extract content from markdown files. + public static BlobIndexerParsingMode Markdown { get; } = new BlobIndexerParsingMode(MarkdownValue); + /// Determines if two values are the same. + public static bool operator ==(BlobIndexerParsingMode left, BlobIndexerParsingMode right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(BlobIndexerParsingMode left, BlobIndexerParsingMode right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator BlobIndexerParsingMode(string value) => new BlobIndexerParsingMode(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is BlobIndexerParsingMode other && Equals(other); + /// + public bool Equals(BlobIndexerParsingMode other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CharFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CharFilter.Serialization.cs new file mode 100644 index 000000000000..2c4117da1369 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CharFilter.Serialization.cs @@ -0,0 +1,136 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + [PersistableModelProxy(typeof(UnknownCharFilter))] + public partial class CharFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CharFilter)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("@odata.type"u8); + writer.WriteStringValue(OdataType); + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + CharFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CharFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeCharFilter(document.RootElement, options); + } + + internal static CharFilter DeserializeCharFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("@odata.type", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "#Microsoft.Azure.Search.MappingCharFilter": return MappingCharFilter.DeserializeMappingCharFilter(element, options); + case "#Microsoft.Azure.Search.PatternReplaceCharFilter": return PatternReplaceCharFilter.DeserializePatternReplaceCharFilter(element, options); + } + } + return UnknownCharFilter.DeserializeUnknownCharFilter(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(CharFilter)} does not support writing '{options.Format}' format."); + } + } + + CharFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCharFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(CharFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static CharFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCharFilter(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CharFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CharFilter.cs new file mode 100644 index 000000000000..3e8a180fabcb --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CharFilter.cs @@ -0,0 +1,95 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Base type for character filters. + /// 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 abstract partial class CharFilter + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + protected CharFilter(string name) + { + Argument.AssertNotNull(name, nameof(name)); + + Name = name; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal CharFilter(string odataType, string name, IDictionary serializedAdditionalRawData) + { + OdataType = odataType; + Name = name; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal CharFilter() + { + } + + /// The discriminator for derived types. + 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.Indexes/src/Generated/CharFilterName.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CharFilterName.cs new file mode 100644 index 000000000000..1b4006ab6867 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CharFilterName.cs @@ -0,0 +1,51 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Defines the names of all character filters supported by the search engine. + public readonly partial struct CharFilterName : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public CharFilterName(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string HtmlStripValue = "html_strip"; + + /// + /// A character filter that attempts to strip out HTML constructs. See + /// https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html + /// + public static CharFilterName HtmlStrip { get; } = new CharFilterName(HtmlStripValue); + /// Determines if two values are the same. + public static bool operator ==(CharFilterName left, CharFilterName right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(CharFilterName left, CharFilterName right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator CharFilterName(string value) => new CharFilterName(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is CharFilterName other && Equals(other); + /// + public bool Equals(CharFilterName other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CjkBigramTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CjkBigramTokenFilter.Serialization.cs new file mode 100644 index 000000000000..7aca89494775 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CjkBigramTokenFilter.Serialization.cs @@ -0,0 +1,172 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class CjkBigramTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CjkBigramTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsCollectionDefined(IgnoreScripts)) + { + writer.WritePropertyName("ignoreScripts"u8); + writer.WriteStartArray(); + foreach (var item in IgnoreScripts) + { + writer.WriteStringValue(item.ToString()); + } + writer.WriteEndArray(); + } + if (Optional.IsDefined(OutputUnigrams)) + { + writer.WritePropertyName("outputUnigrams"u8); + writer.WriteBooleanValue(OutputUnigrams.Value); + } + } + + CjkBigramTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CjkBigramTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeCjkBigramTokenFilter(document.RootElement, options); + } + + internal static CjkBigramTokenFilter DeserializeCjkBigramTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList ignoreScripts = default; + bool? outputUnigrams = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("ignoreScripts"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(new CjkBigramTokenFilterScripts(item.GetString())); + } + ignoreScripts = array; + continue; + } + if (property.NameEquals("outputUnigrams"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + outputUnigrams = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new CjkBigramTokenFilter(odataType, name, serializedAdditionalRawData, ignoreScripts ?? new ChangeTrackingList(), outputUnigrams); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(CjkBigramTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + CjkBigramTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCjkBigramTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(CjkBigramTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new CjkBigramTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCjkBigramTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CjkBigramTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CjkBigramTokenFilter.cs new file mode 100644 index 000000000000..164823eeff2f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CjkBigramTokenFilter.cs @@ -0,0 +1,66 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Forms bigrams of CJK terms that are generated from the standard tokenizer. This + /// token filter is implemented using Apache Lucene. + /// + public partial class CjkBigramTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public CjkBigramTokenFilter(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.CjkBigramTokenFilter"; + IgnoreScripts = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// The scripts to ignore. + /// + /// A value indicating whether to output both unigrams and bigrams (if true), or + /// just bigrams (if false). Default is false. + /// + internal CjkBigramTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, IList ignoreScripts, bool? outputUnigrams) : base(odataType, name, serializedAdditionalRawData) + { + IgnoreScripts = ignoreScripts; + OutputUnigrams = outputUnigrams; + } + + /// Initializes a new instance of for deserialization. + internal CjkBigramTokenFilter() + { + } + + /// The scripts to ignore. + public IList IgnoreScripts { get; } + /// + /// A value indicating whether to output both unigrams and bigrams (if true), or + /// just bigrams (if false). Default is false. + /// + public bool? OutputUnigrams { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CjkBigramTokenFilterScripts.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CjkBigramTokenFilterScripts.cs new file mode 100644 index 000000000000..7ec8adf00937 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CjkBigramTokenFilterScripts.cs @@ -0,0 +1,57 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Scripts that can be ignored by CjkBigramTokenFilter. + public readonly partial struct CjkBigramTokenFilterScripts : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public CjkBigramTokenFilterScripts(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string HanValue = "han"; + private const string HiraganaValue = "hiragana"; + private const string KatakanaValue = "katakana"; + private const string HangulValue = "hangul"; + + /// Ignore Han script when forming bigrams of CJK terms. + public static CjkBigramTokenFilterScripts Han { get; } = new CjkBigramTokenFilterScripts(HanValue); + /// Ignore Hiragana script when forming bigrams of CJK terms. + public static CjkBigramTokenFilterScripts Hiragana { get; } = new CjkBigramTokenFilterScripts(HiraganaValue); + /// Ignore Katakana script when forming bigrams of CJK terms. + public static CjkBigramTokenFilterScripts Katakana { get; } = new CjkBigramTokenFilterScripts(KatakanaValue); + /// Ignore Hangul script when forming bigrams of CJK terms. + public static CjkBigramTokenFilterScripts Hangul { get; } = new CjkBigramTokenFilterScripts(HangulValue); + /// Determines if two values are the same. + public static bool operator ==(CjkBigramTokenFilterScripts left, CjkBigramTokenFilterScripts right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(CjkBigramTokenFilterScripts left, CjkBigramTokenFilterScripts right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator CjkBigramTokenFilterScripts(string value) => new CjkBigramTokenFilterScripts(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is CjkBigramTokenFilterScripts other && Equals(other); + /// + public bool Equals(CjkBigramTokenFilterScripts other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ClassicSimilarityAlgorithm.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ClassicSimilarityAlgorithm.Serialization.cs new file mode 100644 index 000000000000..9124ca4649c2 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ClassicSimilarityAlgorithm.Serialization.cs @@ -0,0 +1,126 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ClassicSimilarityAlgorithm : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ClassicSimilarityAlgorithm)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + ClassicSimilarityAlgorithm IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ClassicSimilarityAlgorithm)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeClassicSimilarityAlgorithm(document.RootElement, options); + } + + internal static ClassicSimilarityAlgorithm DeserializeClassicSimilarityAlgorithm(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ClassicSimilarityAlgorithm(odataType, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ClassicSimilarityAlgorithm)} does not support writing '{options.Format}' format."); + } + } + + ClassicSimilarityAlgorithm IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeClassicSimilarityAlgorithm(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ClassicSimilarityAlgorithm)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new ClassicSimilarityAlgorithm FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeClassicSimilarityAlgorithm(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ClassicSimilarityAlgorithm.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ClassicSimilarityAlgorithm.cs new file mode 100644 index 000000000000..d0bbda23159e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ClassicSimilarityAlgorithm.cs @@ -0,0 +1,34 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Legacy similarity algorithm which uses the Lucene TFIDFSimilarity + /// implementation of TF-IDF. This variation of TF-IDF introduces static document + /// length normalization as well as coordinating factors that penalize documents + /// that only partially match the searched queries. + /// + public partial class ClassicSimilarityAlgorithm : SimilarityAlgorithm + { + /// Initializes a new instance of . + public ClassicSimilarityAlgorithm() + { + OdataType = "#Microsoft.Azure.Search.ClassicSimilarity"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Keeps track of any properties unknown to the library. + internal ClassicSimilarityAlgorithm(string odataType, IDictionary serializedAdditionalRawData) : base(odataType, serializedAdditionalRawData) + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ClassicTokenizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ClassicTokenizer.Serialization.cs new file mode 100644 index 000000000000..5b3652d00d6c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ClassicTokenizer.Serialization.cs @@ -0,0 +1,147 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ClassicTokenizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ClassicTokenizer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(MaxTokenLength)) + { + writer.WritePropertyName("maxTokenLength"u8); + writer.WriteNumberValue(MaxTokenLength.Value); + } + } + + ClassicTokenizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ClassicTokenizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeClassicTokenizer(document.RootElement, options); + } + + internal static ClassicTokenizer DeserializeClassicTokenizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? maxTokenLength = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("maxTokenLength"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxTokenLength = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ClassicTokenizer(odataType, name, serializedAdditionalRawData, maxTokenLength); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ClassicTokenizer)} does not support writing '{options.Format}' format."); + } + } + + ClassicTokenizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeClassicTokenizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ClassicTokenizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new ClassicTokenizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeClassicTokenizer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ClassicTokenizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ClassicTokenizer.cs new file mode 100644 index 000000000000..17a81c26e54a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ClassicTokenizer.cs @@ -0,0 +1,61 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Grammar-based tokenizer that is suitable for processing most European-language + /// documents. This tokenizer is implemented using Apache Lucene. + /// + public partial class ClassicTokenizer : LexicalTokenizer + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public ClassicTokenizer(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.ClassicTokenizer"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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, IDictionary serializedAdditionalRawData, int? maxTokenLength) : base(odataType, name, serializedAdditionalRawData) + { + MaxTokenLength = maxTokenLength; + } + + /// Initializes a new instance of for deserialization. + internal ClassicTokenizer() + { + } + + /// + /// 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. + /// + public int? MaxTokenLength { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CognitiveServicesAccount.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CognitiveServicesAccount.Serialization.cs new file mode 100644 index 000000000000..9b223d00bf06 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CognitiveServicesAccount.Serialization.cs @@ -0,0 +1,141 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + [PersistableModelProxy(typeof(UnknownCognitiveServicesAccount))] + public partial class CognitiveServicesAccount : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CognitiveServicesAccount)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("@odata.type"u8); + writer.WriteStringValue(OdataType); + if (Optional.IsDefined(Description)) + { + writer.WritePropertyName("description"u8); + writer.WriteStringValue(Description); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + CognitiveServicesAccount IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CognitiveServicesAccount)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeCognitiveServicesAccount(document.RootElement, options); + } + + internal static CognitiveServicesAccount DeserializeCognitiveServicesAccount(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("@odata.type", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "#Microsoft.Azure.Search.AIServicesByIdentity": return AIServicesAccountIdentity.DeserializeAIServicesAccountIdentity(element, options); + case "#Microsoft.Azure.Search.AIServicesByKey": return AIServicesAccountKey.DeserializeAIServicesAccountKey(element, options); + case "#Microsoft.Azure.Search.CognitiveServicesByKey": return CognitiveServicesAccountKey.DeserializeCognitiveServicesAccountKey(element, options); + case "#Microsoft.Azure.Search.DefaultCognitiveServices": return DefaultCognitiveServicesAccount.DeserializeDefaultCognitiveServicesAccount(element, options); + } + } + return UnknownCognitiveServicesAccount.DeserializeUnknownCognitiveServicesAccount(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(CognitiveServicesAccount)} does not support writing '{options.Format}' format."); + } + } + + CognitiveServicesAccount IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCognitiveServicesAccount(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(CognitiveServicesAccount)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static CognitiveServicesAccount FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCognitiveServicesAccount(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CognitiveServicesAccount.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CognitiveServicesAccount.cs new file mode 100644 index 000000000000..fe8232922808 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CognitiveServicesAccount.cs @@ -0,0 +1,73 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// 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 abstract partial class CognitiveServicesAccount + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + protected CognitiveServicesAccount() + { + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Description of the Azure AI service resource attached to a skillset. + /// Keeps track of any properties unknown to the library. + internal CognitiveServicesAccount(string odataType, string description, IDictionary serializedAdditionalRawData) + { + OdataType = odataType; + Description = description; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The discriminator for derived types. + internal string OdataType { get; set; } + /// Description of the Azure AI service resource attached to a skillset. + public string Description { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CognitiveServicesAccountKey.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CognitiveServicesAccountKey.Serialization.cs new file mode 100644 index 000000000000..9f808f9d27ed --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CognitiveServicesAccountKey.Serialization.cs @@ -0,0 +1,140 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class CognitiveServicesAccountKey : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CognitiveServicesAccountKey)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("key"u8); + writer.WriteStringValue(Key); + } + + CognitiveServicesAccountKey IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CognitiveServicesAccountKey)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeCognitiveServicesAccountKey(document.RootElement, options); + } + + internal static CognitiveServicesAccountKey DeserializeCognitiveServicesAccountKey(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string key = default; + string odataType = default; + string description = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("key"u8)) + { + key = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new CognitiveServicesAccountKey(odataType, description, serializedAdditionalRawData, key); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(CognitiveServicesAccountKey)} does not support writing '{options.Format}' format."); + } + } + + CognitiveServicesAccountKey IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCognitiveServicesAccountKey(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(CognitiveServicesAccountKey)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new CognitiveServicesAccountKey FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCognitiveServicesAccountKey(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CognitiveServicesAccountKey.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CognitiveServicesAccountKey.cs new file mode 100644 index 000000000000..7e70f56d0641 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CognitiveServicesAccountKey.cs @@ -0,0 +1,48 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// 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 . + /// The key used to provision the Azure AI service resource attached to a skillset. + /// is null. + public CognitiveServicesAccountKey(string key) + { + Argument.AssertNotNull(key, nameof(key)); + + OdataType = "#Microsoft.Azure.Search.CognitiveServicesByKey"; + Key = key; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Description of the Azure AI service resource attached to a skillset. + /// Keeps track of any properties unknown to the library. + /// The key used to provision the Azure AI service resource attached to a skillset. + internal CognitiveServicesAccountKey(string odataType, string description, IDictionary serializedAdditionalRawData, string key) : base(odataType, description, serializedAdditionalRawData) + { + Key = key; + } + + /// Initializes a new instance of for deserialization. + internal CognitiveServicesAccountKey() + { + } + + /// 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.Indexes/src/Generated/CommonGramTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CommonGramTokenFilter.Serialization.cs new file mode 100644 index 000000000000..c95a9c1ca89d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CommonGramTokenFilter.Serialization.cs @@ -0,0 +1,186 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class CommonGramTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CommonGramTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("commonWords"u8); + writer.WriteStartArray(); + foreach (var item in CommonWords) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + if (Optional.IsDefined(IgnoreCase)) + { + writer.WritePropertyName("ignoreCase"u8); + writer.WriteBooleanValue(IgnoreCase.Value); + } + if (Optional.IsDefined(QueryMode)) + { + writer.WritePropertyName("queryMode"u8); + writer.WriteBooleanValue(QueryMode.Value); + } + } + + CommonGramTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CommonGramTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeCommonGramTokenFilter(document.RootElement, options); + } + + internal static CommonGramTokenFilter DeserializeCommonGramTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList commonWords = default; + bool? ignoreCase = default; + bool? queryMode = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("commonWords"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + commonWords = array; + continue; + } + if (property.NameEquals("ignoreCase"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + ignoreCase = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("queryMode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + queryMode = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new CommonGramTokenFilter( + odataType, + name, + serializedAdditionalRawData, + commonWords, + ignoreCase, + queryMode); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(CommonGramTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + CommonGramTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCommonGramTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(CommonGramTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new CommonGramTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCommonGramTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CommonGramTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CommonGramTokenFilter.cs new file mode 100644 index 000000000000..58262c835cb3 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CommonGramTokenFilter.cs @@ -0,0 +1,82 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Construct bigrams for frequently occurring terms while indexing. Single terms + /// are still indexed too, with bigrams overlaid. This token filter is implemented + /// using Apache Lucene. + /// + public partial class CommonGramTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// or is null. + public CommonGramTokenFilter(string name, IEnumerable commonWords) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(commonWords, nameof(commonWords)); + + OdataType = "#Microsoft.Azure.Search.CommonGramTokenFilter"; + CommonWords = commonWords.ToList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// The set of common words. + /// + /// A value indicating whether common words matching will be case insensitive. + /// Default is false. + /// + /// + /// A value that indicates whether the token filter is in query mode. When in query + /// mode, the token filter generates bigrams and then removes common words and + /// single terms followed by a common word. Default is false. + /// + internal CommonGramTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, IList commonWords, bool? ignoreCase, bool? queryMode) : base(odataType, name, serializedAdditionalRawData) + { + CommonWords = commonWords; + IgnoreCase = ignoreCase; + QueryMode = queryMode; + } + + /// Initializes a new instance of for deserialization. + internal CommonGramTokenFilter() + { + } + + /// The set of common words. + public IList CommonWords { get; } + /// + /// A value indicating whether common words matching will be case insensitive. + /// Default is false. + /// + public bool? IgnoreCase { get; set; } + /// + /// A value that indicates whether the token filter is in query mode. When in query + /// mode, the token filter generates bigrams and then removes common words and + /// single terms followed by a common word. Default is false. + /// + public bool? QueryMode { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ConditionalSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ConditionalSkill.Serialization.cs new file mode 100644 index 000000000000..cee8f490504d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ConditionalSkill.Serialization.cs @@ -0,0 +1,173 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ConditionalSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ConditionalSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + ConditionalSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ConditionalSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeConditionalSkill(document.RootElement, options); + } + + internal static ConditionalSkill DeserializeConditionalSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ConditionalSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ConditionalSkill)} does not support writing '{options.Format}' format."); + } + } + + ConditionalSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeConditionalSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ConditionalSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new ConditionalSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeConditionalSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ConditionalSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ConditionalSkill.cs new file mode 100644 index 000000000000..0ee860231b73 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ConditionalSkill.cs @@ -0,0 +1,71 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A skill that enables scenarios that require a Boolean operation to determine + /// the data to assign to an output. + /// + public partial class ConditionalSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public ConditionalSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Util.ConditionalSkill"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal ConditionalSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal ConditionalSkill() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CorsOptions.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CorsOptions.Serialization.cs new file mode 100644 index 000000000000..cffa81f624d3 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CorsOptions.Serialization.cs @@ -0,0 +1,167 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class CorsOptions : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CorsOptions)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("allowedOrigins"u8); + writer.WriteStartArray(); + foreach (var item in AllowedOrigins) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + if (Optional.IsDefined(MaxAgeInSeconds)) + { + writer.WritePropertyName("maxAgeInSeconds"u8); + writer.WriteNumberValue(MaxAgeInSeconds.Value); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + CorsOptions IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CorsOptions)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeCorsOptions(document.RootElement, options); + } + + internal static CorsOptions DeserializeCorsOptions(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList allowedOrigins = default; + long? maxAgeInSeconds = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("allowedOrigins"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + allowedOrigins = array; + continue; + } + if (property.NameEquals("maxAgeInSeconds"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxAgeInSeconds = property.Value.GetInt64(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new CorsOptions(allowedOrigins, maxAgeInSeconds, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(CorsOptions)} does not support writing '{options.Format}' format."); + } + } + + CorsOptions IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCorsOptions(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(CorsOptions)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static CorsOptions FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCorsOptions(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CorsOptions.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CorsOptions.cs new file mode 100644 index 000000000000..86bb98f5c610 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CorsOptions.cs @@ -0,0 +1,101 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// Defines options to control Cross-Origin Resource Sharing (CORS) for an index. + public partial class CorsOptions + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// The list of origins from which JavaScript code will be granted access to your + /// index. Can contain a list of hosts of the form + /// {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow + /// all origins (not recommended). + /// + /// is null. + public CorsOptions(IEnumerable allowedOrigins) + { + Argument.AssertNotNull(allowedOrigins, nameof(allowedOrigins)); + + AllowedOrigins = allowedOrigins.ToList(); + } + + /// Initializes a new instance of . + /// + /// The list of origins from which JavaScript code will be granted access to your + /// index. Can contain a list of hosts of the form + /// {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow + /// all origins (not recommended). + /// + /// + /// The duration for which browsers should cache CORS preflight responses. Defaults + /// to 5 minutes. + /// + /// Keeps track of any properties unknown to the library. + internal CorsOptions(IList allowedOrigins, long? maxAgeInSeconds, IDictionary serializedAdditionalRawData) + { + AllowedOrigins = allowedOrigins; + MaxAgeInSeconds = maxAgeInSeconds; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal CorsOptions() + { + } + + /// + /// The list of origins from which JavaScript code will be granted access to your + /// index. Can contain a list of hosts of the form + /// {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow + /// all origins (not recommended). + /// + public IList AllowedOrigins { get; } + /// + /// The duration for which browsers should cache CORS preflight responses. Defaults + /// to 5 minutes. + /// + public long? MaxAgeInSeconds { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomAnalyzer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomAnalyzer.Serialization.cs new file mode 100644 index 000000000000..864c2005c383 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomAnalyzer.Serialization.cs @@ -0,0 +1,196 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class CustomAnalyzer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CustomAnalyzer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("tokenizer"u8); + writer.WriteStringValue(Tokenizer.ToString()); + if (Optional.IsCollectionDefined(TokenFilters)) + { + writer.WritePropertyName("tokenFilters"u8); + writer.WriteStartArray(); + foreach (var item in TokenFilters) + { + writer.WriteStringValue(item.ToString()); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(CharFilters)) + { + writer.WritePropertyName("charFilters"u8); + writer.WriteStartArray(); + foreach (var item in CharFilters) + { + writer.WriteStringValue(item.ToString()); + } + writer.WriteEndArray(); + } + } + + CustomAnalyzer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CustomAnalyzer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeCustomAnalyzer(document.RootElement, options); + } + + internal static CustomAnalyzer DeserializeCustomAnalyzer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + LexicalTokenizerName tokenizer = default; + IList tokenFilters = default; + IList charFilters = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("tokenizer"u8)) + { + tokenizer = new LexicalTokenizerName(property.Value.GetString()); + continue; + } + if (property.NameEquals("tokenFilters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(new TokenFilterName(item.GetString())); + } + tokenFilters = array; + continue; + } + if (property.NameEquals("charFilters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(new CharFilterName(item.GetString())); + } + charFilters = array; + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new CustomAnalyzer( + odataType, + name, + serializedAdditionalRawData, + tokenizer, + tokenFilters ?? new ChangeTrackingList(), + charFilters ?? new ChangeTrackingList()); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(CustomAnalyzer)} does not support writing '{options.Format}' format."); + } + } + + CustomAnalyzer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCustomAnalyzer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(CustomAnalyzer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new CustomAnalyzer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCustomAnalyzer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomAnalyzer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomAnalyzer.cs new file mode 100644 index 000000000000..bfb5c3f39bc9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomAnalyzer.cs @@ -0,0 +1,97 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Allows you to take control over the process of converting text into + /// indexable/searchable tokens. It's a user-defined configuration consisting of a + /// single predefined tokenizer and one or more filters. The tokenizer is + /// responsible for breaking text into tokens, and the filters for modifying tokens + /// emitted by the tokenizer. + /// + public partial class CustomAnalyzer : LexicalAnalyzer + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public CustomAnalyzer(string name, LexicalTokenizerName tokenizer) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.CustomAnalyzer"; + Tokenizer = tokenizer; + TokenFilters = new ChangeTrackingList(); + CharFilters = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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. + /// + /// + /// A list of character filters used to prepare input text before it is processed + /// by the tokenizer. For instance, they can replace certain characters or symbols. + /// The filters are run in the order in which they are listed. + /// + internal CustomAnalyzer(string odataType, string name, IDictionary serializedAdditionalRawData, LexicalTokenizerName tokenizer, IList tokenFilters, IList charFilters) : base(odataType, name, serializedAdditionalRawData) + { + Tokenizer = tokenizer; + TokenFilters = tokenFilters; + CharFilters = charFilters; + } + + /// Initializes a new instance of for deserialization. + internal CustomAnalyzer() + { + } + + /// + /// The name of the tokenizer to use to divide continuous text into a sequence of + /// tokens, such as breaking a sentence into words. + /// + public LexicalTokenizerName Tokenizer { get; set; } + /// + /// 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. + /// + public IList TokenFilters { get; } + /// + /// A list of character filters used to prepare input text before it is processed + /// by the tokenizer. For instance, they can replace certain characters or symbols. + /// The filters are run in the order in which they are listed. + /// + public IList CharFilters { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntity.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntity.Serialization.cs new file mode 100644 index 000000000000..4ea10176007f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntity.Serialization.cs @@ -0,0 +1,314 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class CustomEntity : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CustomEntity)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + if (Optional.IsDefined(Description)) + { + writer.WritePropertyName("description"u8); + writer.WriteStringValue(Description); + } + if (Optional.IsDefined(Type)) + { + writer.WritePropertyName("type"u8); + writer.WriteStringValue(Type); + } + if (Optional.IsDefined(Subtype)) + { + writer.WritePropertyName("subtype"u8); + writer.WriteStringValue(Subtype); + } + if (Optional.IsDefined(Id)) + { + writer.WritePropertyName("id"u8); + writer.WriteStringValue(Id); + } + if (Optional.IsDefined(CaseSensitive)) + { + writer.WritePropertyName("caseSensitive"u8); + writer.WriteBooleanValue(CaseSensitive.Value); + } + if (Optional.IsDefined(AccentSensitive)) + { + writer.WritePropertyName("accentSensitive"u8); + writer.WriteBooleanValue(AccentSensitive.Value); + } + if (Optional.IsDefined(FuzzyEditDistance)) + { + writer.WritePropertyName("fuzzyEditDistance"u8); + writer.WriteNumberValue(FuzzyEditDistance.Value); + } + if (Optional.IsDefined(DefaultCaseSensitive)) + { + writer.WritePropertyName("defaultCaseSensitive"u8); + writer.WriteBooleanValue(DefaultCaseSensitive.Value); + } + if (Optional.IsDefined(DefaultAccentSensitive)) + { + writer.WritePropertyName("defaultAccentSensitive"u8); + writer.WriteBooleanValue(DefaultAccentSensitive.Value); + } + if (Optional.IsDefined(DefaultFuzzyEditDistance)) + { + writer.WritePropertyName("defaultFuzzyEditDistance"u8); + writer.WriteNumberValue(DefaultFuzzyEditDistance.Value); + } + if (Optional.IsCollectionDefined(Aliases)) + { + writer.WritePropertyName("aliases"u8); + writer.WriteStartArray(); + foreach (var item in Aliases) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + CustomEntity IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CustomEntity)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeCustomEntity(document.RootElement, options); + } + + internal static CustomEntity DeserializeCustomEntity(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + string description = default; + string type = default; + string subtype = default; + string id = default; + bool? caseSensitive = default; + bool? accentSensitive = default; + int? fuzzyEditDistance = default; + bool? defaultCaseSensitive = default; + bool? defaultAccentSensitive = default; + int? defaultFuzzyEditDistance = default; + IList aliases = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("type"u8)) + { + type = property.Value.GetString(); + continue; + } + if (property.NameEquals("subtype"u8)) + { + subtype = property.Value.GetString(); + continue; + } + if (property.NameEquals("id"u8)) + { + id = property.Value.GetString(); + continue; + } + if (property.NameEquals("caseSensitive"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + caseSensitive = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("accentSensitive"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + accentSensitive = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("fuzzyEditDistance"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + fuzzyEditDistance = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("defaultCaseSensitive"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + defaultCaseSensitive = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("defaultAccentSensitive"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + defaultAccentSensitive = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("defaultFuzzyEditDistance"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + defaultFuzzyEditDistance = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("aliases"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(CustomEntityAlias.DeserializeCustomEntityAlias(item, options)); + } + aliases = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new CustomEntity( + name, + description, + type, + subtype, + id, + caseSensitive, + accentSensitive, + fuzzyEditDistance, + defaultCaseSensitive, + defaultAccentSensitive, + defaultFuzzyEditDistance, + aliases ?? new ChangeTrackingList(), + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(CustomEntity)} does not support writing '{options.Format}' format."); + } + } + + CustomEntity IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCustomEntity(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(CustomEntity)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static CustomEntity FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCustomEntity(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntity.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntity.cs new file mode 100644 index 000000000000..fd61960aedbe --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntity.cs @@ -0,0 +1,219 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// An object that contains information about the matches that were found, and + /// related metadata. + /// + public partial class CustomEntity + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// The top-level entity descriptor. Matches in the skill output will be grouped by + /// this name, and it should represent the "normalized" form of the text being + /// found. + /// + /// is null. + public CustomEntity(string name) + { + Argument.AssertNotNull(name, nameof(name)); + + Name = name; + Aliases = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// + /// The top-level entity descriptor. Matches in the skill output will be grouped by + /// this name, and it should represent the "normalized" form of the text being + /// found. + /// + /// + /// This field can be used as a passthrough for custom metadata about the matched + /// text(s). The value of this field will appear with every match of its entity in + /// the skill output. + /// + /// + /// This field can be used as a passthrough for custom metadata about the matched + /// text(s). The value of this field will appear with every match of its entity in + /// the skill output. + /// + /// + /// This field can be used as a passthrough for custom metadata about the matched + /// text(s). The value of this field will appear with every match of its entity in + /// the skill output. + /// + /// + /// This field can be used as a passthrough for custom metadata about the matched + /// text(s). The value of this field will appear with every match of its entity in + /// the skill output. + /// + /// + /// Defaults to false. Boolean value denoting whether comparisons with the entity + /// name should be sensitive to character casing. Sample case insensitive matches + /// of "Microsoft" could be: microsoft, microSoft, MICROSOFT. + /// + /// + /// Defaults to false. Boolean value denoting whether comparisons with the entity + /// name should be sensitive to accent. + /// + /// + /// Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent + /// characters that would still constitute a match with the entity name. The + /// smallest possible fuzziness for any given match is returned. For instance, if + /// the edit distance is set to 3, "Windows10" would still match "Windows", + /// "Windows10" and "Windows 7". When case sensitivity is set to false, case + /// differences do NOT count towards fuzziness tolerance, but otherwise do. + /// + /// + /// Changes the default case sensitivity value for this entity. It be used to + /// change the default value of all aliases caseSensitive values. + /// + /// + /// Changes the default accent sensitivity value for this entity. It be used to + /// change the default value of all aliases accentSensitive values. + /// + /// + /// Changes the default fuzzy edit distance value for this entity. It can be used + /// to change the default value of all aliases fuzzyEditDistance values. + /// + /// + /// An array of complex objects that can be used to specify alternative spellings + /// or synonyms to the root entity name. + /// + /// Keeps track of any properties unknown to the library. + internal CustomEntity(string name, string description, string type, string subtype, string id, bool? caseSensitive, bool? accentSensitive, int? fuzzyEditDistance, bool? defaultCaseSensitive, bool? defaultAccentSensitive, int? defaultFuzzyEditDistance, IList aliases, IDictionary serializedAdditionalRawData) + { + Name = name; + Description = description; + Type = type; + Subtype = subtype; + Id = id; + CaseSensitive = caseSensitive; + AccentSensitive = accentSensitive; + FuzzyEditDistance = fuzzyEditDistance; + DefaultCaseSensitive = defaultCaseSensitive; + DefaultAccentSensitive = defaultAccentSensitive; + DefaultFuzzyEditDistance = defaultFuzzyEditDistance; + Aliases = aliases; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal CustomEntity() + { + } + + /// + /// The top-level entity descriptor. Matches in the skill output will be grouped by + /// this name, and it should represent the "normalized" form of the text being + /// found. + /// + public string Name { get; set; } + /// + /// This field can be used as a passthrough for custom metadata about the matched + /// text(s). The value of this field will appear with every match of its entity in + /// the skill output. + /// + public string Description { get; set; } + /// + /// This field can be used as a passthrough for custom metadata about the matched + /// text(s). The value of this field will appear with every match of its entity in + /// the skill output. + /// + public string Type { get; set; } + /// + /// This field can be used as a passthrough for custom metadata about the matched + /// text(s). The value of this field will appear with every match of its entity in + /// the skill output. + /// + public string Subtype { get; set; } + /// + /// This field can be used as a passthrough for custom metadata about the matched + /// text(s). The value of this field will appear with every match of its entity in + /// the skill output. + /// + public string Id { get; set; } + /// + /// Defaults to false. Boolean value denoting whether comparisons with the entity + /// name should be sensitive to character casing. Sample case insensitive matches + /// of "Microsoft" could be: microsoft, microSoft, MICROSOFT. + /// + public bool? CaseSensitive { get; set; } + /// + /// Defaults to false. Boolean value denoting whether comparisons with the entity + /// name should be sensitive to accent. + /// + public bool? AccentSensitive { get; set; } + /// + /// Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent + /// characters that would still constitute a match with the entity name. The + /// smallest possible fuzziness for any given match is returned. For instance, if + /// the edit distance is set to 3, "Windows10" would still match "Windows", + /// "Windows10" and "Windows 7". When case sensitivity is set to false, case + /// differences do NOT count towards fuzziness tolerance, but otherwise do. + /// + public int? FuzzyEditDistance { get; set; } + /// + /// Changes the default case sensitivity value for this entity. It be used to + /// change the default value of all aliases caseSensitive values. + /// + public bool? DefaultCaseSensitive { get; set; } + /// + /// Changes the default accent sensitivity value for this entity. It be used to + /// change the default value of all aliases accentSensitive values. + /// + public bool? DefaultAccentSensitive { get; set; } + /// + /// Changes the default fuzzy edit distance value for this entity. It can be used + /// to change the default value of all aliases fuzzyEditDistance values. + /// + public int? DefaultFuzzyEditDistance { get; set; } + /// + /// An array of complex objects that can be used to specify alternative spellings + /// or synonyms to the root entity name. + /// + public IList Aliases { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntityAlias.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntityAlias.Serialization.cs new file mode 100644 index 000000000000..f461b6c175c7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntityAlias.Serialization.cs @@ -0,0 +1,187 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class CustomEntityAlias : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CustomEntityAlias)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("text"u8); + writer.WriteStringValue(Text); + if (Optional.IsDefined(CaseSensitive)) + { + writer.WritePropertyName("caseSensitive"u8); + writer.WriteBooleanValue(CaseSensitive.Value); + } + if (Optional.IsDefined(AccentSensitive)) + { + writer.WritePropertyName("accentSensitive"u8); + writer.WriteBooleanValue(AccentSensitive.Value); + } + if (Optional.IsDefined(FuzzyEditDistance)) + { + writer.WritePropertyName("fuzzyEditDistance"u8); + writer.WriteNumberValue(FuzzyEditDistance.Value); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + CustomEntityAlias IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CustomEntityAlias)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeCustomEntityAlias(document.RootElement, options); + } + + internal static CustomEntityAlias DeserializeCustomEntityAlias(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string text = default; + bool? caseSensitive = default; + bool? accentSensitive = default; + int? fuzzyEditDistance = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("text"u8)) + { + text = property.Value.GetString(); + continue; + } + if (property.NameEquals("caseSensitive"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + caseSensitive = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("accentSensitive"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + accentSensitive = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("fuzzyEditDistance"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + fuzzyEditDistance = property.Value.GetInt32(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new CustomEntityAlias(text, caseSensitive, accentSensitive, fuzzyEditDistance, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(CustomEntityAlias)} does not support writing '{options.Format}' format."); + } + } + + CustomEntityAlias IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCustomEntityAlias(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(CustomEntityAlias)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static CustomEntityAlias FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCustomEntityAlias(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntityAlias.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntityAlias.cs new file mode 100644 index 000000000000..0a7d29e536f0 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntityAlias.cs @@ -0,0 +1,90 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A complex object that can be used to specify alternative spellings or synonyms + /// to the root entity name. + /// + public partial class CustomEntityAlias + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The text of the alias. + /// is null. + public CustomEntityAlias(string text) + { + Argument.AssertNotNull(text, nameof(text)); + + Text = text; + } + + /// Initializes a new instance of . + /// The text of the alias. + /// Determine if the alias is case sensitive. + /// Determine if the alias is accent sensitive. + /// Determine the fuzzy edit distance of the alias. + /// Keeps track of any properties unknown to the library. + internal CustomEntityAlias(string text, bool? caseSensitive, bool? accentSensitive, int? fuzzyEditDistance, IDictionary serializedAdditionalRawData) + { + Text = text; + CaseSensitive = caseSensitive; + AccentSensitive = accentSensitive; + FuzzyEditDistance = fuzzyEditDistance; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal CustomEntityAlias() + { + } + + /// The text of the alias. + public string Text { get; set; } + /// Determine if the alias is case sensitive. + public bool? CaseSensitive { get; set; } + /// Determine if the alias is accent sensitive. + public bool? AccentSensitive { get; set; } + /// Determine the fuzzy edit distance of the alias. + public int? FuzzyEditDistance { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntityLookupSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntityLookupSkill.Serialization.cs new file mode 100644 index 000000000000..d8aa7ba6e260 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntityLookupSkill.Serialization.cs @@ -0,0 +1,275 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class CustomEntityLookupSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CustomEntityLookupSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(DefaultLanguageCode)) + { + writer.WritePropertyName("defaultLanguageCode"u8); + writer.WriteStringValue(DefaultLanguageCode.Value.ToString()); + } + if (Optional.IsDefined(EntitiesDefinitionUri)) + { + writer.WritePropertyName("entitiesDefinitionUri"u8); + writer.WriteStringValue(EntitiesDefinitionUri); + } + if (Optional.IsCollectionDefined(InlineEntitiesDefinition)) + { + writer.WritePropertyName("inlineEntitiesDefinition"u8); + writer.WriteStartArray(); + foreach (var item in InlineEntitiesDefinition) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsDefined(GlobalDefaultCaseSensitive)) + { + writer.WritePropertyName("globalDefaultCaseSensitive"u8); + writer.WriteBooleanValue(GlobalDefaultCaseSensitive.Value); + } + if (Optional.IsDefined(GlobalDefaultAccentSensitive)) + { + writer.WritePropertyName("globalDefaultAccentSensitive"u8); + writer.WriteBooleanValue(GlobalDefaultAccentSensitive.Value); + } + if (Optional.IsDefined(GlobalDefaultFuzzyEditDistance)) + { + writer.WritePropertyName("globalDefaultFuzzyEditDistance"u8); + writer.WriteNumberValue(GlobalDefaultFuzzyEditDistance.Value); + } + } + + CustomEntityLookupSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CustomEntityLookupSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeCustomEntityLookupSkill(document.RootElement, options); + } + + internal static CustomEntityLookupSkill DeserializeCustomEntityLookupSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + CustomEntityLookupSkillLanguage? defaultLanguageCode = default; + string entitiesDefinitionUri = default; + IList inlineEntitiesDefinition = default; + bool? globalDefaultCaseSensitive = default; + bool? globalDefaultAccentSensitive = default; + int? globalDefaultFuzzyEditDistance = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("defaultLanguageCode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + defaultLanguageCode = new CustomEntityLookupSkillLanguage(property.Value.GetString()); + continue; + } + if (property.NameEquals("entitiesDefinitionUri"u8)) + { + entitiesDefinitionUri = property.Value.GetString(); + continue; + } + if (property.NameEquals("inlineEntitiesDefinition"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(CustomEntity.DeserializeCustomEntity(item, options)); + } + inlineEntitiesDefinition = array; + continue; + } + if (property.NameEquals("globalDefaultCaseSensitive"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + globalDefaultCaseSensitive = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("globalDefaultAccentSensitive"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + globalDefaultAccentSensitive = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("globalDefaultFuzzyEditDistance"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + globalDefaultFuzzyEditDistance = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new CustomEntityLookupSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + defaultLanguageCode, + entitiesDefinitionUri, + inlineEntitiesDefinition ?? new ChangeTrackingList(), + globalDefaultCaseSensitive, + globalDefaultAccentSensitive, + globalDefaultFuzzyEditDistance); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(CustomEntityLookupSkill)} does not support writing '{options.Format}' format."); + } + } + + CustomEntityLookupSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCustomEntityLookupSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(CustomEntityLookupSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new CustomEntityLookupSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCustomEntityLookupSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntityLookupSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntityLookupSkill.cs new file mode 100644 index 000000000000..82a8fffe4d81 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntityLookupSkill.cs @@ -0,0 +1,122 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// A skill looks for text from a custom, user-defined list of words and phrases. + public partial class CustomEntityLookupSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public CustomEntityLookupSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Text.CustomEntityLookupSkill"; + InlineEntitiesDefinition = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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. + /// + /// + /// A global flag for AccentSensitive. If AccentSensitive is not set in + /// CustomEntity, this value will be the default value. + /// + /// + /// A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in + /// CustomEntity, this value will be the default value. + /// + internal CustomEntityLookupSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData, CustomEntityLookupSkillLanguage? defaultLanguageCode, string entitiesDefinitionUri, IList inlineEntitiesDefinition, bool? globalDefaultCaseSensitive, bool? globalDefaultAccentSensitive, int? globalDefaultFuzzyEditDistance) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + DefaultLanguageCode = defaultLanguageCode; + EntitiesDefinitionUri = entitiesDefinitionUri; + InlineEntitiesDefinition = inlineEntitiesDefinition; + GlobalDefaultCaseSensitive = globalDefaultCaseSensitive; + GlobalDefaultAccentSensitive = globalDefaultAccentSensitive; + GlobalDefaultFuzzyEditDistance = globalDefaultFuzzyEditDistance; + } + + /// Initializes a new instance of for deserialization. + internal CustomEntityLookupSkill() + { + } + + /// A value indicating which language code to use. Default is `en`. + public CustomEntityLookupSkillLanguage? DefaultLanguageCode { get; set; } + /// + /// 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. + /// + public string EntitiesDefinitionUri { get; set; } + /// The inline CustomEntity definition. + public IList InlineEntitiesDefinition { get; } + /// + /// A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity, + /// this value will be the default value. + /// + public bool? GlobalDefaultCaseSensitive { get; set; } + /// + /// A global flag for AccentSensitive. If AccentSensitive is not set in + /// CustomEntity, this value will be the default value. + /// + public bool? GlobalDefaultAccentSensitive { get; set; } + /// + /// A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in + /// CustomEntity, this value will be the default value. + /// + public int? GlobalDefaultFuzzyEditDistance { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntityLookupSkillLanguage.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntityLookupSkillLanguage.cs new file mode 100644 index 000000000000..4bce91fbc882 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomEntityLookupSkillLanguage.cs @@ -0,0 +1,72 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The language codes supported for input text by CustomEntityLookupSkill. + public readonly partial struct CustomEntityLookupSkillLanguage : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public CustomEntityLookupSkillLanguage(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string DaValue = "da"; + private const string DeValue = "de"; + private const string EnValue = "en"; + private const string EsValue = "es"; + private const string FiValue = "fi"; + private const string FrValue = "fr"; + private const string ItValue = "it"; + private const string KoValue = "ko"; + private const string PtValue = "pt"; + + /// Danish. + public static CustomEntityLookupSkillLanguage Da { get; } = new CustomEntityLookupSkillLanguage(DaValue); + /// German. + public static CustomEntityLookupSkillLanguage De { get; } = new CustomEntityLookupSkillLanguage(DeValue); + /// English. + public static CustomEntityLookupSkillLanguage En { get; } = new CustomEntityLookupSkillLanguage(EnValue); + /// Spanish. + public static CustomEntityLookupSkillLanguage Es { get; } = new CustomEntityLookupSkillLanguage(EsValue); + /// Finnish. + public static CustomEntityLookupSkillLanguage Fi { get; } = new CustomEntityLookupSkillLanguage(FiValue); + /// French. + public static CustomEntityLookupSkillLanguage Fr { get; } = new CustomEntityLookupSkillLanguage(FrValue); + /// Italian. + public static CustomEntityLookupSkillLanguage It { get; } = new CustomEntityLookupSkillLanguage(ItValue); + /// Korean. + public static CustomEntityLookupSkillLanguage Ko { get; } = new CustomEntityLookupSkillLanguage(KoValue); + /// Portuguese. + public static CustomEntityLookupSkillLanguage Pt { get; } = new CustomEntityLookupSkillLanguage(PtValue); + /// Determines if two values are the same. + public static bool operator ==(CustomEntityLookupSkillLanguage left, CustomEntityLookupSkillLanguage right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(CustomEntityLookupSkillLanguage left, CustomEntityLookupSkillLanguage right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator CustomEntityLookupSkillLanguage(string value) => new CustomEntityLookupSkillLanguage(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is CustomEntityLookupSkillLanguage other && Equals(other); + /// + public bool Equals(CustomEntityLookupSkillLanguage other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomNormalizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomNormalizer.Serialization.cs new file mode 100644 index 000000000000..3d04a126fd4f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomNormalizer.Serialization.cs @@ -0,0 +1,182 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class CustomNormalizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CustomNormalizer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsCollectionDefined(TokenFilters)) + { + writer.WritePropertyName("tokenFilters"u8); + writer.WriteStartArray(); + foreach (var item in TokenFilters) + { + writer.WriteStringValue(item.ToString()); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(CharFilters)) + { + writer.WritePropertyName("charFilters"u8); + writer.WriteStartArray(); + foreach (var item in CharFilters) + { + writer.WriteStringValue(item.ToString()); + } + writer.WriteEndArray(); + } + } + + CustomNormalizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CustomNormalizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeCustomNormalizer(document.RootElement, options); + } + + internal static CustomNormalizer DeserializeCustomNormalizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList tokenFilters = default; + IList charFilters = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("tokenFilters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(new TokenFilterName(item.GetString())); + } + tokenFilters = array; + continue; + } + if (property.NameEquals("charFilters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(new CharFilterName(item.GetString())); + } + charFilters = array; + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new CustomNormalizer(odataType, name, serializedAdditionalRawData, tokenFilters ?? new ChangeTrackingList(), charFilters ?? new ChangeTrackingList()); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(CustomNormalizer)} does not support writing '{options.Format}' format."); + } + } + + CustomNormalizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCustomNormalizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(CustomNormalizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new CustomNormalizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCustomNormalizer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomNormalizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomNormalizer.cs new file mode 100644 index 000000000000..e76319e1228a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/CustomNormalizer.cs @@ -0,0 +1,79 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Allows you to configure normalization for filterable, sortable, and facetable + /// fields, which by default operate with strict matching. This is a user-defined + /// configuration consisting of at least one or more filters, which modify the + /// token that is stored. + /// + public partial class CustomNormalizer : LexicalNormalizer + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public CustomNormalizer(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.CustomNormalizer"; + TokenFilters = new ChangeTrackingList(); + CharFilters = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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. + /// + internal CustomNormalizer(string odataType, string name, IDictionary serializedAdditionalRawData, IList tokenFilters, IList charFilters) : base(odataType, name, serializedAdditionalRawData) + { + TokenFilters = tokenFilters; + CharFilters = charFilters; + } + + /// Initializes a new instance of for deserialization. + internal CustomNormalizer() + { + } + + /// + /// 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. + /// + public IList TokenFilters { get; } + /// + /// 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. + /// + public IList CharFilters { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataChangeDetectionPolicy.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataChangeDetectionPolicy.Serialization.cs new file mode 100644 index 000000000000..a54d8594dcca --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataChangeDetectionPolicy.Serialization.cs @@ -0,0 +1,134 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + [PersistableModelProxy(typeof(UnknownDataChangeDetectionPolicy))] + public partial class DataChangeDetectionPolicy : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DataChangeDetectionPolicy)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("@odata.type"u8); + writer.WriteStringValue(OdataType); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + DataChangeDetectionPolicy IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DataChangeDetectionPolicy)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeDataChangeDetectionPolicy(document.RootElement, options); + } + + internal static DataChangeDetectionPolicy DeserializeDataChangeDetectionPolicy(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("@odata.type", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy": return HighWaterMarkChangeDetectionPolicy.DeserializeHighWaterMarkChangeDetectionPolicy(element, options); + case "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy": return SqlIntegratedChangeTrackingPolicy.DeserializeSqlIntegratedChangeTrackingPolicy(element, options); + } + } + return UnknownDataChangeDetectionPolicy.DeserializeUnknownDataChangeDetectionPolicy(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(DataChangeDetectionPolicy)} does not support writing '{options.Format}' format."); + } + } + + DataChangeDetectionPolicy IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDataChangeDetectionPolicy(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(DataChangeDetectionPolicy)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static DataChangeDetectionPolicy FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDataChangeDetectionPolicy(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataChangeDetectionPolicy.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataChangeDetectionPolicy.cs new file mode 100644 index 000000000000..5d59be3d9979 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataChangeDetectionPolicy.cs @@ -0,0 +1,69 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Base type for data change detection policies. + /// 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 abstract partial class DataChangeDetectionPolicy + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + protected DataChangeDetectionPolicy() + { + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Keeps track of any properties unknown to the library. + internal DataChangeDetectionPolicy(string odataType, IDictionary serializedAdditionalRawData) + { + OdataType = odataType; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The discriminator for derived types. + internal string OdataType { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataDeletionDetectionPolicy.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataDeletionDetectionPolicy.Serialization.cs new file mode 100644 index 000000000000..3257d1b0ef9a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataDeletionDetectionPolicy.Serialization.cs @@ -0,0 +1,134 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + [PersistableModelProxy(typeof(UnknownDataDeletionDetectionPolicy))] + public partial class DataDeletionDetectionPolicy : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DataDeletionDetectionPolicy)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("@odata.type"u8); + writer.WriteStringValue(OdataType); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + DataDeletionDetectionPolicy IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DataDeletionDetectionPolicy)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeDataDeletionDetectionPolicy(document.RootElement, options); + } + + internal static DataDeletionDetectionPolicy DeserializeDataDeletionDetectionPolicy(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("@odata.type", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy": return NativeBlobSoftDeleteDeletionDetectionPolicy.DeserializeNativeBlobSoftDeleteDeletionDetectionPolicy(element, options); + case "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy": return SoftDeleteColumnDeletionDetectionPolicy.DeserializeSoftDeleteColumnDeletionDetectionPolicy(element, options); + } + } + return UnknownDataDeletionDetectionPolicy.DeserializeUnknownDataDeletionDetectionPolicy(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(DataDeletionDetectionPolicy)} does not support writing '{options.Format}' format."); + } + } + + DataDeletionDetectionPolicy IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDataDeletionDetectionPolicy(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(DataDeletionDetectionPolicy)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static DataDeletionDetectionPolicy FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDataDeletionDetectionPolicy(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataDeletionDetectionPolicy.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataDeletionDetectionPolicy.cs new file mode 100644 index 000000000000..1507dbc78e8b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataDeletionDetectionPolicy.cs @@ -0,0 +1,69 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Base type for data deletion detection policies. + /// 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 abstract partial class DataDeletionDetectionPolicy + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + protected DataDeletionDetectionPolicy() + { + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Keeps track of any properties unknown to the library. + internal DataDeletionDetectionPolicy(string odataType, IDictionary serializedAdditionalRawData) + { + OdataType = odataType; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The discriminator for derived types. + internal string OdataType { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataSourceCredentials.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataSourceCredentials.Serialization.cs new file mode 100644 index 000000000000..d17c1d4461c7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataSourceCredentials.Serialization.cs @@ -0,0 +1,145 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class DataSourceCredentials : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DataSourceCredentials)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(ConnectionString)) + { + writer.WritePropertyName("connectionString"u8); + writer.WriteStringValue(ConnectionString); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + DataSourceCredentials IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DataSourceCredentials)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeDataSourceCredentials(document.RootElement, options); + } + + internal static DataSourceCredentials DeserializeDataSourceCredentials(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string connectionString = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("connectionString"u8)) + { + connectionString = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new DataSourceCredentials(connectionString, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(DataSourceCredentials)} does not support writing '{options.Format}' format."); + } + } + + DataSourceCredentials IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDataSourceCredentials(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(DataSourceCredentials)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static DataSourceCredentials FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDataSourceCredentials(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataSourceCredentials.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataSourceCredentials.cs new file mode 100644 index 000000000000..d1db04bfb6b7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataSourceCredentials.cs @@ -0,0 +1,73 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents credentials that can be used to connect to a datasource. + public partial class DataSourceCredentials + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public DataSourceCredentials() + { + } + + /// Initializes a new instance of . + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal DataSourceCredentials(string connectionString, IDictionary serializedAdditionalRawData) + { + ConnectionString = connectionString; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// + /// 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.Indexes/src/Generated/DataSources.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataSources.cs new file mode 100644 index 000000000000..f38b8412dcc9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DataSources.cs @@ -0,0 +1,703 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading; +using System.Threading.Tasks; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Search.Documents.Indexes +{ + // Data plane generated sub-client. + /// The DataSources sub-client. + public partial class DataSources + { + private const string AuthorizationHeader = "api-key"; + private readonly AzureKeyCredential _keyCredential; + private static readonly string[] AuthorizationScopes = new string[] { "https://search.azure.com/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + private readonly string _apiVersion; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of DataSources for mocking. + protected DataSources() + { + } + + /// Initializes a new instance of DataSources. + /// The handler for diagnostic messaging in the client. + /// The HTTP pipeline for sending and receiving REST requests and responses. + /// The key credential to copy. + /// The token credential to copy. + /// Service host. + /// The API version to use for this operation. + internal DataSources(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, AzureKeyCredential keyCredential, TokenCredential tokenCredential, Uri endpoint, string apiVersion) + { + ClientDiagnostics = clientDiagnostics; + _pipeline = pipeline; + _keyCredential = keyCredential; + _tokenCredential = tokenCredential; + _endpoint = endpoint; + _apiVersion = apiVersion; + } + + /// Creates a new datasource or updates a datasource if it already exists. + /// The name of the datasource. + /// The definition of the datasource to create or update. + /// Ignores cache reset requirements. + /// The content to send as the request conditions of the request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> CreateOrUpdateAsync(string dataSourceName, SearchIndexerDataSource dataSource, bool? skipIndexerResetRequirementForCache = null, MatchConditions matchConditions = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNull(dataSource, nameof(dataSource)); + + using RequestContent content = dataSource.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await CreateOrUpdateAsync(dataSourceName, content, skipIndexerResetRequirementForCache, matchConditions, context).ConfigureAwait(false); + return Response.FromValue(SearchIndexerDataSource.FromResponse(response), response); + } + + /// Creates a new datasource or updates a datasource if it already exists. + /// The name of the datasource. + /// The definition of the datasource to create or update. + /// Ignores cache reset requirements. + /// The content to send as the request conditions of the request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response CreateOrUpdate(string dataSourceName, SearchIndexerDataSource dataSource, bool? skipIndexerResetRequirementForCache = null, MatchConditions matchConditions = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNull(dataSource, nameof(dataSource)); + + using RequestContent content = dataSource.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = CreateOrUpdate(dataSourceName, content, skipIndexerResetRequirementForCache, matchConditions, context); + return Response.FromValue(SearchIndexerDataSource.FromResponse(response), response); + } + + /// + /// [Protocol Method] Creates a new datasource or updates a datasource if it already exists. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the datasource. + /// The content to send as the body of the request. + /// Ignores cache reset requirements. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task CreateOrUpdateAsync(string dataSourceName, RequestContent content, bool? skipIndexerResetRequirementForCache = null, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("DataSources.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(dataSourceName, content, skipIndexerResetRequirementForCache, matchConditions, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Creates a new datasource or updates a datasource if it already exists. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the datasource. + /// The content to send as the body of the request. + /// Ignores cache reset requirements. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response CreateOrUpdate(string dataSourceName, RequestContent content, bool? skipIndexerResetRequirementForCache = null, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("DataSources.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(dataSourceName, content, skipIndexerResetRequirementForCache, matchConditions, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Deletes a datasource. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the datasource. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteAsync(string dataSourceName, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + + using var scope = ClientDiagnostics.CreateScope("DataSources.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(dataSourceName, matchConditions, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Deletes a datasource. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the datasource. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Delete(string dataSourceName, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + + using var scope = ClientDiagnostics.CreateScope("DataSources.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(dataSourceName, matchConditions, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Retrieves a datasource definition. + /// The name of the datasource. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> GetDataSourceAsync(string dataSourceName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await GetDataSourceAsync(dataSourceName, context).ConfigureAwait(false); + return Response.FromValue(SearchIndexerDataSource.FromResponse(response), response); + } + + /// Retrieves a datasource definition. + /// The name of the datasource. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response GetDataSource(string dataSourceName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = GetDataSource(dataSourceName, context); + return Response.FromValue(SearchIndexerDataSource.FromResponse(response), response); + } + + /// + /// [Protocol Method] Retrieves a datasource definition. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the datasource. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task GetDataSourceAsync(string dataSourceName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + + using var scope = ClientDiagnostics.CreateScope("DataSources.GetDataSource"); + scope.Start(); + try + { + using HttpMessage message = CreateGetDataSourceRequest(dataSourceName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Retrieves a datasource definition. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the datasource. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response GetDataSource(string dataSourceName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(dataSourceName, nameof(dataSourceName)); + + using var scope = ClientDiagnostics.CreateScope("DataSources.GetDataSource"); + scope.Start(); + try + { + using HttpMessage message = CreateGetDataSourceRequest(dataSourceName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Lists all datasources available for a search service. + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The cancellation token to use. + /// + public virtual async Task> GetDataSourcesAsync(string select = null, CancellationToken cancellationToken = default) + { + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await GetDataSourcesAsync(select, context).ConfigureAwait(false); + return Response.FromValue(ListDataSourcesResult.FromResponse(response), response); + } + + /// Lists all datasources available for a search service. + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The cancellation token to use. + /// + public virtual Response GetDataSources(string select = null, CancellationToken cancellationToken = default) + { + RequestContext context = FromCancellationToken(cancellationToken); + Response response = GetDataSources(select, context); + return Response.FromValue(ListDataSourcesResult.FromResponse(response), response); + } + + /// + /// [Protocol Method] Lists all datasources available for a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task GetDataSourcesAsync(string select, RequestContext context) + { + using var scope = ClientDiagnostics.CreateScope("DataSources.GetDataSources"); + scope.Start(); + try + { + using HttpMessage message = CreateGetDataSourcesRequest(select, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Lists all datasources available for a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response GetDataSources(string select, RequestContext context) + { + using var scope = ClientDiagnostics.CreateScope("DataSources.GetDataSources"); + scope.Start(); + try + { + using HttpMessage message = CreateGetDataSourcesRequest(select, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates a new datasource. + /// The definition of the datasource to create. + /// The cancellation token to use. + /// is null. + /// + public virtual async Task> CreateAsync(SearchIndexerDataSource dataSource, CancellationToken cancellationToken = default) + { + Argument.AssertNotNull(dataSource, nameof(dataSource)); + + using RequestContent content = dataSource.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await CreateAsync(content, context).ConfigureAwait(false); + return Response.FromValue(SearchIndexerDataSource.FromResponse(response), response); + } + + /// Creates a new datasource. + /// The definition of the datasource to create. + /// The cancellation token to use. + /// is null. + /// + public virtual Response Create(SearchIndexerDataSource dataSource, CancellationToken cancellationToken = default) + { + Argument.AssertNotNull(dataSource, nameof(dataSource)); + + using RequestContent content = dataSource.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = Create(content, context); + return Response.FromValue(SearchIndexerDataSource.FromResponse(response), response); + } + + /// + /// [Protocol Method] Creates a new datasource. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task CreateAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("DataSources.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Creates a new datasource. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Create(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("DataSources.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateCreateOrUpdateRequest(string dataSourceName, RequestContent content, bool? skipIndexerResetRequirementForCache, MatchConditions matchConditions, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200201); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/datasources('", false); + uri.AppendPath(dataSourceName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + if (skipIndexerResetRequirementForCache != null) + { + uri.AppendQuery("ignoreResetRequirements", skipIndexerResetRequirementForCache.Value, true); + } + request.Uri = uri; + request.Headers.Add("Prefer", "return=representation"); + request.Headers.Add("Accept", "application/json"); + if (matchConditions != null) + { + request.Headers.Add(matchConditions); + } + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteRequest(string dataSourceName, MatchConditions matchConditions, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204404); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/datasources('", false); + uri.AppendPath(dataSourceName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + if (matchConditions != null) + { + request.Headers.Add(matchConditions); + } + return message; + } + + internal HttpMessage CreateGetDataSourceRequest(string dataSourceName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/datasources('", false); + uri.AppendPath(dataSourceName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetDataSourcesRequest(string select, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/datasources", false); + uri.AppendQuery("api-version", _apiVersion, true); + if (select != null) + { + uri.AppendQuery("$select", select, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier201); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/datasources", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + private static RequestContext DefaultRequestContext = new RequestContext(); + internal static RequestContext FromCancellationToken(CancellationToken cancellationToken = default) + { + if (!cancellationToken.CanBeCanceled) + { + return DefaultRequestContext; + } + + return new RequestContext() { CancellationToken = cancellationToken }; + } + + private static ResponseClassifier _responseClassifier200201; + private static ResponseClassifier ResponseClassifier200201 => _responseClassifier200201 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 201 }); + private static ResponseClassifier _responseClassifier204404; + private static ResponseClassifier ResponseClassifier204404 => _responseClassifier204404 ??= new StatusCodeClassifier(stackalloc ushort[] { 204, 404 }); + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier201; + private static ResponseClassifier ResponseClassifier201 => _responseClassifier201 ??= new StatusCodeClassifier(stackalloc ushort[] { 201 }); + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DefaultCognitiveServicesAccount.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DefaultCognitiveServicesAccount.Serialization.cs new file mode 100644 index 000000000000..893830fc2066 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DefaultCognitiveServicesAccount.Serialization.cs @@ -0,0 +1,132 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class DefaultCognitiveServicesAccount : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DefaultCognitiveServicesAccount)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + DefaultCognitiveServicesAccount IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DefaultCognitiveServicesAccount)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeDefaultCognitiveServicesAccount(document.RootElement, options); + } + + internal static DefaultCognitiveServicesAccount DeserializeDefaultCognitiveServicesAccount(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = default; + string description = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new DefaultCognitiveServicesAccount(odataType, description, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(DefaultCognitiveServicesAccount)} does not support writing '{options.Format}' format."); + } + } + + DefaultCognitiveServicesAccount IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDefaultCognitiveServicesAccount(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(DefaultCognitiveServicesAccount)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new DefaultCognitiveServicesAccount FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDefaultCognitiveServicesAccount(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DefaultCognitiveServicesAccount.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DefaultCognitiveServicesAccount.cs new file mode 100644 index 000000000000..f81542255f3e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DefaultCognitiveServicesAccount.cs @@ -0,0 +1,33 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// An empty object that represents the default Azure AI service resource for a + /// skillset. + /// + public partial class DefaultCognitiveServicesAccount : CognitiveServicesAccount + { + /// Initializes a new instance of . + public DefaultCognitiveServicesAccount() + { + OdataType = "#Microsoft.Azure.Search.DefaultCognitiveServices"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Description of the Azure AI service resource attached to a skillset. + /// Keeps track of any properties unknown to the library. + internal DefaultCognitiveServicesAccount(string odataType, string description, IDictionary serializedAdditionalRawData) : base(odataType, description, serializedAdditionalRawData) + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DictionaryDecompounderTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DictionaryDecompounderTokenFilter.Serialization.cs new file mode 100644 index 000000000000..500dd60918d5 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DictionaryDecompounderTokenFilter.Serialization.cs @@ -0,0 +1,218 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class DictionaryDecompounderTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DictionaryDecompounderTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("wordList"u8); + writer.WriteStartArray(); + foreach (var item in WordList) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + if (Optional.IsDefined(MinWordSize)) + { + writer.WritePropertyName("minWordSize"u8); + writer.WriteNumberValue(MinWordSize.Value); + } + if (Optional.IsDefined(MinSubwordSize)) + { + writer.WritePropertyName("minSubwordSize"u8); + writer.WriteNumberValue(MinSubwordSize.Value); + } + if (Optional.IsDefined(MaxSubwordSize)) + { + writer.WritePropertyName("maxSubwordSize"u8); + writer.WriteNumberValue(MaxSubwordSize.Value); + } + if (Optional.IsDefined(OnlyLongestMatch)) + { + writer.WritePropertyName("onlyLongestMatch"u8); + writer.WriteBooleanValue(OnlyLongestMatch.Value); + } + } + + DictionaryDecompounderTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DictionaryDecompounderTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeDictionaryDecompounderTokenFilter(document.RootElement, options); + } + + internal static DictionaryDecompounderTokenFilter DeserializeDictionaryDecompounderTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList wordList = default; + int? minWordSize = default; + int? minSubwordSize = default; + int? maxSubwordSize = default; + bool? onlyLongestMatch = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("wordList"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + wordList = array; + continue; + } + if (property.NameEquals("minWordSize"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + minWordSize = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("minSubwordSize"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + minSubwordSize = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("maxSubwordSize"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxSubwordSize = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("onlyLongestMatch"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + onlyLongestMatch = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new DictionaryDecompounderTokenFilter( + odataType, + name, + serializedAdditionalRawData, + wordList, + minWordSize, + minSubwordSize, + maxSubwordSize, + onlyLongestMatch); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(DictionaryDecompounderTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + DictionaryDecompounderTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDictionaryDecompounderTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(DictionaryDecompounderTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new DictionaryDecompounderTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDictionaryDecompounderTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DictionaryDecompounderTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DictionaryDecompounderTokenFilter.cs new file mode 100644 index 000000000000..779460991c0d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DictionaryDecompounderTokenFilter.cs @@ -0,0 +1,99 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Decomposes compound words found in many Germanic languages. This token filter + /// is implemented using Apache Lucene. + /// + public partial class DictionaryDecompounderTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// or is null. + public DictionaryDecompounderTokenFilter(string name, IEnumerable wordList) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(wordList, nameof(wordList)); + + OdataType = "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter"; + WordList = wordList.ToList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// The list of words to match against. + /// + /// The minimum word size. Only words longer than this get processed. Default is 5. + /// Maximum is 300. + /// + /// + /// The minimum subword size. Only subwords longer than this are outputted. Default + /// is 2. Maximum is 300. + /// + /// + /// The maximum subword size. Only subwords shorter than this are outputted. + /// Default is 15. Maximum is 300. + /// + /// + /// A value indicating whether to add only the longest matching subword to the + /// output. Default is false. + /// + internal DictionaryDecompounderTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, IList wordList, int? minWordSize, int? minSubwordSize, int? maxSubwordSize, bool? onlyLongestMatch) : base(odataType, name, serializedAdditionalRawData) + { + WordList = wordList; + MinWordSize = minWordSize; + MinSubwordSize = minSubwordSize; + MaxSubwordSize = maxSubwordSize; + OnlyLongestMatch = onlyLongestMatch; + } + + /// Initializes a new instance of for deserialization. + internal DictionaryDecompounderTokenFilter() + { + } + + /// The list of words to match against. + public IList WordList { get; } + /// + /// The minimum word size. Only words longer than this get processed. Default is 5. + /// Maximum is 300. + /// + public int? MinWordSize { get; set; } + /// + /// The minimum subword size. Only subwords longer than this are outputted. Default + /// is 2. Maximum is 300. + /// + public int? MinSubwordSize { get; set; } + /// + /// The maximum subword size. Only subwords shorter than this are outputted. + /// Default is 15. Maximum is 300. + /// + public int? MaxSubwordSize { get; set; } + /// + /// A value indicating whether to add only the longest matching subword to the + /// output. Default is false. + /// + public bool? OnlyLongestMatch { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DistanceScoringFunction.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DistanceScoringFunction.Serialization.cs new file mode 100644 index 000000000000..e2aea6aeb8e8 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DistanceScoringFunction.Serialization.cs @@ -0,0 +1,162 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class DistanceScoringFunction : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DistanceScoringFunction)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("distance"u8); + writer.WriteObjectValue(Distance, options); + } + + DistanceScoringFunction IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DistanceScoringFunction)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeDistanceScoringFunction(document.RootElement, options); + } + + internal static DistanceScoringFunction DeserializeDistanceScoringFunction(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + DistanceScoringParameters distance = default; + string fieldName = default; + double boost = default; + ScoringFunctionInterpolation? interpolation = default; + string type = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("distance"u8)) + { + distance = DistanceScoringParameters.DeserializeDistanceScoringParameters(property.Value, options); + continue; + } + if (property.NameEquals("fieldName"u8)) + { + fieldName = property.Value.GetString(); + continue; + } + if (property.NameEquals("boost"u8)) + { + boost = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("interpolation"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + interpolation = new ScoringFunctionInterpolation(property.Value.GetString()); + continue; + } + if (property.NameEquals("type"u8)) + { + type = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new DistanceScoringFunction( + fieldName, + boost, + interpolation, + type, + serializedAdditionalRawData, + distance); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(DistanceScoringFunction)} does not support writing '{options.Format}' format."); + } + } + + DistanceScoringFunction IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDistanceScoringFunction(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(DistanceScoringFunction)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new DistanceScoringFunction FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDistanceScoringFunction(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DistanceScoringFunction.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DistanceScoringFunction.cs new file mode 100644 index 000000000000..6da34faeec93 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DistanceScoringFunction.cs @@ -0,0 +1,56 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Defines a function that boosts scores based on distance from a geographic + /// location. + /// + public partial class DistanceScoringFunction : ScoringFunction + { + /// Initializes a new instance of . + /// The name of the field used as input to the scoring function. + /// A multiplier for the raw score. Must be a positive number not equal to 1.0. + /// Parameter values for the distance scoring function. + /// or is null. + public DistanceScoringFunction(string fieldName, double boost, DistanceScoringParameters distance) : base(fieldName, boost) + { + Argument.AssertNotNull(fieldName, nameof(fieldName)); + Argument.AssertNotNull(distance, nameof(distance)); + + Type = "distance"; + Distance = distance; + } + + /// Initializes a new instance of . + /// The name of the field used as input to the scoring function. + /// A multiplier for the raw score. Must be a positive number not equal to 1.0. + /// + /// A value indicating how boosting will be interpolated across document scores; + /// defaults to "Linear". + /// + /// Type of ScoringFunction. + /// Keeps track of any properties unknown to the library. + /// Parameter values for the distance scoring function. + internal DistanceScoringFunction(string fieldName, double boost, ScoringFunctionInterpolation? interpolation, string type, IDictionary serializedAdditionalRawData, DistanceScoringParameters distance) : base(fieldName, boost, interpolation, type, serializedAdditionalRawData) + { + Distance = distance; + } + + /// Initializes a new instance of for deserialization. + internal DistanceScoringFunction() + { + } + + /// Parameter values for the distance scoring function. + public DistanceScoringParameters Distance { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DistanceScoringParameters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DistanceScoringParameters.Serialization.cs new file mode 100644 index 000000000000..59ed4d59cd4f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DistanceScoringParameters.Serialization.cs @@ -0,0 +1,150 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class DistanceScoringParameters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DistanceScoringParameters)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("referencePointParameter"u8); + writer.WriteStringValue(ReferencePointParameter); + writer.WritePropertyName("boostingDistance"u8); + writer.WriteNumberValue(BoostingDistance); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + DistanceScoringParameters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DistanceScoringParameters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeDistanceScoringParameters(document.RootElement, options); + } + + internal static DistanceScoringParameters DeserializeDistanceScoringParameters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string referencePointParameter = default; + double boostingDistance = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("referencePointParameter"u8)) + { + referencePointParameter = property.Value.GetString(); + continue; + } + if (property.NameEquals("boostingDistance"u8)) + { + boostingDistance = property.Value.GetDouble(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new DistanceScoringParameters(referencePointParameter, boostingDistance, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(DistanceScoringParameters)} does not support writing '{options.Format}' format."); + } + } + + DistanceScoringParameters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDistanceScoringParameters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(DistanceScoringParameters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static DistanceScoringParameters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDistanceScoringParameters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DistanceScoringParameters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DistanceScoringParameters.cs new file mode 100644 index 000000000000..d02828e97bf1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DistanceScoringParameters.cs @@ -0,0 +1,99 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Provides parameter values to a distance scoring function. + public partial class DistanceScoringParameters + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// The name of the parameter passed in search queries to specify the reference + /// location. + /// + /// + /// The distance in kilometers from the reference location where the boosting range + /// ends. + /// + /// is null. + public DistanceScoringParameters(string referencePointParameter, double boostingDistance) + { + Argument.AssertNotNull(referencePointParameter, nameof(referencePointParameter)); + + ReferencePointParameter = referencePointParameter; + BoostingDistance = boostingDistance; + } + + /// Initializes a new instance of . + /// + /// The name of the parameter passed in search queries to specify the reference + /// location. + /// + /// + /// The distance in kilometers from the reference location where the boosting range + /// ends. + /// + /// Keeps track of any properties unknown to the library. + internal DistanceScoringParameters(string referencePointParameter, double boostingDistance, IDictionary serializedAdditionalRawData) + { + ReferencePointParameter = referencePointParameter; + BoostingDistance = boostingDistance; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal DistanceScoringParameters() + { + } + + /// + /// The name of the parameter passed in search queries to specify the reference + /// location. + /// + public string ReferencePointParameter { get; set; } + /// + /// The distance in kilometers from the reference location where the boosting range + /// ends. + /// + public double BoostingDistance { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/Aliases.xml b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/Aliases.xml new file mode 100644 index 000000000000..5b57dd3b7197 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/Aliases.xml @@ -0,0 +1,297 @@ + + + + + +This sample shows how to call CreateAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +SearchAlias @alias = new SearchAlias("tempalias", new string[] { "preview-test" }) +{ + ETag = "0x1234568AE7E58A1", +}; +Response response = await client.CreateAsync(@alias); +]]> + + + +This sample shows how to call Create. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +SearchAlias @alias = new SearchAlias("tempalias", new string[] { "preview-test" }) +{ + ETag = "0x1234568AE7E58A1", +}; +Response response = client.Create(@alias); +]]> + + + +This sample shows how to call CreateAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "tempalias", + ["indexes"] = new object[] + { + "preview-test" + }, + ["@odata.etag"] = "0x1234568AE7E58A1" +}); +Response response = await client.CreateAsync(content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("indexes")[0].ToString()); +]]> + + + +This sample shows how to call Create and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "tempalias", + ["indexes"] = new object[] + { + "preview-test" + }, + ["@odata.etag"] = "0x1234568AE7E58A1" +}); +Response response = client.Create(content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("indexes")[0].ToString()); +]]> + + + +This sample shows how to call CreateOrUpdateAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +SearchAlias @alias = new SearchAlias("myalias", new string[] { "preview-test" }) +{ + ETag = "0x1234568AE7E58A1", +}; +Response response = await client.CreateOrUpdateAsync("myalias", @alias); +]]> + + + +This sample shows how to call CreateOrUpdate. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +SearchAlias @alias = new SearchAlias("myalias", new string[] { "preview-test" }) +{ + ETag = "0x1234568AE7E58A1", +}; +Response response = client.CreateOrUpdate("myalias", @alias); +]]> + + + +This sample shows how to call CreateOrUpdateAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "myalias", + ["indexes"] = new object[] + { + "preview-test" + }, + ["@odata.etag"] = "0x1234568AE7E58A1" +}); +Response response = await client.CreateOrUpdateAsync("myalias", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("indexes")[0].ToString()); +]]> + + + +This sample shows how to call CreateOrUpdate and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "myalias", + ["indexes"] = new object[] + { + "preview-test" + }, + ["@odata.etag"] = "0x1234568AE7E58A1" +}); +Response response = client.CreateOrUpdate("myalias", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("indexes")[0].ToString()); +]]> + + + +This sample shows how to call DeleteAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +Response response = await client.DeleteAsync("tempalias"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call Delete. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +Response response = client.Delete("tempalias"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call GetAliasAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +Response response = await client.GetAliasAsync("myalias"); +]]> + + + +This sample shows how to call GetAlias. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +Response response = client.GetAlias("myalias"); +]]> + + + +This sample shows how to call GetAliasAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +Response response = await client.GetAliasAsync("myalias", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("indexes")[0].ToString()); +]]> + + + +This sample shows how to call GetAlias and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +Response response = client.GetAlias("myalias", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("indexes")[0].ToString()); +]]> + + + +This sample shows how to call GetAliasesAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +await foreach (SearchAlias item in client.GetAliasesAsync()) +{ +} +]]> + + + +This sample shows how to call GetAliases. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +foreach (SearchAlias item in client.GetAliases()) +{ +} +]]> + + + +This sample shows how to call GetAliasesAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +await foreach (BinaryData item in client.GetAliasesAsync(null)) +{ + JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("indexes")[0].ToString()); +} +]]> + + + +This sample shows how to call GetAliases and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + +foreach (BinaryData item in client.GetAliases(null)) +{ + JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("indexes")[0].ToString()); +} +]]> + + + \ No newline at end of file diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/DataSources.xml b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/DataSources.xml new file mode 100644 index 000000000000..aec641079ced --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/DataSources.xml @@ -0,0 +1,527 @@ + + + + + +This sample shows how to call CreateOrUpdateAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +SearchIndexerDataSource dataSource = new SearchIndexerDataSource("tempdatasource", SearchIndexerDataSourceType.AzureBlob, new DataSourceCredentials +{ + ConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", +}, new SearchIndexerDataContainer("doc-extraction-skillset") +{ + Query = "E2E_Dsat", +}) +{ + Description = "My Azure Blob data source.", + Identity = new SearchIndexerDataNoneIdentity(), + DataChangeDetectionPolicy = new HighWaterMarkChangeDetectionPolicy("metadata_storage_last_modified"), + DataDeletionDetectionPolicy = new SoftDeleteColumnDeletionDetectionPolicy + { + SoftDeleteColumnName = "isDeleted", + SoftDeleteMarkerValue = "true", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, +}; +Response response = await client.CreateOrUpdateAsync("tempdatasource", dataSource); +]]> + + + +This sample shows how to call CreateOrUpdate. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +SearchIndexerDataSource dataSource = new SearchIndexerDataSource("tempdatasource", SearchIndexerDataSourceType.AzureBlob, new DataSourceCredentials +{ + ConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", +}, new SearchIndexerDataContainer("doc-extraction-skillset") +{ + Query = "E2E_Dsat", +}) +{ + Description = "My Azure Blob data source.", + Identity = new SearchIndexerDataNoneIdentity(), + DataChangeDetectionPolicy = new HighWaterMarkChangeDetectionPolicy("metadata_storage_last_modified"), + DataDeletionDetectionPolicy = new SoftDeleteColumnDeletionDetectionPolicy + { + SoftDeleteColumnName = "isDeleted", + SoftDeleteMarkerValue = "true", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, +}; +Response response = client.CreateOrUpdate("tempdatasource", dataSource); +]]> + + + +This sample shows how to call CreateOrUpdateAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "tempdatasource", + ["description"] = "My Azure Blob data source.", + ["type"] = "azureblob", + ["credentials"] = new + { + connectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + }, + ["container"] = new + { + name = "doc-extraction-skillset", + query = "E2E_Dsat", + }, + ["identity"] = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + ["dataChangeDetectionPolicy"] = new Dictionary + { + ["highWaterMarkColumnName"] = "metadata_storage_last_modified", + ["@odata.type"] = "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy" + }, + ["dataDeletionDetectionPolicy"] = new Dictionary + { + ["softDeleteColumnName"] = "isDeleted", + ["softDeleteMarkerValue"] = "true", + ["@odata.type"] = "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } +}); +Response response = await client.CreateOrUpdateAsync("tempdatasource", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("credentials").ToString()); +Console.WriteLine(result.GetProperty("container").GetProperty("name").ToString()); +]]> + + + +This sample shows how to call CreateOrUpdate and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "tempdatasource", + ["description"] = "My Azure Blob data source.", + ["type"] = "azureblob", + ["credentials"] = new + { + connectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + }, + ["container"] = new + { + name = "doc-extraction-skillset", + query = "E2E_Dsat", + }, + ["identity"] = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + ["dataChangeDetectionPolicy"] = new Dictionary + { + ["highWaterMarkColumnName"] = "metadata_storage_last_modified", + ["@odata.type"] = "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy" + }, + ["dataDeletionDetectionPolicy"] = new Dictionary + { + ["softDeleteColumnName"] = "isDeleted", + ["softDeleteMarkerValue"] = "true", + ["@odata.type"] = "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } +}); +Response response = client.CreateOrUpdate("tempdatasource", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("credentials").ToString()); +Console.WriteLine(result.GetProperty("container").GetProperty("name").ToString()); +]]> + + + +This sample shows how to call DeleteAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +Response response = await client.DeleteAsync("tempdatasource"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call Delete. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +Response response = client.Delete("tempdatasource"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call GetDataSourceAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +Response response = await client.GetDataSourceAsync("mydocdbdatasource"); +]]> + + + +This sample shows how to call GetDataSource. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +Response response = client.GetDataSource("mydocdbdatasource"); +]]> + + + +This sample shows how to call GetDataSourceAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +Response response = await client.GetDataSourceAsync("mydocdbdatasource", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("credentials").ToString()); +Console.WriteLine(result.GetProperty("container").GetProperty("name").ToString()); +]]> + + + +This sample shows how to call GetDataSource and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +Response response = client.GetDataSource("mydocdbdatasource", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("credentials").ToString()); +Console.WriteLine(result.GetProperty("container").GetProperty("name").ToString()); +]]> + + + +This sample shows how to call GetDataSourcesAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +Response response = await client.GetDataSourcesAsync(); +]]> + + + +This sample shows how to call GetDataSources. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +Response response = client.GetDataSources(); +]]> + + + +This sample shows how to call GetDataSourcesAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +Response response = await client.GetDataSourcesAsync(null, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("credentials").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("container").GetProperty("name").ToString()); +]]> + + + +This sample shows how to call GetDataSources and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +Response response = client.GetDataSources(null, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("credentials").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("container").GetProperty("name").ToString()); +]]> + + + +This sample shows how to call CreateAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +SearchIndexerDataSource dataSource = new SearchIndexerDataSource("tempdatasource", SearchIndexerDataSourceType.AzureBlob, new DataSourceCredentials +{ + ConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", +}, new SearchIndexerDataContainer("doc-extraction-skillset") +{ + Query = "E2E_Dsat", +}) +{ + Description = "My Azure Blob data source.", + Identity = new SearchIndexerDataNoneIdentity(), + DataChangeDetectionPolicy = new HighWaterMarkChangeDetectionPolicy("metadata_storage_last_modified"), + DataDeletionDetectionPolicy = new SoftDeleteColumnDeletionDetectionPolicy + { + SoftDeleteColumnName = "isDeleted", + SoftDeleteMarkerValue = "true", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, +}; +Response response = await client.CreateAsync(dataSource); +]]> + + + +This sample shows how to call Create. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +SearchIndexerDataSource dataSource = new SearchIndexerDataSource("tempdatasource", SearchIndexerDataSourceType.AzureBlob, new DataSourceCredentials +{ + ConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", +}, new SearchIndexerDataContainer("doc-extraction-skillset") +{ + Query = "E2E_Dsat", +}) +{ + Description = "My Azure Blob data source.", + Identity = new SearchIndexerDataNoneIdentity(), + DataChangeDetectionPolicy = new HighWaterMarkChangeDetectionPolicy("metadata_storage_last_modified"), + DataDeletionDetectionPolicy = new SoftDeleteColumnDeletionDetectionPolicy + { + SoftDeleteColumnName = "isDeleted", + SoftDeleteMarkerValue = "true", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, +}; +Response response = client.Create(dataSource); +]]> + + + +This sample shows how to call CreateAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "tempdatasource", + ["description"] = "My Azure Blob data source.", + ["type"] = "azureblob", + ["credentials"] = new + { + connectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + }, + ["container"] = new + { + name = "doc-extraction-skillset", + query = "E2E_Dsat", + }, + ["identity"] = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + ["dataChangeDetectionPolicy"] = new Dictionary + { + ["highWaterMarkColumnName"] = "metadata_storage_last_modified", + ["@odata.type"] = "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy" + }, + ["dataDeletionDetectionPolicy"] = new Dictionary + { + ["softDeleteColumnName"] = "isDeleted", + ["softDeleteMarkerValue"] = "true", + ["@odata.type"] = "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } +}); +Response response = await client.CreateAsync(content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("credentials").ToString()); +Console.WriteLine(result.GetProperty("container").GetProperty("name").ToString()); +]]> + + + +This sample shows how to call Create and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "tempdatasource", + ["description"] = "My Azure Blob data source.", + ["type"] = "azureblob", + ["credentials"] = new + { + connectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + }, + ["container"] = new + { + name = "doc-extraction-skillset", + query = "E2E_Dsat", + }, + ["identity"] = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + ["dataChangeDetectionPolicy"] = new Dictionary + { + ["highWaterMarkColumnName"] = "metadata_storage_last_modified", + ["@odata.type"] = "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy" + }, + ["dataDeletionDetectionPolicy"] = new Dictionary + { + ["softDeleteColumnName"] = "isDeleted", + ["softDeleteMarkerValue"] = "true", + ["@odata.type"] = "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } +}); +Response response = client.Create(content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("type").ToString()); +Console.WriteLine(result.GetProperty("credentials").ToString()); +Console.WriteLine(result.GetProperty("container").GetProperty("name").ToString()); +]]> + + + \ No newline at end of file diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/Indexers.xml b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/Indexers.xml new file mode 100644 index 000000000000..1f104467c0f0 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/Indexers.xml @@ -0,0 +1,983 @@ + + + + + +This sample shows how to call ResetAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = await client.ResetAsync("myindexer"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call Reset. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = client.Reset("myindexer"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call ResetDocsAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = await client.ResetDocsAsync("myindexer"); +]]> + + + +This sample shows how to call ResetDocs. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = client.ResetDocs("myindexer"); +]]> + + + +This sample shows how to call ResetDocsAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +using RequestContent content = RequestContent.Create(new +{ + documentKeys = new object[] + { + "1", + "2", + "3" + }, +}); +Response response = await client.ResetDocsAsync("myindexer", content); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call ResetDocs. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +using RequestContent content = RequestContent.Create(new +{ + documentKeys = new object[] + { + "1", + "2", + "3" + }, +}); +Response response = client.ResetDocs("myindexer", content); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call RunAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = await client.RunAsync("myindexer"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call Run. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = client.Run("myindexer"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call CreateOrUpdateAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +SearchIndexer indexer = new SearchIndexer("myindexer", "mydocdbdatasource", "preview-test") +{ + Description = "Description of the indexer", + SkillsetName = "myskillset", + Schedule = new IndexingSchedule(XmlConvert.ToTimeSpan("P1D")) + { + StartTime = DateTimeOffset.Parse("2025-01-07T19:30:00Z"), + }, + Parameters = new IndexingParameters + { + BatchSize = 10, + MaxFailedItems = 10, + MaxFailedItemsPerBatch = 5, + Configuration = new IndexingParametersConfiguration + { + ParsingMode = BlobIndexerParsingMode.Markdown, + ExcludedFileNameExtensions = ".png,.mp4", + IndexedFileNameExtensions = ".docx,.pptx", + FailOnUnsupportedContentType = true, + FailOnUnprocessableDocument = false, + IndexStorageMetadataOnlyForOversizedDocuments = true, + DelimitedTextHeaders = "Header1,Header2", + DelimitedTextDelimiter = "|", + FirstLineContainsHeaders = true, + MarkdownParsingSubmode = MarkdownParsingSubmode.OneToOne, + MarkdownHeaderDepth = MarkdownHeaderDepth.H6, + DocumentRoot = "/root", + DataToExtract = BlobIndexerDataToExtract.StorageMetadata, + ImageAction = BlobIndexerImageAction.None, + AllowSkillsetToReadFileData = false, + PdfTextRotationAlgorithm = BlobIndexerPDFTextRotationAlgorithm.None, + ExecutionEnvironment = IndexerExecutionEnvironment.Standard, + }, + }, + FieldMappings = {new FieldMapping("/document") + { + TargetFieldName = "name", + MappingFunction = new FieldMappingFunction("base64Encode"), + }}, + OutputFieldMappings = {new FieldMapping("/document") + { + TargetFieldName = "name", + MappingFunction = new FieldMappingFunction("base64Encode"), + }}, + Disabled = false, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, +}; +Response response = await client.CreateOrUpdateAsync("myindexer", indexer); +]]> + + + +This sample shows how to call CreateOrUpdate. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +SearchIndexer indexer = new SearchIndexer("myindexer", "mydocdbdatasource", "preview-test") +{ + Description = "Description of the indexer", + SkillsetName = "myskillset", + Schedule = new IndexingSchedule(XmlConvert.ToTimeSpan("P1D")) + { + StartTime = DateTimeOffset.Parse("2025-01-07T19:30:00Z"), + }, + Parameters = new IndexingParameters + { + BatchSize = 10, + MaxFailedItems = 10, + MaxFailedItemsPerBatch = 5, + Configuration = new IndexingParametersConfiguration + { + ParsingMode = BlobIndexerParsingMode.Markdown, + ExcludedFileNameExtensions = ".png,.mp4", + IndexedFileNameExtensions = ".docx,.pptx", + FailOnUnsupportedContentType = true, + FailOnUnprocessableDocument = false, + IndexStorageMetadataOnlyForOversizedDocuments = true, + DelimitedTextHeaders = "Header1,Header2", + DelimitedTextDelimiter = "|", + FirstLineContainsHeaders = true, + MarkdownParsingSubmode = MarkdownParsingSubmode.OneToOne, + MarkdownHeaderDepth = MarkdownHeaderDepth.H6, + DocumentRoot = "/root", + DataToExtract = BlobIndexerDataToExtract.StorageMetadata, + ImageAction = BlobIndexerImageAction.None, + AllowSkillsetToReadFileData = false, + PdfTextRotationAlgorithm = BlobIndexerPDFTextRotationAlgorithm.None, + ExecutionEnvironment = IndexerExecutionEnvironment.Standard, + }, + }, + FieldMappings = {new FieldMapping("/document") + { + TargetFieldName = "name", + MappingFunction = new FieldMappingFunction("base64Encode"), + }}, + OutputFieldMappings = {new FieldMapping("/document") + { + TargetFieldName = "name", + MappingFunction = new FieldMappingFunction("base64Encode"), + }}, + Disabled = false, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, +}; +Response response = client.CreateOrUpdate("myindexer", indexer); +]]> + + + +This sample shows how to call CreateOrUpdateAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "myindexer", + ["description"] = "Description of the indexer", + ["dataSourceName"] = "mydocdbdatasource", + ["skillsetName"] = "myskillset", + ["targetIndexName"] = "preview-test", + ["schedule"] = new + { + interval = "P1D", + startTime = "2025-01-07T19:30:00Z", + }, + ["parameters"] = new + { + batchSize = 10, + maxFailedItems = 10, + maxFailedItemsPerBatch = 5, + configuration = new + { + parsingMode = "markdown", + excludedFileNameExtensions = ".png,.mp4", + indexedFileNameExtensions = ".docx,.pptx", + failOnUnsupportedContentType = true, + failOnUnprocessableDocument = false, + indexStorageMetadataOnlyForOversizedDocuments = true, + delimitedTextHeaders = "Header1,Header2", + delimitedTextDelimiter = "|", + firstLineContainsHeaders = true, + markdownParsingSubmode = "oneToOne", + markdownHeaderDepth = "h6", + documentRoot = "/root", + dataToExtract = "storageMetadata", + imageAction = "none", + allowSkillsetToReadFileData = false, + pdfTextRotationAlgorithm = "none", + executionEnvironment = "standard", + }, + }, + ["fieldMappings"] = new object[] + { + new + { + sourceFieldName = "/document", + targetFieldName = "name", + mappingFunction = new + { + name = "base64Encode", + }, + } + }, + ["outputFieldMappings"] = new object[] + { + new + { + sourceFieldName = "/document", + targetFieldName = "name", + mappingFunction = new + { + name = "base64Encode", + }, + } + }, + ["disabled"] = false, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } +}); +Response response = await client.CreateOrUpdateAsync("myindexer", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("dataSourceName").ToString()); +Console.WriteLine(result.GetProperty("targetIndexName").ToString()); +]]> + + + +This sample shows how to call CreateOrUpdate and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "myindexer", + ["description"] = "Description of the indexer", + ["dataSourceName"] = "mydocdbdatasource", + ["skillsetName"] = "myskillset", + ["targetIndexName"] = "preview-test", + ["schedule"] = new + { + interval = "P1D", + startTime = "2025-01-07T19:30:00Z", + }, + ["parameters"] = new + { + batchSize = 10, + maxFailedItems = 10, + maxFailedItemsPerBatch = 5, + configuration = new + { + parsingMode = "markdown", + excludedFileNameExtensions = ".png,.mp4", + indexedFileNameExtensions = ".docx,.pptx", + failOnUnsupportedContentType = true, + failOnUnprocessableDocument = false, + indexStorageMetadataOnlyForOversizedDocuments = true, + delimitedTextHeaders = "Header1,Header2", + delimitedTextDelimiter = "|", + firstLineContainsHeaders = true, + markdownParsingSubmode = "oneToOne", + markdownHeaderDepth = "h6", + documentRoot = "/root", + dataToExtract = "storageMetadata", + imageAction = "none", + allowSkillsetToReadFileData = false, + pdfTextRotationAlgorithm = "none", + executionEnvironment = "standard", + }, + }, + ["fieldMappings"] = new object[] + { + new + { + sourceFieldName = "/document", + targetFieldName = "name", + mappingFunction = new + { + name = "base64Encode", + }, + } + }, + ["outputFieldMappings"] = new object[] + { + new + { + sourceFieldName = "/document", + targetFieldName = "name", + mappingFunction = new + { + name = "base64Encode", + }, + } + }, + ["disabled"] = false, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } +}); +Response response = client.CreateOrUpdate("myindexer", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("dataSourceName").ToString()); +Console.WriteLine(result.GetProperty("targetIndexName").ToString()); +]]> + + + +This sample shows how to call DeleteAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = await client.DeleteAsync("tempindexer"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call Delete. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = client.Delete("tempindexer"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call GetIndexerAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = await client.GetIndexerAsync("myindexer"); +]]> + + + +This sample shows how to call GetIndexer. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = client.GetIndexer("myindexer"); +]]> + + + +This sample shows how to call GetIndexerAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = await client.GetIndexerAsync("myindexer", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("dataSourceName").ToString()); +Console.WriteLine(result.GetProperty("targetIndexName").ToString()); +]]> + + + +This sample shows how to call GetIndexer and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = client.GetIndexer("myindexer", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("dataSourceName").ToString()); +Console.WriteLine(result.GetProperty("targetIndexName").ToString()); +]]> + + + +This sample shows how to call GetIndexersAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = await client.GetIndexersAsync(); +]]> + + + +This sample shows how to call GetIndexers. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = client.GetIndexers(); +]]> + + + +This sample shows how to call GetIndexersAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = await client.GetIndexersAsync("*", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("dataSourceName").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("targetIndexName").ToString()); +]]> + + + +This sample shows how to call GetIndexers and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = client.GetIndexers("*", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("dataSourceName").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("targetIndexName").ToString()); +]]> + + + +This sample shows how to call CreateAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +SearchIndexer indexer = new SearchIndexer("myindexer", "mydocdbdatasource", "preview-test") +{ + Description = "Description of the indexer", + SkillsetName = "myskillset", + Schedule = new IndexingSchedule(XmlConvert.ToTimeSpan("P1D")) + { + StartTime = DateTimeOffset.Parse("2025-01-07T19:30:00Z"), + }, + Parameters = new IndexingParameters + { + BatchSize = 10, + MaxFailedItems = 10, + MaxFailedItemsPerBatch = 5, + Configuration = new IndexingParametersConfiguration + { + ParsingMode = BlobIndexerParsingMode.Markdown, + ExcludedFileNameExtensions = ".png,.mp4", + IndexedFileNameExtensions = ".docx,.pptx", + FailOnUnsupportedContentType = true, + FailOnUnprocessableDocument = false, + IndexStorageMetadataOnlyForOversizedDocuments = true, + DelimitedTextHeaders = "Header1,Header2", + DelimitedTextDelimiter = "|", + FirstLineContainsHeaders = true, + MarkdownParsingSubmode = MarkdownParsingSubmode.OneToMany, + MarkdownHeaderDepth = MarkdownHeaderDepth.H6, + DocumentRoot = "/root", + DataToExtract = BlobIndexerDataToExtract.StorageMetadata, + ImageAction = BlobIndexerImageAction.None, + AllowSkillsetToReadFileData = false, + PdfTextRotationAlgorithm = BlobIndexerPDFTextRotationAlgorithm.None, + ExecutionEnvironment = IndexerExecutionEnvironment.Standard, + }, + }, + FieldMappings = {new FieldMapping("/document") + { + TargetFieldName = "name", + MappingFunction = new FieldMappingFunction("base64Encode"), + }}, + OutputFieldMappings = {new FieldMapping("/document") + { + TargetFieldName = "name", + MappingFunction = new FieldMappingFunction("base64Encode"), + }}, + Disabled = false, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + Cache = new SearchIndexerCache + { + StorageConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + EnableReprocessing = true, + Identity = new SearchIndexerDataNoneIdentity(), + }, +}; +Response response = await client.CreateAsync(indexer); +]]> + + + +This sample shows how to call Create. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +SearchIndexer indexer = new SearchIndexer("myindexer", "mydocdbdatasource", "preview-test") +{ + Description = "Description of the indexer", + SkillsetName = "myskillset", + Schedule = new IndexingSchedule(XmlConvert.ToTimeSpan("P1D")) + { + StartTime = DateTimeOffset.Parse("2025-01-07T19:30:00Z"), + }, + Parameters = new IndexingParameters + { + BatchSize = 10, + MaxFailedItems = 10, + MaxFailedItemsPerBatch = 5, + Configuration = new IndexingParametersConfiguration + { + ParsingMode = BlobIndexerParsingMode.Markdown, + ExcludedFileNameExtensions = ".png,.mp4", + IndexedFileNameExtensions = ".docx,.pptx", + FailOnUnsupportedContentType = true, + FailOnUnprocessableDocument = false, + IndexStorageMetadataOnlyForOversizedDocuments = true, + DelimitedTextHeaders = "Header1,Header2", + DelimitedTextDelimiter = "|", + FirstLineContainsHeaders = true, + MarkdownParsingSubmode = MarkdownParsingSubmode.OneToMany, + MarkdownHeaderDepth = MarkdownHeaderDepth.H6, + DocumentRoot = "/root", + DataToExtract = BlobIndexerDataToExtract.StorageMetadata, + ImageAction = BlobIndexerImageAction.None, + AllowSkillsetToReadFileData = false, + PdfTextRotationAlgorithm = BlobIndexerPDFTextRotationAlgorithm.None, + ExecutionEnvironment = IndexerExecutionEnvironment.Standard, + }, + }, + FieldMappings = {new FieldMapping("/document") + { + TargetFieldName = "name", + MappingFunction = new FieldMappingFunction("base64Encode"), + }}, + OutputFieldMappings = {new FieldMapping("/document") + { + TargetFieldName = "name", + MappingFunction = new FieldMappingFunction("base64Encode"), + }}, + Disabled = false, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + Cache = new SearchIndexerCache + { + StorageConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + EnableReprocessing = true, + Identity = new SearchIndexerDataNoneIdentity(), + }, +}; +Response response = client.Create(indexer); +]]> + + + +This sample shows how to call CreateAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "myindexer", + ["description"] = "Description of the indexer", + ["dataSourceName"] = "mydocdbdatasource", + ["skillsetName"] = "myskillset", + ["targetIndexName"] = "preview-test", + ["schedule"] = new + { + interval = "P1D", + startTime = "2025-01-07T19:30:00Z", + }, + ["parameters"] = new + { + batchSize = 10, + maxFailedItems = 10, + maxFailedItemsPerBatch = 5, + configuration = new + { + parsingMode = "markdown", + excludedFileNameExtensions = ".png,.mp4", + indexedFileNameExtensions = ".docx,.pptx", + failOnUnsupportedContentType = true, + failOnUnprocessableDocument = false, + indexStorageMetadataOnlyForOversizedDocuments = true, + delimitedTextHeaders = "Header1,Header2", + delimitedTextDelimiter = "|", + firstLineContainsHeaders = true, + markdownParsingSubmode = "oneToMany", + markdownHeaderDepth = "h6", + documentRoot = "/root", + dataToExtract = "storageMetadata", + imageAction = "none", + allowSkillsetToReadFileData = false, + pdfTextRotationAlgorithm = "none", + executionEnvironment = "standard", + }, + }, + ["fieldMappings"] = new object[] + { + new + { + sourceFieldName = "/document", + targetFieldName = "name", + mappingFunction = new + { + name = "base64Encode", + }, + } + }, + ["outputFieldMappings"] = new object[] + { + new + { + sourceFieldName = "/document", + targetFieldName = "name", + mappingFunction = new + { + name = "base64Encode", + }, + } + }, + ["disabled"] = false, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + }, + ["cache"] = new + { + storageConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + enableReprocessing = true, + identity = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + } +}); +Response response = await client.CreateAsync(content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("dataSourceName").ToString()); +Console.WriteLine(result.GetProperty("targetIndexName").ToString()); +]]> + + + +This sample shows how to call Create and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "myindexer", + ["description"] = "Description of the indexer", + ["dataSourceName"] = "mydocdbdatasource", + ["skillsetName"] = "myskillset", + ["targetIndexName"] = "preview-test", + ["schedule"] = new + { + interval = "P1D", + startTime = "2025-01-07T19:30:00Z", + }, + ["parameters"] = new + { + batchSize = 10, + maxFailedItems = 10, + maxFailedItemsPerBatch = 5, + configuration = new + { + parsingMode = "markdown", + excludedFileNameExtensions = ".png,.mp4", + indexedFileNameExtensions = ".docx,.pptx", + failOnUnsupportedContentType = true, + failOnUnprocessableDocument = false, + indexStorageMetadataOnlyForOversizedDocuments = true, + delimitedTextHeaders = "Header1,Header2", + delimitedTextDelimiter = "|", + firstLineContainsHeaders = true, + markdownParsingSubmode = "oneToMany", + markdownHeaderDepth = "h6", + documentRoot = "/root", + dataToExtract = "storageMetadata", + imageAction = "none", + allowSkillsetToReadFileData = false, + pdfTextRotationAlgorithm = "none", + executionEnvironment = "standard", + }, + }, + ["fieldMappings"] = new object[] + { + new + { + sourceFieldName = "/document", + targetFieldName = "name", + mappingFunction = new + { + name = "base64Encode", + }, + } + }, + ["outputFieldMappings"] = new object[] + { + new + { + sourceFieldName = "/document", + targetFieldName = "name", + mappingFunction = new + { + name = "base64Encode", + }, + } + }, + ["disabled"] = false, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + }, + ["cache"] = new + { + storageConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + enableReprocessing = true, + identity = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + } +}); +Response response = client.Create(content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("dataSourceName").ToString()); +Console.WriteLine(result.GetProperty("targetIndexName").ToString()); +]]> + + + +This sample shows how to call GetStatusAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = await client.GetStatusAsync("myindexer"); +]]> + + + +This sample shows how to call GetStatus. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = client.GetStatus("myindexer"); +]]> + + + +This sample shows how to call GetStatusAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = await client.GetStatusAsync("myindexer", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("errors")[0].GetProperty("errorMessage").ToString()); +Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("errors")[0].GetProperty("statusCode").ToString()); +Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("warnings")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("itemsProcessed").ToString()); +Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("itemsFailed").ToString()); +Console.WriteLine(result.GetProperty("limits").ToString()); +]]> + + + +This sample shows how to call GetStatus and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + +Response response = client.GetStatus("myindexer", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("errors")[0].GetProperty("errorMessage").ToString()); +Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("errors")[0].GetProperty("statusCode").ToString()); +Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("warnings")[0].GetProperty("message").ToString()); +Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("itemsProcessed").ToString()); +Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("itemsFailed").ToString()); +Console.WriteLine(result.GetProperty("limits").ToString()); +]]> + + + \ No newline at end of file diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/Indexes.xml b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/Indexes.xml new file mode 100644 index 000000000000..ecb8d975ce4b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/Indexes.xml @@ -0,0 +1,3133 @@ + + + + + +This sample shows how to call CreateAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +SearchIndex index = new SearchIndex("temp-preview-test", new SearchField[] +{ + new SearchField("id", SearchFieldDataType.String) + { + Key = true, + Sortable = true, + }, + new SearchField("vector1", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 20, + VectorSearchProfile = "config1", + }, + new SearchField("vector1b", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 10, + VectorSearchProfile = "config2", + }, + new SearchField("vector2", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 5, + VectorSearchProfile = "config3", + }, + new SearchField("vector3", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 5, + VectorSearchProfile = "config3", + }, + new SearchField("vector22", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 10, + VectorSearchProfile = "config2", + }, + new SearchField("vector4", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 32, + VectorSearchProfile = "config4", + }, + new SearchField("name", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.EnLucene, + }, + new SearchField("description", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.StandardLucene, + }, + new SearchField("category", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.EnLucene, + }, + new SearchField("ownerId", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.EnLucene, + }, + new SearchField("price", SearchFieldDataType.Double) + { + Retrievable = true, + Filterable = true, + Sortable = true, + Facetable = true, + } +}) +{ + ScoringProfiles = {new ScoringProfile("stringFieldBoost") + { + Text = new TextWeights(new Dictionary + { + ["name"] = 3, + ["description"] = 1, + ["category"] = 2, + ["ownerId"] = 1 + }), + Functions = {new TagScoringFunction("category", 2, new TagScoringParameters("categoryTag"))}, + }}, + DefaultScoringProfile = "stringFieldBoost", + CorsOptions = new CorsOptions(new string[] { "https://www.example.com/foo" }) + { + MaxAgeInSeconds = 10L, + }, + Suggesters = { new SearchSuggester("sg", new string[] { "category", "ownerId" }) }, + Analyzers = {new CustomAnalyzer("tagsAnalyzer", LexicalTokenizerName.Standard) + { + TokenFilters = {TokenFilterName.CommonGram}, + CharFilters = {CharFilterName.HtmlStrip}, + }}, + Tokenizers = {new LuceneStandardTokenizerV2("my_tokenizer") + { + MaxTokenLength = 100, + }}, + TokenFilters = {new AsciiFoldingTokenFilter("my_tokenFilter") + { + PreserveOriginal = false, + }}, + CharFilters = { new MappingCharFilter("my_mapping", new string[] { ".=>,", "_=>-" }) }, + Normalizers = {new CustomNormalizer("my_normalizer") + { + TokenFilters = {new TokenFilterName("my_tokenFilter")}, + CharFilters = {new CharFilterName("my_mapping")}, + }}, + Similarity = new BM25SimilarityAlgorithm + { + K1 = 10, + B = 0.1, + }, + Semantic = new SemanticSearch + { + DefaultConfiguration = "testconfig", + Configurations = {new SemanticConfiguration("testconfig", new SemanticPrioritizedFields + { + TitleField = new SemanticField("category"), + PrioritizedContentFields = {new SemanticField("description")}, + PrioritizedKeywordsFields = {new SemanticField("ownerId")}, + }) + { + FlightingOptIn = true, + }}, + }, + VectorSearch = new VectorSearch + { + Profiles = {new VectorSearchProfile("config1", "cosine") + { + Vectorizer = "openai", + Compression = "mySQ8", + }, new VectorSearchProfile("config2", "euclidean") + { + Vectorizer = "custom-web-api", + Compression = "mySQ8", + }, new VectorSearchProfile("config3", "dotProduct") + { + Vectorizer = "custom-web-api", + Compression = "myBQC", + }, new VectorSearchProfile("config4", "dotProduct") + { + Vectorizer = "custom-web-api", + Compression = "myBQWithoutOriginals", + }}, + Algorithms = {new HnswAlgorithmConfiguration("cosine") + { + HnswParameters = new HnswParameters + { + Metric = VectorSearchAlgorithmMetric.Cosine, + }, + }, new HnswAlgorithmConfiguration("euclidean") + { + HnswParameters = new HnswParameters + { + Metric = VectorSearchAlgorithmMetric.Euclidean, + }, + }, new HnswAlgorithmConfiguration("dotProduct") + { + HnswParameters = new HnswParameters + { + Metric = VectorSearchAlgorithmMetric.DotProduct, + }, + }}, + Vectorizers = {new AzureOpenAIVectorizer("openai") + { + AzureOpenAIParameters = new AzureOpenAIVectorizerParameters + { + ResourceUri = new Uri("https://test-sample.openai.azure.com/"), + DeploymentId = "model", + ApiKey = "api-key", + ModelName = AzureOpenAIModelName.TextEmbedding3Large, + }, + }, new WebApiVectorizer("custom-web-api") + { + CustomWebApiParameters = new WebApiVectorizerParameters + { + Uri = new Uri("https://my-custom-endpoint.org/"), + HttpHeaders = + { + ["header1"] = "value1", + ["header2"] = "value2" + }, + HttpMethod = "POST", + Timeout = XmlConvert.ToTimeSpan("PT1M"), + AuthResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + AuthIdentity = new SearchIndexerDataNoneIdentity(), + }, + }, new AMLVectorizer("aml") + { + AmlParameters = new AMLParameters(new Uri("https://my-custom-endpoint.org/")) + { + ResourceId = "aml resource id", + Timeout = XmlConvert.ToTimeSpan("PT1M"), + Region = "aml region", + ModelName = AIFoundryModelCatalogName.OpenAICLIPImageTextEmbeddingsVitBasePatch32, + }, + }}, + Compressions = {new ScalarQuantizationCompression("mySQ8") + { + ScalarQuantizationParameters = new ScalarQuantizationParameters + { + QuantizedDataType = VectorSearchCompressionTarget.Int8, + }, + RescoringOptions = new RescoringOptions + { + EnableRescoring = true, + DefaultOversampling = 10, + RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, + }, + TruncationDimension = 2, + }, new BinaryQuantizationCompression("myBQC") + { + RescoringOptions = new RescoringOptions + { + EnableRescoring = true, + DefaultOversampling = 10, + RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, + }, + TruncationDimension = 2, + }, new BinaryQuantizationCompression("myBQWithoutOriginals") + { + RescoringOptions = new RescoringOptions + { + EnableRescoring = true, + DefaultOversampling = 10, + RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.DiscardOriginals, + }, + TruncationDimension = 2, + }}, + }, + ETag = "0x1234568AE7E58A1", +}; +Response response = await client.CreateAsync(index); +]]> + + + +This sample shows how to call Create. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +SearchIndex index = new SearchIndex("temp-preview-test", new SearchField[] +{ + new SearchField("id", SearchFieldDataType.String) + { + Key = true, + Sortable = true, + }, + new SearchField("vector1", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 20, + VectorSearchProfile = "config1", + }, + new SearchField("vector1b", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 10, + VectorSearchProfile = "config2", + }, + new SearchField("vector2", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 5, + VectorSearchProfile = "config3", + }, + new SearchField("vector3", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 5, + VectorSearchProfile = "config3", + }, + new SearchField("vector22", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 10, + VectorSearchProfile = "config2", + }, + new SearchField("vector4", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 32, + VectorSearchProfile = "config4", + }, + new SearchField("name", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.EnLucene, + }, + new SearchField("description", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.StandardLucene, + }, + new SearchField("category", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.EnLucene, + }, + new SearchField("ownerId", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.EnLucene, + }, + new SearchField("price", SearchFieldDataType.Double) + { + Retrievable = true, + Filterable = true, + Sortable = true, + Facetable = true, + } +}) +{ + ScoringProfiles = {new ScoringProfile("stringFieldBoost") + { + Text = new TextWeights(new Dictionary + { + ["name"] = 3, + ["description"] = 1, + ["category"] = 2, + ["ownerId"] = 1 + }), + Functions = {new TagScoringFunction("category", 2, new TagScoringParameters("categoryTag"))}, + }}, + DefaultScoringProfile = "stringFieldBoost", + CorsOptions = new CorsOptions(new string[] { "https://www.example.com/foo" }) + { + MaxAgeInSeconds = 10L, + }, + Suggesters = { new SearchSuggester("sg", new string[] { "category", "ownerId" }) }, + Analyzers = {new CustomAnalyzer("tagsAnalyzer", LexicalTokenizerName.Standard) + { + TokenFilters = {TokenFilterName.CommonGram}, + CharFilters = {CharFilterName.HtmlStrip}, + }}, + Tokenizers = {new LuceneStandardTokenizerV2("my_tokenizer") + { + MaxTokenLength = 100, + }}, + TokenFilters = {new AsciiFoldingTokenFilter("my_tokenFilter") + { + PreserveOriginal = false, + }}, + CharFilters = { new MappingCharFilter("my_mapping", new string[] { ".=>,", "_=>-" }) }, + Normalizers = {new CustomNormalizer("my_normalizer") + { + TokenFilters = {new TokenFilterName("my_tokenFilter")}, + CharFilters = {new CharFilterName("my_mapping")}, + }}, + Similarity = new BM25SimilarityAlgorithm + { + K1 = 10, + B = 0.1, + }, + Semantic = new SemanticSearch + { + DefaultConfiguration = "testconfig", + Configurations = {new SemanticConfiguration("testconfig", new SemanticPrioritizedFields + { + TitleField = new SemanticField("category"), + PrioritizedContentFields = {new SemanticField("description")}, + PrioritizedKeywordsFields = {new SemanticField("ownerId")}, + }) + { + FlightingOptIn = true, + }}, + }, + VectorSearch = new VectorSearch + { + Profiles = {new VectorSearchProfile("config1", "cosine") + { + Vectorizer = "openai", + Compression = "mySQ8", + }, new VectorSearchProfile("config2", "euclidean") + { + Vectorizer = "custom-web-api", + Compression = "mySQ8", + }, new VectorSearchProfile("config3", "dotProduct") + { + Vectorizer = "custom-web-api", + Compression = "myBQC", + }, new VectorSearchProfile("config4", "dotProduct") + { + Vectorizer = "custom-web-api", + Compression = "myBQWithoutOriginals", + }}, + Algorithms = {new HnswAlgorithmConfiguration("cosine") + { + HnswParameters = new HnswParameters + { + Metric = VectorSearchAlgorithmMetric.Cosine, + }, + }, new HnswAlgorithmConfiguration("euclidean") + { + HnswParameters = new HnswParameters + { + Metric = VectorSearchAlgorithmMetric.Euclidean, + }, + }, new HnswAlgorithmConfiguration("dotProduct") + { + HnswParameters = new HnswParameters + { + Metric = VectorSearchAlgorithmMetric.DotProduct, + }, + }}, + Vectorizers = {new AzureOpenAIVectorizer("openai") + { + AzureOpenAIParameters = new AzureOpenAIVectorizerParameters + { + ResourceUri = new Uri("https://test-sample.openai.azure.com/"), + DeploymentId = "model", + ApiKey = "api-key", + ModelName = AzureOpenAIModelName.TextEmbedding3Large, + }, + }, new WebApiVectorizer("custom-web-api") + { + CustomWebApiParameters = new WebApiVectorizerParameters + { + Uri = new Uri("https://my-custom-endpoint.org/"), + HttpHeaders = + { + ["header1"] = "value1", + ["header2"] = "value2" + }, + HttpMethod = "POST", + Timeout = XmlConvert.ToTimeSpan("PT1M"), + AuthResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + AuthIdentity = new SearchIndexerDataNoneIdentity(), + }, + }, new AMLVectorizer("aml") + { + AmlParameters = new AMLParameters(new Uri("https://my-custom-endpoint.org/")) + { + ResourceId = "aml resource id", + Timeout = XmlConvert.ToTimeSpan("PT1M"), + Region = "aml region", + ModelName = AIFoundryModelCatalogName.OpenAICLIPImageTextEmbeddingsVitBasePatch32, + }, + }}, + Compressions = {new ScalarQuantizationCompression("mySQ8") + { + ScalarQuantizationParameters = new ScalarQuantizationParameters + { + QuantizedDataType = VectorSearchCompressionTarget.Int8, + }, + RescoringOptions = new RescoringOptions + { + EnableRescoring = true, + DefaultOversampling = 10, + RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, + }, + TruncationDimension = 2, + }, new BinaryQuantizationCompression("myBQC") + { + RescoringOptions = new RescoringOptions + { + EnableRescoring = true, + DefaultOversampling = 10, + RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, + }, + TruncationDimension = 2, + }, new BinaryQuantizationCompression("myBQWithoutOriginals") + { + RescoringOptions = new RescoringOptions + { + EnableRescoring = true, + DefaultOversampling = 10, + RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.DiscardOriginals, + }, + TruncationDimension = 2, + }}, + }, + ETag = "0x1234568AE7E58A1", +}; +Response response = client.Create(index); +]]> + + + +This sample shows how to call CreateAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "temp-preview-test", + ["fields"] = new object[] + { + new + { + name = "id", + type = "Edm.String", + key = true, + sortable = true, + }, + new + { + name = "vector1", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 20, + vectorSearchProfile = "config1", + }, + new + { + name = "vector1b", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 10, + vectorSearchProfile = "config2", + }, + new + { + name = "vector2", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 5, + vectorSearchProfile = "config3", + }, + new + { + name = "vector3", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 5, + vectorSearchProfile = "config3", + }, + new + { + name = "vector22", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 10, + vectorSearchProfile = "config2", + }, + new + { + name = "vector4", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 32, + vectorSearchProfile = "config4", + }, + new + { + name = "name", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "en.lucene", + }, + new + { + name = "description", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "standard.lucene", + }, + new + { + name = "category", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "en.lucene", + }, + new + { + name = "ownerId", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "en.lucene", + }, + new + { + name = "price", + type = "Edm.Double", + retrievable = true, + filterable = true, + sortable = true, + facetable = true, + } + }, + ["scoringProfiles"] = new object[] + { + new + { + name = "stringFieldBoost", + text = new + { + weights = new + { + name = 3, + description = 1, + category = 2, + ownerId = 1, + }, + }, + functions = new object[] + { + new + { + tag = new + { + tagsParameter = "categoryTag", + }, + type = "tag", + fieldName = "category", + boost = 2, + } + }, + } + }, + ["defaultScoringProfile"] = "stringFieldBoost", + ["corsOptions"] = new + { + allowedOrigins = new object[] + { + "https://www.example.com/foo" + }, + maxAgeInSeconds = 10L, + }, + ["suggesters"] = new object[] + { + new + { + name = "sg", + searchMode = "analyzingInfixMatching", + sourceFields = new object[] + { + "category", + "ownerId" + }, + } + }, + ["analyzers"] = new object[] + { + new Dictionary + { + ["tokenizer"] = "standard_v2", + ["tokenFilters"] = new object[] + { + "common_grams" + }, + ["charFilters"] = new object[] + { + "html_strip" + }, + ["@odata.type"] = "#Microsoft.Azure.Search.CustomAnalyzer", + ["name"] = "tagsAnalyzer" + } + }, + ["tokenizers"] = new object[] + { + new Dictionary + { + ["maxTokenLength"] = 100, + ["@odata.type"] = "#Microsoft.Azure.Search.StandardTokenizerV2", + ["name"] = "my_tokenizer" + } + }, + ["tokenFilters"] = new object[] + { + new Dictionary + { + ["preserveOriginal"] = false, + ["@odata.type"] = "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", + ["name"] = "my_tokenFilter" + } + }, + ["charFilters"] = new object[] + { + new Dictionary + { + ["mappings"] = new object[] + { + ".=>,", + "_=>-" + }, + ["@odata.type"] = "#Microsoft.Azure.Search.MappingCharFilter", + ["name"] = "my_mapping" + } + }, + ["normalizers"] = new object[] + { + new Dictionary + { + ["tokenFilters"] = new object[] + { + "my_tokenFilter" + }, + ["charFilters"] = new object[] + { + "my_mapping" + }, + ["@odata.type"] = "#Microsoft.Azure.Search.CustomNormalizer", + ["name"] = "my_normalizer" + } + }, + ["similarity"] = new Dictionary + { + ["k1"] = 10, + ["b"] = 0.1, + ["@odata.type"] = "#Microsoft.Azure.Search.BM25Similarity" + }, + ["semantic"] = new + { + defaultConfiguration = "testconfig", + configurations = new object[] + { + new + { + name = "testconfig", + prioritizedFields = new + { + titleField = new + { + fieldName = "category", + }, + prioritizedContentFields = new object[] + { + new + { + fieldName = "description", + } + }, + prioritizedKeywordsFields = new object[] + { + new + { + fieldName = "ownerId", + } + }, + }, + flightingOptIn = true, + } + }, + }, + ["vectorSearch"] = new + { + profiles = new object[] + { + new + { + name = "config1", + algorithm = "cosine", + vectorizer = "openai", + compression = "mySQ8", + }, + new + { + name = "config2", + algorithm = "euclidean", + vectorizer = "custom-web-api", + compression = "mySQ8", + }, + new + { + name = "config3", + algorithm = "dotProduct", + vectorizer = "custom-web-api", + compression = "myBQC", + }, + new + { + name = "config4", + algorithm = "dotProduct", + vectorizer = "custom-web-api", + compression = "myBQWithoutOriginals", + } + }, + algorithms = new object[] + { + new + { + hnswParameters = new + { + metric = "cosine", + }, + name = "cosine", + kind = "hnsw", + }, + new + { + hnswParameters = new + { + metric = "euclidean", + }, + name = "euclidean", + kind = "hnsw", + }, + new + { + hnswParameters = new + { + metric = "dotProduct", + }, + name = "dotProduct", + kind = "hnsw", + } + }, + vectorizers = new object[] + { + new + { + azureOpenAIParameters = new + { + resourceUri = "https://test-sample.openai.azure.com/", + deploymentId = "model", + apiKey = "api-key", + modelName = "text-embedding-3-large", + }, + name = "openai", + kind = "azureOpenAI", + }, + new + { + customWebApiParameters = new + { + uri = "https://my-custom-endpoint.org/", + httpHeaders = new + { + header1 = "value1", + header2 = "value2", + }, + httpMethod = "POST", + timeout = "PT1M", + authResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + authIdentity = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + }, + name = "custom-web-api", + kind = "customWebApi", + }, + new + { + amlParameters = new + { + uri = "https://my-custom-endpoint.org/", + resourceId = "aml resource id", + timeout = "PT1M", + region = "aml region", + modelName = "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32", + }, + name = "aml", + kind = "aml", + } + }, + compressions = new object[] + { + new + { + scalarQuantizationParameters = new + { + quantizedDataType = "int8", + }, + name = "mySQ8", + kind = "scalarQuantization", + rescoringOptions = new + { + enableRescoring = true, + defaultOversampling = 10, + rescoreStorageMethod = "preserveOriginals", + }, + truncationDimension = 2, + }, + new + { + name = "myBQC", + kind = "binaryQuantization", + rescoringOptions = new + { + enableRescoring = true, + defaultOversampling = 10, + rescoreStorageMethod = "preserveOriginals", + }, + truncationDimension = 2, + }, + new + { + name = "myBQWithoutOriginals", + kind = "binaryQuantization", + rescoringOptions = new + { + enableRescoring = true, + defaultOversampling = 10, + rescoreStorageMethod = "discardOriginals", + }, + truncationDimension = 2, + } + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" +}); +Response response = await client.CreateAsync(content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); +]]> + + + +This sample shows how to call Create and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "temp-preview-test", + ["fields"] = new object[] + { + new + { + name = "id", + type = "Edm.String", + key = true, + sortable = true, + }, + new + { + name = "vector1", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 20, + vectorSearchProfile = "config1", + }, + new + { + name = "vector1b", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 10, + vectorSearchProfile = "config2", + }, + new + { + name = "vector2", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 5, + vectorSearchProfile = "config3", + }, + new + { + name = "vector3", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 5, + vectorSearchProfile = "config3", + }, + new + { + name = "vector22", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 10, + vectorSearchProfile = "config2", + }, + new + { + name = "vector4", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 32, + vectorSearchProfile = "config4", + }, + new + { + name = "name", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "en.lucene", + }, + new + { + name = "description", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "standard.lucene", + }, + new + { + name = "category", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "en.lucene", + }, + new + { + name = "ownerId", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "en.lucene", + }, + new + { + name = "price", + type = "Edm.Double", + retrievable = true, + filterable = true, + sortable = true, + facetable = true, + } + }, + ["scoringProfiles"] = new object[] + { + new + { + name = "stringFieldBoost", + text = new + { + weights = new + { + name = 3, + description = 1, + category = 2, + ownerId = 1, + }, + }, + functions = new object[] + { + new + { + tag = new + { + tagsParameter = "categoryTag", + }, + type = "tag", + fieldName = "category", + boost = 2, + } + }, + } + }, + ["defaultScoringProfile"] = "stringFieldBoost", + ["corsOptions"] = new + { + allowedOrigins = new object[] + { + "https://www.example.com/foo" + }, + maxAgeInSeconds = 10L, + }, + ["suggesters"] = new object[] + { + new + { + name = "sg", + searchMode = "analyzingInfixMatching", + sourceFields = new object[] + { + "category", + "ownerId" + }, + } + }, + ["analyzers"] = new object[] + { + new Dictionary + { + ["tokenizer"] = "standard_v2", + ["tokenFilters"] = new object[] + { + "common_grams" + }, + ["charFilters"] = new object[] + { + "html_strip" + }, + ["@odata.type"] = "#Microsoft.Azure.Search.CustomAnalyzer", + ["name"] = "tagsAnalyzer" + } + }, + ["tokenizers"] = new object[] + { + new Dictionary + { + ["maxTokenLength"] = 100, + ["@odata.type"] = "#Microsoft.Azure.Search.StandardTokenizerV2", + ["name"] = "my_tokenizer" + } + }, + ["tokenFilters"] = new object[] + { + new Dictionary + { + ["preserveOriginal"] = false, + ["@odata.type"] = "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", + ["name"] = "my_tokenFilter" + } + }, + ["charFilters"] = new object[] + { + new Dictionary + { + ["mappings"] = new object[] + { + ".=>,", + "_=>-" + }, + ["@odata.type"] = "#Microsoft.Azure.Search.MappingCharFilter", + ["name"] = "my_mapping" + } + }, + ["normalizers"] = new object[] + { + new Dictionary + { + ["tokenFilters"] = new object[] + { + "my_tokenFilter" + }, + ["charFilters"] = new object[] + { + "my_mapping" + }, + ["@odata.type"] = "#Microsoft.Azure.Search.CustomNormalizer", + ["name"] = "my_normalizer" + } + }, + ["similarity"] = new Dictionary + { + ["k1"] = 10, + ["b"] = 0.1, + ["@odata.type"] = "#Microsoft.Azure.Search.BM25Similarity" + }, + ["semantic"] = new + { + defaultConfiguration = "testconfig", + configurations = new object[] + { + new + { + name = "testconfig", + prioritizedFields = new + { + titleField = new + { + fieldName = "category", + }, + prioritizedContentFields = new object[] + { + new + { + fieldName = "description", + } + }, + prioritizedKeywordsFields = new object[] + { + new + { + fieldName = "ownerId", + } + }, + }, + flightingOptIn = true, + } + }, + }, + ["vectorSearch"] = new + { + profiles = new object[] + { + new + { + name = "config1", + algorithm = "cosine", + vectorizer = "openai", + compression = "mySQ8", + }, + new + { + name = "config2", + algorithm = "euclidean", + vectorizer = "custom-web-api", + compression = "mySQ8", + }, + new + { + name = "config3", + algorithm = "dotProduct", + vectorizer = "custom-web-api", + compression = "myBQC", + }, + new + { + name = "config4", + algorithm = "dotProduct", + vectorizer = "custom-web-api", + compression = "myBQWithoutOriginals", + } + }, + algorithms = new object[] + { + new + { + hnswParameters = new + { + metric = "cosine", + }, + name = "cosine", + kind = "hnsw", + }, + new + { + hnswParameters = new + { + metric = "euclidean", + }, + name = "euclidean", + kind = "hnsw", + }, + new + { + hnswParameters = new + { + metric = "dotProduct", + }, + name = "dotProduct", + kind = "hnsw", + } + }, + vectorizers = new object[] + { + new + { + azureOpenAIParameters = new + { + resourceUri = "https://test-sample.openai.azure.com/", + deploymentId = "model", + apiKey = "api-key", + modelName = "text-embedding-3-large", + }, + name = "openai", + kind = "azureOpenAI", + }, + new + { + customWebApiParameters = new + { + uri = "https://my-custom-endpoint.org/", + httpHeaders = new + { + header1 = "value1", + header2 = "value2", + }, + httpMethod = "POST", + timeout = "PT1M", + authResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + authIdentity = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + }, + name = "custom-web-api", + kind = "customWebApi", + }, + new + { + amlParameters = new + { + uri = "https://my-custom-endpoint.org/", + resourceId = "aml resource id", + timeout = "PT1M", + region = "aml region", + modelName = "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32", + }, + name = "aml", + kind = "aml", + } + }, + compressions = new object[] + { + new + { + scalarQuantizationParameters = new + { + quantizedDataType = "int8", + }, + name = "mySQ8", + kind = "scalarQuantization", + rescoringOptions = new + { + enableRescoring = true, + defaultOversampling = 10, + rescoreStorageMethod = "preserveOriginals", + }, + truncationDimension = 2, + }, + new + { + name = "myBQC", + kind = "binaryQuantization", + rescoringOptions = new + { + enableRescoring = true, + defaultOversampling = 10, + rescoreStorageMethod = "preserveOriginals", + }, + truncationDimension = 2, + }, + new + { + name = "myBQWithoutOriginals", + kind = "binaryQuantization", + rescoringOptions = new + { + enableRescoring = true, + defaultOversampling = 10, + rescoreStorageMethod = "discardOriginals", + }, + truncationDimension = 2, + } + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" +}); +Response response = client.Create(content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); +]]> + + + +This sample shows how to call CreateOrUpdateAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +SearchIndex index = new SearchIndex("temp-preview-test", new SearchField[] +{ + new SearchField("id", SearchFieldDataType.String) + { + Key = true, + Sortable = true, + }, + new SearchField("vector1", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 20, + VectorSearchProfile = "config1", + }, + new SearchField("vector1b", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 10, + VectorSearchProfile = "config2", + }, + new SearchField("vector2", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 5, + VectorSearchProfile = "config3", + }, + new SearchField("vector3", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 5, + VectorSearchProfile = "config3", + }, + new SearchField("vector22", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 10, + VectorSearchProfile = "config2", + }, + new SearchField("vector4", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 32, + VectorSearchProfile = "config4", + }, + new SearchField("name", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.EnLucene, + }, + new SearchField("description", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.StandardLucene, + }, + new SearchField("category", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.EnLucene, + }, + new SearchField("ownerId", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.EnLucene, + }, + new SearchField("price", SearchFieldDataType.Double) + { + Retrievable = true, + Filterable = true, + Sortable = true, + Facetable = true, + } +}) +{ + ScoringProfiles = {new ScoringProfile("stringFieldBoost") + { + Text = new TextWeights(new Dictionary + { + ["name"] = 3, + ["description"] = 1, + ["category"] = 2, + ["ownerId"] = 1 + }), + Functions = {new TagScoringFunction("category", 2, new TagScoringParameters("categoryTag"))}, + }}, + DefaultScoringProfile = "stringFieldBoost", + CorsOptions = new CorsOptions(new string[] { "https://www.example.com/foo" }) + { + MaxAgeInSeconds = 10L, + }, + Suggesters = { new SearchSuggester("sg", new string[] { "category", "ownerId" }) }, + Analyzers = {new CustomAnalyzer("tagsAnalyzer", LexicalTokenizerName.Standard) + { + TokenFilters = {TokenFilterName.CommonGram}, + CharFilters = {CharFilterName.HtmlStrip}, + }}, + Tokenizers = {new LuceneStandardTokenizerV2("my_tokenizer") + { + MaxTokenLength = 100, + }}, + TokenFilters = {new AsciiFoldingTokenFilter("my_tokenFilter") + { + PreserveOriginal = false, + }}, + CharFilters = { new MappingCharFilter("my_mapping", new string[] { ".=>,", "_=>-" }) }, + Normalizers = {new CustomNormalizer("my_normalizer") + { + TokenFilters = {new TokenFilterName("my_tokenFilter")}, + CharFilters = {new CharFilterName("my_mapping")}, + }}, + Similarity = new BM25SimilarityAlgorithm + { + K1 = 10, + B = 0.1, + }, + Semantic = new SemanticSearch + { + DefaultConfiguration = "testconfig", + Configurations = {new SemanticConfiguration("testconfig", new SemanticPrioritizedFields + { + TitleField = new SemanticField("category"), + PrioritizedContentFields = {new SemanticField("description")}, + PrioritizedKeywordsFields = {new SemanticField("ownerId")}, + }) + { + FlightingOptIn = true, + }}, + }, + VectorSearch = new VectorSearch + { + Profiles = {new VectorSearchProfile("config1", "cosine") + { + Vectorizer = "openai", + Compression = "mySQ8", + }, new VectorSearchProfile("config2", "euclidean") + { + Vectorizer = "custom-web-api", + Compression = "mySQ8", + }, new VectorSearchProfile("config3", "dotProduct") + { + Vectorizer = "custom-web-api", + Compression = "myBQC", + }, new VectorSearchProfile("config4", "dotProduct") + { + Vectorizer = "custom-web-api", + Compression = "myBQWithoutOriginals", + }}, + Algorithms = {new HnswAlgorithmConfiguration("cosine") + { + HnswParameters = new HnswParameters + { + Metric = VectorSearchAlgorithmMetric.Cosine, + }, + }, new HnswAlgorithmConfiguration("euclidean") + { + HnswParameters = new HnswParameters + { + Metric = VectorSearchAlgorithmMetric.Euclidean, + }, + }, new HnswAlgorithmConfiguration("dotProduct") + { + HnswParameters = new HnswParameters + { + Metric = VectorSearchAlgorithmMetric.DotProduct, + }, + }}, + Vectorizers = {new AzureOpenAIVectorizer("openai") + { + AzureOpenAIParameters = new AzureOpenAIVectorizerParameters + { + ResourceUri = new Uri("https://test-sample.openai.azure.com/"), + DeploymentId = "model", + ApiKey = "api-key", + ModelName = AzureOpenAIModelName.TextEmbedding3Large, + }, + }, new WebApiVectorizer("custom-web-api") + { + CustomWebApiParameters = new WebApiVectorizerParameters + { + Uri = new Uri("https://my-custom-endpoint.org/"), + HttpHeaders = + { + ["header1"] = "value1", + ["header2"] = "value2" + }, + HttpMethod = "POST", + Timeout = XmlConvert.ToTimeSpan("PT1M"), + AuthResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + AuthIdentity = new SearchIndexerDataNoneIdentity(), + }, + }, new AMLVectorizer("aml") + { + AmlParameters = new AMLParameters(new Uri("https://my-custom-endpoint.org/")) + { + ResourceId = "aml resource id", + Timeout = XmlConvert.ToTimeSpan("PT1M"), + Region = "aml region", + ModelName = AIFoundryModelCatalogName.OpenAICLIPImageTextEmbeddingsVitBasePatch32, + }, + }}, + Compressions = {new ScalarQuantizationCompression("mySQ8") + { + ScalarQuantizationParameters = new ScalarQuantizationParameters + { + QuantizedDataType = VectorSearchCompressionTarget.Int8, + }, + RescoringOptions = new RescoringOptions + { + EnableRescoring = true, + DefaultOversampling = 10, + RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, + }, + TruncationDimension = 2, + }, new BinaryQuantizationCompression("myBQC") + { + RescoringOptions = new RescoringOptions + { + EnableRescoring = true, + DefaultOversampling = 10, + RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, + }, + TruncationDimension = 2, + }, new BinaryQuantizationCompression("myBQWithoutOriginals") + { + RescoringOptions = new RescoringOptions + { + EnableRescoring = true, + DefaultOversampling = 10, + RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.DiscardOriginals, + }, + TruncationDimension = 2, + }}, + }, + ETag = "0x1234568AE7E58A1", +}; +Response response = await client.CreateOrUpdateAsync("temp-preview-test", index); +]]> + + + +This sample shows how to call CreateOrUpdate. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +SearchIndex index = new SearchIndex("temp-preview-test", new SearchField[] +{ + new SearchField("id", SearchFieldDataType.String) + { + Key = true, + Sortable = true, + }, + new SearchField("vector1", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 20, + VectorSearchProfile = "config1", + }, + new SearchField("vector1b", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 10, + VectorSearchProfile = "config2", + }, + new SearchField("vector2", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 5, + VectorSearchProfile = "config3", + }, + new SearchField("vector3", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 5, + VectorSearchProfile = "config3", + }, + new SearchField("vector22", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 10, + VectorSearchProfile = "config2", + }, + new SearchField("vector4", new SearchFieldDataType("Collection(Edm.Single)")) + { + Retrievable = true, + Searchable = true, + Dimensions = 32, + VectorSearchProfile = "config4", + }, + new SearchField("name", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.EnLucene, + }, + new SearchField("description", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.StandardLucene, + }, + new SearchField("category", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.EnLucene, + }, + new SearchField("ownerId", SearchFieldDataType.String) + { + Retrievable = true, + Searchable = true, + Filterable = true, + Sortable = true, + Facetable = true, + Analyzer = LexicalAnalyzerName.EnLucene, + }, + new SearchField("price", SearchFieldDataType.Double) + { + Retrievable = true, + Filterable = true, + Sortable = true, + Facetable = true, + } +}) +{ + ScoringProfiles = {new ScoringProfile("stringFieldBoost") + { + Text = new TextWeights(new Dictionary + { + ["name"] = 3, + ["description"] = 1, + ["category"] = 2, + ["ownerId"] = 1 + }), + Functions = {new TagScoringFunction("category", 2, new TagScoringParameters("categoryTag"))}, + }}, + DefaultScoringProfile = "stringFieldBoost", + CorsOptions = new CorsOptions(new string[] { "https://www.example.com/foo" }) + { + MaxAgeInSeconds = 10L, + }, + Suggesters = { new SearchSuggester("sg", new string[] { "category", "ownerId" }) }, + Analyzers = {new CustomAnalyzer("tagsAnalyzer", LexicalTokenizerName.Standard) + { + TokenFilters = {TokenFilterName.CommonGram}, + CharFilters = {CharFilterName.HtmlStrip}, + }}, + Tokenizers = {new LuceneStandardTokenizerV2("my_tokenizer") + { + MaxTokenLength = 100, + }}, + TokenFilters = {new AsciiFoldingTokenFilter("my_tokenFilter") + { + PreserveOriginal = false, + }}, + CharFilters = { new MappingCharFilter("my_mapping", new string[] { ".=>,", "_=>-" }) }, + Normalizers = {new CustomNormalizer("my_normalizer") + { + TokenFilters = {new TokenFilterName("my_tokenFilter")}, + CharFilters = {new CharFilterName("my_mapping")}, + }}, + Similarity = new BM25SimilarityAlgorithm + { + K1 = 10, + B = 0.1, + }, + Semantic = new SemanticSearch + { + DefaultConfiguration = "testconfig", + Configurations = {new SemanticConfiguration("testconfig", new SemanticPrioritizedFields + { + TitleField = new SemanticField("category"), + PrioritizedContentFields = {new SemanticField("description")}, + PrioritizedKeywordsFields = {new SemanticField("ownerId")}, + }) + { + FlightingOptIn = true, + }}, + }, + VectorSearch = new VectorSearch + { + Profiles = {new VectorSearchProfile("config1", "cosine") + { + Vectorizer = "openai", + Compression = "mySQ8", + }, new VectorSearchProfile("config2", "euclidean") + { + Vectorizer = "custom-web-api", + Compression = "mySQ8", + }, new VectorSearchProfile("config3", "dotProduct") + { + Vectorizer = "custom-web-api", + Compression = "myBQC", + }, new VectorSearchProfile("config4", "dotProduct") + { + Vectorizer = "custom-web-api", + Compression = "myBQWithoutOriginals", + }}, + Algorithms = {new HnswAlgorithmConfiguration("cosine") + { + HnswParameters = new HnswParameters + { + Metric = VectorSearchAlgorithmMetric.Cosine, + }, + }, new HnswAlgorithmConfiguration("euclidean") + { + HnswParameters = new HnswParameters + { + Metric = VectorSearchAlgorithmMetric.Euclidean, + }, + }, new HnswAlgorithmConfiguration("dotProduct") + { + HnswParameters = new HnswParameters + { + Metric = VectorSearchAlgorithmMetric.DotProduct, + }, + }}, + Vectorizers = {new AzureOpenAIVectorizer("openai") + { + AzureOpenAIParameters = new AzureOpenAIVectorizerParameters + { + ResourceUri = new Uri("https://test-sample.openai.azure.com/"), + DeploymentId = "model", + ApiKey = "api-key", + ModelName = AzureOpenAIModelName.TextEmbedding3Large, + }, + }, new WebApiVectorizer("custom-web-api") + { + CustomWebApiParameters = new WebApiVectorizerParameters + { + Uri = new Uri("https://my-custom-endpoint.org/"), + HttpHeaders = + { + ["header1"] = "value1", + ["header2"] = "value2" + }, + HttpMethod = "POST", + Timeout = XmlConvert.ToTimeSpan("PT1M"), + AuthResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + AuthIdentity = new SearchIndexerDataNoneIdentity(), + }, + }, new AMLVectorizer("aml") + { + AmlParameters = new AMLParameters(new Uri("https://my-custom-endpoint.org/")) + { + ResourceId = "aml resource id", + Timeout = XmlConvert.ToTimeSpan("PT1M"), + Region = "aml region", + ModelName = AIFoundryModelCatalogName.OpenAICLIPImageTextEmbeddingsVitBasePatch32, + }, + }}, + Compressions = {new ScalarQuantizationCompression("mySQ8") + { + ScalarQuantizationParameters = new ScalarQuantizationParameters + { + QuantizedDataType = VectorSearchCompressionTarget.Int8, + }, + RescoringOptions = new RescoringOptions + { + EnableRescoring = true, + DefaultOversampling = 10, + RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, + }, + TruncationDimension = 2, + }, new BinaryQuantizationCompression("myBQC") + { + RescoringOptions = new RescoringOptions + { + EnableRescoring = true, + DefaultOversampling = 10, + RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, + }, + TruncationDimension = 2, + }, new BinaryQuantizationCompression("myBQWithoutOriginals") + { + RescoringOptions = new RescoringOptions + { + EnableRescoring = true, + DefaultOversampling = 10, + RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.DiscardOriginals, + }, + TruncationDimension = 2, + }}, + }, + ETag = "0x1234568AE7E58A1", +}; +Response response = client.CreateOrUpdate("temp-preview-test", index); +]]> + + + +This sample shows how to call CreateOrUpdateAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "temp-preview-test", + ["fields"] = new object[] + { + new + { + name = "id", + type = "Edm.String", + key = true, + sortable = true, + }, + new + { + name = "vector1", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 20, + vectorSearchProfile = "config1", + }, + new + { + name = "vector1b", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 10, + vectorSearchProfile = "config2", + }, + new + { + name = "vector2", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 5, + vectorSearchProfile = "config3", + }, + new + { + name = "vector3", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 5, + vectorSearchProfile = "config3", + }, + new + { + name = "vector22", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 10, + vectorSearchProfile = "config2", + }, + new + { + name = "vector4", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 32, + vectorSearchProfile = "config4", + }, + new + { + name = "name", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "en.lucene", + }, + new + { + name = "description", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "standard.lucene", + }, + new + { + name = "category", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "en.lucene", + }, + new + { + name = "ownerId", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "en.lucene", + }, + new + { + name = "price", + type = "Edm.Double", + retrievable = true, + filterable = true, + sortable = true, + facetable = true, + } + }, + ["scoringProfiles"] = new object[] + { + new + { + name = "stringFieldBoost", + text = new + { + weights = new + { + name = 3, + description = 1, + category = 2, + ownerId = 1, + }, + }, + functions = new object[] + { + new + { + tag = new + { + tagsParameter = "categoryTag", + }, + type = "tag", + fieldName = "category", + boost = 2, + } + }, + } + }, + ["defaultScoringProfile"] = "stringFieldBoost", + ["corsOptions"] = new + { + allowedOrigins = new object[] + { + "https://www.example.com/foo" + }, + maxAgeInSeconds = 10L, + }, + ["suggesters"] = new object[] + { + new + { + name = "sg", + searchMode = "analyzingInfixMatching", + sourceFields = new object[] + { + "category", + "ownerId" + }, + } + }, + ["analyzers"] = new object[] + { + new Dictionary + { + ["tokenizer"] = "standard_v2", + ["tokenFilters"] = new object[] + { + "common_grams" + }, + ["charFilters"] = new object[] + { + "html_strip" + }, + ["@odata.type"] = "#Microsoft.Azure.Search.CustomAnalyzer", + ["name"] = "tagsAnalyzer" + } + }, + ["tokenizers"] = new object[] + { + new Dictionary + { + ["maxTokenLength"] = 100, + ["@odata.type"] = "#Microsoft.Azure.Search.StandardTokenizerV2", + ["name"] = "my_tokenizer" + } + }, + ["tokenFilters"] = new object[] + { + new Dictionary + { + ["preserveOriginal"] = false, + ["@odata.type"] = "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", + ["name"] = "my_tokenFilter" + } + }, + ["charFilters"] = new object[] + { + new Dictionary + { + ["mappings"] = new object[] + { + ".=>,", + "_=>-" + }, + ["@odata.type"] = "#Microsoft.Azure.Search.MappingCharFilter", + ["name"] = "my_mapping" + } + }, + ["normalizers"] = new object[] + { + new Dictionary + { + ["tokenFilters"] = new object[] + { + "my_tokenFilter" + }, + ["charFilters"] = new object[] + { + "my_mapping" + }, + ["@odata.type"] = "#Microsoft.Azure.Search.CustomNormalizer", + ["name"] = "my_normalizer" + } + }, + ["similarity"] = new Dictionary + { + ["k1"] = 10, + ["b"] = 0.1, + ["@odata.type"] = "#Microsoft.Azure.Search.BM25Similarity" + }, + ["semantic"] = new + { + defaultConfiguration = "testconfig", + configurations = new object[] + { + new + { + name = "testconfig", + prioritizedFields = new + { + titleField = new + { + fieldName = "category", + }, + prioritizedContentFields = new object[] + { + new + { + fieldName = "description", + } + }, + prioritizedKeywordsFields = new object[] + { + new + { + fieldName = "ownerId", + } + }, + }, + flightingOptIn = true, + } + }, + }, + ["vectorSearch"] = new + { + profiles = new object[] + { + new + { + name = "config1", + algorithm = "cosine", + vectorizer = "openai", + compression = "mySQ8", + }, + new + { + name = "config2", + algorithm = "euclidean", + vectorizer = "custom-web-api", + compression = "mySQ8", + }, + new + { + name = "config3", + algorithm = "dotProduct", + vectorizer = "custom-web-api", + compression = "myBQC", + }, + new + { + name = "config4", + algorithm = "dotProduct", + vectorizer = "custom-web-api", + compression = "myBQWithoutOriginals", + } + }, + algorithms = new object[] + { + new + { + hnswParameters = new + { + metric = "cosine", + }, + name = "cosine", + kind = "hnsw", + }, + new + { + hnswParameters = new + { + metric = "euclidean", + }, + name = "euclidean", + kind = "hnsw", + }, + new + { + hnswParameters = new + { + metric = "dotProduct", + }, + name = "dotProduct", + kind = "hnsw", + } + }, + vectorizers = new object[] + { + new + { + azureOpenAIParameters = new + { + resourceUri = "https://test-sample.openai.azure.com/", + deploymentId = "model", + apiKey = "api-key", + modelName = "text-embedding-3-large", + }, + name = "openai", + kind = "azureOpenAI", + }, + new + { + customWebApiParameters = new + { + uri = "https://my-custom-endpoint.org/", + httpHeaders = new + { + header1 = "value1", + header2 = "value2", + }, + httpMethod = "POST", + timeout = "PT1M", + authResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + authIdentity = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + }, + name = "custom-web-api", + kind = "customWebApi", + }, + new + { + amlParameters = new + { + uri = "https://my-custom-endpoint.org/", + resourceId = "aml resource id", + timeout = "PT1M", + region = "aml region", + modelName = "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32", + }, + name = "aml", + kind = "aml", + } + }, + compressions = new object[] + { + new + { + scalarQuantizationParameters = new + { + quantizedDataType = "int8", + }, + name = "mySQ8", + kind = "scalarQuantization", + rescoringOptions = new + { + enableRescoring = true, + defaultOversampling = 10, + rescoreStorageMethod = "preserveOriginals", + }, + truncationDimension = 2, + }, + new + { + name = "myBQC", + kind = "binaryQuantization", + rescoringOptions = new + { + enableRescoring = true, + defaultOversampling = 10, + rescoreStorageMethod = "preserveOriginals", + }, + truncationDimension = 2, + }, + new + { + name = "myBQWithoutOriginals", + kind = "binaryQuantization", + rescoringOptions = new + { + enableRescoring = true, + defaultOversampling = 10, + rescoreStorageMethod = "discardOriginals", + }, + truncationDimension = 2, + } + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" +}); +Response response = await client.CreateOrUpdateAsync("temp-preview-test", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); +]]> + + + +This sample shows how to call CreateOrUpdate and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "temp-preview-test", + ["fields"] = new object[] + { + new + { + name = "id", + type = "Edm.String", + key = true, + sortable = true, + }, + new + { + name = "vector1", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 20, + vectorSearchProfile = "config1", + }, + new + { + name = "vector1b", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 10, + vectorSearchProfile = "config2", + }, + new + { + name = "vector2", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 5, + vectorSearchProfile = "config3", + }, + new + { + name = "vector3", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 5, + vectorSearchProfile = "config3", + }, + new + { + name = "vector22", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 10, + vectorSearchProfile = "config2", + }, + new + { + name = "vector4", + type = "Collection(Edm.Single)", + retrievable = true, + searchable = true, + dimensions = 32, + vectorSearchProfile = "config4", + }, + new + { + name = "name", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "en.lucene", + }, + new + { + name = "description", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "standard.lucene", + }, + new + { + name = "category", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "en.lucene", + }, + new + { + name = "ownerId", + type = "Edm.String", + retrievable = true, + searchable = true, + filterable = true, + sortable = true, + facetable = true, + analyzer = "en.lucene", + }, + new + { + name = "price", + type = "Edm.Double", + retrievable = true, + filterable = true, + sortable = true, + facetable = true, + } + }, + ["scoringProfiles"] = new object[] + { + new + { + name = "stringFieldBoost", + text = new + { + weights = new + { + name = 3, + description = 1, + category = 2, + ownerId = 1, + }, + }, + functions = new object[] + { + new + { + tag = new + { + tagsParameter = "categoryTag", + }, + type = "tag", + fieldName = "category", + boost = 2, + } + }, + } + }, + ["defaultScoringProfile"] = "stringFieldBoost", + ["corsOptions"] = new + { + allowedOrigins = new object[] + { + "https://www.example.com/foo" + }, + maxAgeInSeconds = 10L, + }, + ["suggesters"] = new object[] + { + new + { + name = "sg", + searchMode = "analyzingInfixMatching", + sourceFields = new object[] + { + "category", + "ownerId" + }, + } + }, + ["analyzers"] = new object[] + { + new Dictionary + { + ["tokenizer"] = "standard_v2", + ["tokenFilters"] = new object[] + { + "common_grams" + }, + ["charFilters"] = new object[] + { + "html_strip" + }, + ["@odata.type"] = "#Microsoft.Azure.Search.CustomAnalyzer", + ["name"] = "tagsAnalyzer" + } + }, + ["tokenizers"] = new object[] + { + new Dictionary + { + ["maxTokenLength"] = 100, + ["@odata.type"] = "#Microsoft.Azure.Search.StandardTokenizerV2", + ["name"] = "my_tokenizer" + } + }, + ["tokenFilters"] = new object[] + { + new Dictionary + { + ["preserveOriginal"] = false, + ["@odata.type"] = "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", + ["name"] = "my_tokenFilter" + } + }, + ["charFilters"] = new object[] + { + new Dictionary + { + ["mappings"] = new object[] + { + ".=>,", + "_=>-" + }, + ["@odata.type"] = "#Microsoft.Azure.Search.MappingCharFilter", + ["name"] = "my_mapping" + } + }, + ["normalizers"] = new object[] + { + new Dictionary + { + ["tokenFilters"] = new object[] + { + "my_tokenFilter" + }, + ["charFilters"] = new object[] + { + "my_mapping" + }, + ["@odata.type"] = "#Microsoft.Azure.Search.CustomNormalizer", + ["name"] = "my_normalizer" + } + }, + ["similarity"] = new Dictionary + { + ["k1"] = 10, + ["b"] = 0.1, + ["@odata.type"] = "#Microsoft.Azure.Search.BM25Similarity" + }, + ["semantic"] = new + { + defaultConfiguration = "testconfig", + configurations = new object[] + { + new + { + name = "testconfig", + prioritizedFields = new + { + titleField = new + { + fieldName = "category", + }, + prioritizedContentFields = new object[] + { + new + { + fieldName = "description", + } + }, + prioritizedKeywordsFields = new object[] + { + new + { + fieldName = "ownerId", + } + }, + }, + flightingOptIn = true, + } + }, + }, + ["vectorSearch"] = new + { + profiles = new object[] + { + new + { + name = "config1", + algorithm = "cosine", + vectorizer = "openai", + compression = "mySQ8", + }, + new + { + name = "config2", + algorithm = "euclidean", + vectorizer = "custom-web-api", + compression = "mySQ8", + }, + new + { + name = "config3", + algorithm = "dotProduct", + vectorizer = "custom-web-api", + compression = "myBQC", + }, + new + { + name = "config4", + algorithm = "dotProduct", + vectorizer = "custom-web-api", + compression = "myBQWithoutOriginals", + } + }, + algorithms = new object[] + { + new + { + hnswParameters = new + { + metric = "cosine", + }, + name = "cosine", + kind = "hnsw", + }, + new + { + hnswParameters = new + { + metric = "euclidean", + }, + name = "euclidean", + kind = "hnsw", + }, + new + { + hnswParameters = new + { + metric = "dotProduct", + }, + name = "dotProduct", + kind = "hnsw", + } + }, + vectorizers = new object[] + { + new + { + azureOpenAIParameters = new + { + resourceUri = "https://test-sample.openai.azure.com/", + deploymentId = "model", + apiKey = "api-key", + modelName = "text-embedding-3-large", + }, + name = "openai", + kind = "azureOpenAI", + }, + new + { + customWebApiParameters = new + { + uri = "https://my-custom-endpoint.org/", + httpHeaders = new + { + header1 = "value1", + header2 = "value2", + }, + httpMethod = "POST", + timeout = "PT1M", + authResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", + authIdentity = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + }, + name = "custom-web-api", + kind = "customWebApi", + }, + new + { + amlParameters = new + { + uri = "https://my-custom-endpoint.org/", + resourceId = "aml resource id", + timeout = "PT1M", + region = "aml region", + modelName = "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32", + }, + name = "aml", + kind = "aml", + } + }, + compressions = new object[] + { + new + { + scalarQuantizationParameters = new + { + quantizedDataType = "int8", + }, + name = "mySQ8", + kind = "scalarQuantization", + rescoringOptions = new + { + enableRescoring = true, + defaultOversampling = 10, + rescoreStorageMethod = "preserveOriginals", + }, + truncationDimension = 2, + }, + new + { + name = "myBQC", + kind = "binaryQuantization", + rescoringOptions = new + { + enableRescoring = true, + defaultOversampling = 10, + rescoreStorageMethod = "preserveOriginals", + }, + truncationDimension = 2, + }, + new + { + name = "myBQWithoutOriginals", + kind = "binaryQuantization", + rescoringOptions = new + { + enableRescoring = true, + defaultOversampling = 10, + rescoreStorageMethod = "discardOriginals", + }, + truncationDimension = 2, + } + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" +}); +Response response = client.CreateOrUpdate("temp-preview-test", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); +]]> + + + +This sample shows how to call DeleteAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +Response response = await client.DeleteAsync("temp-preview-test"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call Delete. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +Response response = client.Delete("temp-preview-test"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call GetIndexAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +Response response = await client.GetIndexAsync("preview-test"); +]]> + + + +This sample shows how to call GetIndex. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +Response response = client.GetIndex("preview-test"); +]]> + + + +This sample shows how to call GetIndexAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +Response response = await client.GetIndexAsync("preview-test", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); +]]> + + + +This sample shows how to call GetIndex and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +Response response = client.GetIndex("preview-test", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); +]]> + + + +This sample shows how to call GetStatisticsAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +Response response = await client.GetStatisticsAsync("preview-test"); +]]> + + + +This sample shows how to call GetStatistics. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +Response response = client.GetStatistics("preview-test"); +]]> + + + +This sample shows how to call GetStatisticsAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +Response response = await client.GetStatisticsAsync("preview-test", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("documentCount").ToString()); +Console.WriteLine(result.GetProperty("storageSize").ToString()); +Console.WriteLine(result.GetProperty("vectorIndexSize").ToString()); +]]> + + + +This sample shows how to call GetStatistics and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +Response response = client.GetStatistics("preview-test", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("documentCount").ToString()); +Console.WriteLine(result.GetProperty("storageSize").ToString()); +Console.WriteLine(result.GetProperty("vectorIndexSize").ToString()); +]]> + + + +This sample shows how to call AnalyzeAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +AnalyzeRequest request = new AnalyzeRequest("Text to analyze") +{ + Analyzer = LexicalAnalyzerName.ArLucene, +}; +Response response = await client.AnalyzeAsync("preview-test", request); +]]> + + + +This sample shows how to call Analyze. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +AnalyzeRequest request = new AnalyzeRequest("Text to analyze") +{ + Analyzer = LexicalAnalyzerName.ArLucene, +}; +Response response = client.Analyze("preview-test", request); +]]> + + + +This sample shows how to call AnalyzeAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +using RequestContent content = RequestContent.Create(new +{ + text = "Text to analyze", + analyzer = "ar.lucene", +}); +Response response = await client.AnalyzeAsync("preview-test", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("token").ToString()); +Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("startOffset").ToString()); +Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("endOffset").ToString()); +Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("position").ToString()); +]]> + + + +This sample shows how to call Analyze and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +using RequestContent content = RequestContent.Create(new +{ + text = "Text to analyze", + analyzer = "ar.lucene", +}); +Response response = client.Analyze("preview-test", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("token").ToString()); +Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("startOffset").ToString()); +Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("endOffset").ToString()); +Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("position").ToString()); +]]> + + + +This sample shows how to call GetIndexesAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +await foreach (SearchIndex item in client.GetIndexesAsync()) +{ +} +]]> + + + +This sample shows how to call GetIndexes. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +foreach (SearchIndex item in client.GetIndexes()) +{ +} +]]> + + + +This sample shows how to call GetIndexesAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +await foreach (BinaryData item in client.GetIndexesAsync(null, null)) +{ + JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); +} +]]> + + + +This sample shows how to call GetIndexes and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + +foreach (BinaryData item in client.GetIndexes(null, null)) +{ + JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); +} +]]> + + + \ No newline at end of file diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/SearchClient.xml b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/SearchClient.xml new file mode 100644 index 000000000000..0037aeef1966 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/SearchClient.xml @@ -0,0 +1,133 @@ + + + + + +This sample shows how to call GetServiceStatisticsAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SearchClient client = new SearchClient(endpoint, credential); + +Response response = await client.GetServiceStatisticsAsync(); +]]> + + + +This sample shows how to call GetServiceStatistics. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SearchClient client = new SearchClient(endpoint, credential); + +Response response = client.GetServiceStatistics(); +]]> + + + +This sample shows how to call GetServiceStatisticsAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SearchClient client = new SearchClient(endpoint, credential); + +Response response = await client.GetServiceStatisticsAsync(null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("counters").GetProperty("aliasesCount").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("documentCount").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("indexesCount").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("indexersCount").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("dataSourcesCount").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("storageSize").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("synonymMaps").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("skillsetCount").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("vectorIndexSize").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("limits").ToString()); +]]> + + + +This sample shows how to call GetServiceStatistics and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SearchClient client = new SearchClient(endpoint, credential); + +Response response = client.GetServiceStatistics(null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("counters").GetProperty("aliasesCount").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("documentCount").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("indexesCount").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("indexersCount").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("dataSourcesCount").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("storageSize").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("synonymMaps").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("skillsetCount").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("counters").GetProperty("vectorIndexSize").GetProperty("usage").ToString()); +Console.WriteLine(result.GetProperty("limits").ToString()); +]]> + + + +This sample shows how to call GetIndexStatsSummaryAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SearchClient client = new SearchClient(endpoint, credential); + +await foreach (IndexStatisticsSummary item in client.GetIndexStatsSummaryAsync()) +{ +} +]]> + + + +This sample shows how to call GetIndexStatsSummary. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SearchClient client = new SearchClient(endpoint, credential); + +foreach (IndexStatisticsSummary item in client.GetIndexStatsSummary()) +{ +} +]]> + + + +This sample shows how to call GetIndexStatsSummaryAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SearchClient client = new SearchClient(endpoint, credential); + +await foreach (BinaryData item in client.GetIndexStatsSummaryAsync(null)) +{ + JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("documentCount").ToString()); + Console.WriteLine(result.GetProperty("storageSize").ToString()); +} +]]> + + + +This sample shows how to call GetIndexStatsSummary and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SearchClient client = new SearchClient(endpoint, credential); + +foreach (BinaryData item in client.GetIndexStatsSummary(null)) +{ + JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("documentCount").ToString()); + Console.WriteLine(result.GetProperty("storageSize").ToString()); +} +]]> + + + \ No newline at end of file diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/Skillsets.xml b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/Skillsets.xml new file mode 100644 index 000000000000..db45ffd839b3 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/Skillsets.xml @@ -0,0 +1,1529 @@ + + + + + +This sample shows how to call CreateOrUpdateAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +SearchIndexerSkillset skillset = new SearchIndexerSkillset("tempskillset", new SearchIndexerSkill[] +{ + new LanguageDetectionSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("countryHint") + { + Source = "/document/countryHint", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("languageCode") + { + TargetName = "languageCode", + } + }) + { + Name = "skill2", + }, + new SplitSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("languageCode") + { + Source = "/document/languageCode", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("textItems") + { + TargetName = "pages", + } + }) + { + TextSplitMode = TextSplitMode.Pages, + MaximumPageLength = 4000, + Unit = SplitSkillUnit.AzureOpenAITokens, + AzureOpenAITokenizerParameters = new AzureOpenAITokenizerParameters + { + EncoderModelName = SplitSkillEncoderModelName.CL100kBase, + AllowedSpecialTokens = {"[START]", "[END]"}, + }, + Name = "skill3", + }, + new KeyPhraseExtractionSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("languageCode") + { + Source = "/document/languageCode", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("keyPhrases") + { + TargetName = "keyPhrases", + } + }) + { + Name = "skill4", + Context = "/document/pages/*", + }, + new WebApiSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("languageCode") + { + Source = "/document/languageCode", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("customresult") + { + TargetName = "result", + } + }, "https://contoso.example.org/") + { + HttpMethod = "POST", + Timeout = XmlConvert.ToTimeSpan("PT5S"), + Name = "skill5", + }, + new DocumentIntelligenceLayoutSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("file_data") + { + Source = "/document/content", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("markdown_document") + { + TargetName = "markdown_document", + } + }) + { + OutputMode = DocumentIntelligenceLayoutSkillOutputMode.OneToMany, + MarkdownHeaderDepth = DocumentIntelligenceLayoutSkillMarkdownHeaderDepth.H3, + Name = "docIntelligenceLayoutSkill", + Context = "/document", + } +}) +{ + Description = "Skillset for extracting entities and more", + CognitiveServices = new AIServicesAccountKey("myKey", "https://mySubdomainName.cognitiveservices.azure.com") + { + Description = "Description of the Azure AI service resource attached to a skillset", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, +}; +Response response = await client.CreateOrUpdateAsync("tempskillset", skillset); +]]> + + + +This sample shows how to call CreateOrUpdate. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +SearchIndexerSkillset skillset = new SearchIndexerSkillset("tempskillset", new SearchIndexerSkill[] +{ + new LanguageDetectionSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("countryHint") + { + Source = "/document/countryHint", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("languageCode") + { + TargetName = "languageCode", + } + }) + { + Name = "skill2", + }, + new SplitSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("languageCode") + { + Source = "/document/languageCode", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("textItems") + { + TargetName = "pages", + } + }) + { + TextSplitMode = TextSplitMode.Pages, + MaximumPageLength = 4000, + Unit = SplitSkillUnit.AzureOpenAITokens, + AzureOpenAITokenizerParameters = new AzureOpenAITokenizerParameters + { + EncoderModelName = SplitSkillEncoderModelName.CL100kBase, + AllowedSpecialTokens = {"[START]", "[END]"}, + }, + Name = "skill3", + }, + new KeyPhraseExtractionSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("languageCode") + { + Source = "/document/languageCode", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("keyPhrases") + { + TargetName = "keyPhrases", + } + }) + { + Name = "skill4", + Context = "/document/pages/*", + }, + new WebApiSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("languageCode") + { + Source = "/document/languageCode", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("customresult") + { + TargetName = "result", + } + }, "https://contoso.example.org/") + { + HttpMethod = "POST", + Timeout = XmlConvert.ToTimeSpan("PT5S"), + Name = "skill5", + }, + new DocumentIntelligenceLayoutSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("file_data") + { + Source = "/document/content", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("markdown_document") + { + TargetName = "markdown_document", + } + }) + { + OutputMode = DocumentIntelligenceLayoutSkillOutputMode.OneToMany, + MarkdownHeaderDepth = DocumentIntelligenceLayoutSkillMarkdownHeaderDepth.H3, + Name = "docIntelligenceLayoutSkill", + Context = "/document", + } +}) +{ + Description = "Skillset for extracting entities and more", + CognitiveServices = new AIServicesAccountKey("myKey", "https://mySubdomainName.cognitiveservices.azure.com") + { + Description = "Description of the Azure AI service resource attached to a skillset", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, +}; +Response response = client.CreateOrUpdate("tempskillset", skillset); +]]> + + + +This sample shows how to call CreateOrUpdateAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "tempskillset", + ["description"] = "Skillset for extracting entities and more", + ["skills"] = new object[] + { + new Dictionary + { + ["@odata.type"] = "#Microsoft.Skills.Text.LanguageDetectionSkill", + ["name"] = "skill2", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "countryHint", + source = "/document/countryHint", + } + }, + ["outputs"] = new object[] + { + new + { + name = "languageCode", + targetName = "languageCode", + } + } + }, + new Dictionary + { + ["textSplitMode"] = "pages", + ["maximumPageLength"] = 4000, + ["unit"] = "azureOpenAITokens", + ["azureOpenAITokenizerParameters"] = new + { + encoderModelName = "cl100k_base", + allowedSpecialTokens = new object[] + { + "[START]", + "[END]" + }, + }, + ["@odata.type"] = "#Microsoft.Skills.Text.SplitSkill", + ["name"] = "skill3", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "languageCode", + source = "/document/languageCode", + } + }, + ["outputs"] = new object[] + { + new + { + name = "textItems", + targetName = "pages", + } + } + }, + new Dictionary + { + ["@odata.type"] = "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + ["name"] = "skill4", + ["context"] = "/document/pages/*", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "languageCode", + source = "/document/languageCode", + } + }, + ["outputs"] = new object[] + { + new + { + name = "keyPhrases", + targetName = "keyPhrases", + } + } + }, + new Dictionary + { + ["uri"] = "https://contoso.example.org/", + ["httpMethod"] = "POST", + ["timeout"] = "PT5S", + ["@odata.type"] = "#Microsoft.Skills.Custom.WebApiSkill", + ["name"] = "skill5", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "languageCode", + source = "/document/languageCode", + } + }, + ["outputs"] = new object[] + { + new + { + name = "customresult", + targetName = "result", + } + } + }, + new Dictionary + { + ["outputMode"] = "oneToMany", + ["markdownHeaderDepth"] = "h3", + ["@odata.type"] = "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + ["name"] = "docIntelligenceLayoutSkill", + ["context"] = "/document", + ["inputs"] = new object[] + { + new + { + name = "file_data", + source = "/document/content", + } + }, + ["outputs"] = new object[] + { + new + { + name = "markdown_document", + targetName = "markdown_document", + } + } + } + }, + ["cognitiveServices"] = new Dictionary + { + ["key"] = "myKey", + ["subdomainUrl"] = "https://mySubdomainName.cognitiveservices.azure.com", + ["@odata.type"] = "#Microsoft.Azure.Search.AIServicesByKey", + ["description"] = "Description of the Azure AI service resource attached to a skillset" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } +}); +Response response = await client.CreateOrUpdateAsync("tempskillset", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("@odata.type").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); +]]> + + + +This sample shows how to call CreateOrUpdate and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "tempskillset", + ["description"] = "Skillset for extracting entities and more", + ["skills"] = new object[] + { + new Dictionary + { + ["@odata.type"] = "#Microsoft.Skills.Text.LanguageDetectionSkill", + ["name"] = "skill2", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "countryHint", + source = "/document/countryHint", + } + }, + ["outputs"] = new object[] + { + new + { + name = "languageCode", + targetName = "languageCode", + } + } + }, + new Dictionary + { + ["textSplitMode"] = "pages", + ["maximumPageLength"] = 4000, + ["unit"] = "azureOpenAITokens", + ["azureOpenAITokenizerParameters"] = new + { + encoderModelName = "cl100k_base", + allowedSpecialTokens = new object[] + { + "[START]", + "[END]" + }, + }, + ["@odata.type"] = "#Microsoft.Skills.Text.SplitSkill", + ["name"] = "skill3", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "languageCode", + source = "/document/languageCode", + } + }, + ["outputs"] = new object[] + { + new + { + name = "textItems", + targetName = "pages", + } + } + }, + new Dictionary + { + ["@odata.type"] = "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + ["name"] = "skill4", + ["context"] = "/document/pages/*", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "languageCode", + source = "/document/languageCode", + } + }, + ["outputs"] = new object[] + { + new + { + name = "keyPhrases", + targetName = "keyPhrases", + } + } + }, + new Dictionary + { + ["uri"] = "https://contoso.example.org/", + ["httpMethod"] = "POST", + ["timeout"] = "PT5S", + ["@odata.type"] = "#Microsoft.Skills.Custom.WebApiSkill", + ["name"] = "skill5", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "languageCode", + source = "/document/languageCode", + } + }, + ["outputs"] = new object[] + { + new + { + name = "customresult", + targetName = "result", + } + } + }, + new Dictionary + { + ["outputMode"] = "oneToMany", + ["markdownHeaderDepth"] = "h3", + ["@odata.type"] = "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + ["name"] = "docIntelligenceLayoutSkill", + ["context"] = "/document", + ["inputs"] = new object[] + { + new + { + name = "file_data", + source = "/document/content", + } + }, + ["outputs"] = new object[] + { + new + { + name = "markdown_document", + targetName = "markdown_document", + } + } + } + }, + ["cognitiveServices"] = new Dictionary + { + ["key"] = "myKey", + ["subdomainUrl"] = "https://mySubdomainName.cognitiveservices.azure.com", + ["@odata.type"] = "#Microsoft.Azure.Search.AIServicesByKey", + ["description"] = "Description of the Azure AI service resource attached to a skillset" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } +}); +Response response = client.CreateOrUpdate("tempskillset", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("@odata.type").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); +]]> + + + +This sample shows how to call DeleteAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +Response response = await client.DeleteAsync("tempskillset"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call Delete. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +Response response = client.Delete("tempskillset"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call GetSkillsetAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +Response response = await client.GetSkillsetAsync("myskillset"); +]]> + + + +This sample shows how to call GetSkillset. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +Response response = client.GetSkillset("myskillset"); +]]> + + + +This sample shows how to call GetSkillsetAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +Response response = await client.GetSkillsetAsync("myskillset", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("@odata.type").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); +]]> + + + +This sample shows how to call GetSkillset and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +Response response = client.GetSkillset("myskillset", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("@odata.type").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); +]]> + + + +This sample shows how to call GetSkillsetsAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +Response response = await client.GetSkillsetsAsync(); +]]> + + + +This sample shows how to call GetSkillsets. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +Response response = client.GetSkillsets(); +]]> + + + +This sample shows how to call GetSkillsetsAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +Response response = await client.GetSkillsetsAsync(null, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("skills")[0].GetProperty("@odata.type").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); +]]> + + + +This sample shows how to call GetSkillsets and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +Response response = client.GetSkillsets(null, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("skills")[0].GetProperty("@odata.type").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); +]]> + + + +This sample shows how to call CreateAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +SearchIndexerSkillset skillset = new SearchIndexerSkillset("tempskillset", new SearchIndexerSkill[] +{ + new LanguageDetectionSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("countryHint") + { + Source = "/document/countryHint", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("languageCode") + { + TargetName = "languageCode", + } + }) + { + Name = "skill2", + }, + new SplitSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("languageCode") + { + Source = "/document/languageCode", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("textItems") + { + TargetName = "pages", + } + }) + { + TextSplitMode = TextSplitMode.Pages, + MaximumPageLength = 4000, + Unit = SplitSkillUnit.AzureOpenAITokens, + AzureOpenAITokenizerParameters = new AzureOpenAITokenizerParameters + { + EncoderModelName = SplitSkillEncoderModelName.CL100kBase, + AllowedSpecialTokens = {"[START]", "[END]"}, + }, + Name = "skill3", + }, + new KeyPhraseExtractionSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("languageCode") + { + Source = "/document/languageCode", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("keyPhrases") + { + TargetName = "keyPhrases", + } + }) + { + Name = "skill4", + Context = "/document/pages/*", + }, + new WebApiSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("languageCode") + { + Source = "/document/languageCode", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("customresult") + { + TargetName = "result", + } + }, "https://contoso.example.org/") + { + HttpMethod = "POST", + Timeout = XmlConvert.ToTimeSpan("PT5S"), + Name = "skill5", + }, + new DocumentIntelligenceLayoutSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("file_data") + { + Source = "/document/content", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("markdown_document") + { + TargetName = "markdown_document", + } + }) + { + OutputMode = DocumentIntelligenceLayoutSkillOutputMode.OneToMany, + MarkdownHeaderDepth = DocumentIntelligenceLayoutSkillMarkdownHeaderDepth.H3, + Name = "docIntelligenceLayoutSkill", + Context = "/document", + } +}) +{ + Description = "Skillset for extracting entities and more", + CognitiveServices = new AIServicesAccountKey("myKey", "https://mySubdomainName.cognitiveservices.azure.com") + { + Description = "Description of the Azure AI service resource attached to a skillset", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, +}; +Response response = await client.CreateAsync(skillset); +]]> + + + +This sample shows how to call Create. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +SearchIndexerSkillset skillset = new SearchIndexerSkillset("tempskillset", new SearchIndexerSkill[] +{ + new LanguageDetectionSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("countryHint") + { + Source = "/document/countryHint", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("languageCode") + { + TargetName = "languageCode", + } + }) + { + Name = "skill2", + }, + new SplitSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("languageCode") + { + Source = "/document/languageCode", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("textItems") + { + TargetName = "pages", + } + }) + { + TextSplitMode = TextSplitMode.Pages, + MaximumPageLength = 4000, + Unit = SplitSkillUnit.AzureOpenAITokens, + AzureOpenAITokenizerParameters = new AzureOpenAITokenizerParameters + { + EncoderModelName = SplitSkillEncoderModelName.CL100kBase, + AllowedSpecialTokens = {"[START]", "[END]"}, + }, + Name = "skill3", + }, + new KeyPhraseExtractionSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("languageCode") + { + Source = "/document/languageCode", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("keyPhrases") + { + TargetName = "keyPhrases", + } + }) + { + Name = "skill4", + Context = "/document/pages/*", + }, + new WebApiSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("text") + { + Source = "/document/content", + }, + new InputFieldMappingEntry("languageCode") + { + Source = "/document/languageCode", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("customresult") + { + TargetName = "result", + } + }, "https://contoso.example.org/") + { + HttpMethod = "POST", + Timeout = XmlConvert.ToTimeSpan("PT5S"), + Name = "skill5", + }, + new DocumentIntelligenceLayoutSkill(new InputFieldMappingEntry[] + { + new InputFieldMappingEntry("file_data") + { + Source = "/document/content", + } + }, new OutputFieldMappingEntry[] + { + new OutputFieldMappingEntry("markdown_document") + { + TargetName = "markdown_document", + } + }) + { + OutputMode = DocumentIntelligenceLayoutSkillOutputMode.OneToMany, + MarkdownHeaderDepth = DocumentIntelligenceLayoutSkillMarkdownHeaderDepth.H3, + Name = "docIntelligenceLayoutSkill", + Context = "/document", + } +}) +{ + Description = "Skillset for extracting entities and more", + CognitiveServices = new AIServicesAccountKey("myKey", "https://mySubdomainName.cognitiveservices.azure.com") + { + Description = "Description of the Azure AI service resource attached to a skillset", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, +}; +Response response = client.Create(skillset); +]]> + + + +This sample shows how to call CreateAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "tempskillset", + ["description"] = "Skillset for extracting entities and more", + ["skills"] = new object[] + { + new Dictionary + { + ["@odata.type"] = "#Microsoft.Skills.Text.LanguageDetectionSkill", + ["name"] = "skill2", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "countryHint", + source = "/document/countryHint", + } + }, + ["outputs"] = new object[] + { + new + { + name = "languageCode", + targetName = "languageCode", + } + } + }, + new Dictionary + { + ["textSplitMode"] = "pages", + ["maximumPageLength"] = 4000, + ["unit"] = "azureOpenAITokens", + ["azureOpenAITokenizerParameters"] = new + { + encoderModelName = "cl100k_base", + allowedSpecialTokens = new object[] + { + "[START]", + "[END]" + }, + }, + ["@odata.type"] = "#Microsoft.Skills.Text.SplitSkill", + ["name"] = "skill3", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "languageCode", + source = "/document/languageCode", + } + }, + ["outputs"] = new object[] + { + new + { + name = "textItems", + targetName = "pages", + } + } + }, + new Dictionary + { + ["@odata.type"] = "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + ["name"] = "skill4", + ["context"] = "/document/pages/*", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "languageCode", + source = "/document/languageCode", + } + }, + ["outputs"] = new object[] + { + new + { + name = "keyPhrases", + targetName = "keyPhrases", + } + } + }, + new Dictionary + { + ["uri"] = "https://contoso.example.org/", + ["httpMethod"] = "POST", + ["timeout"] = "PT5S", + ["@odata.type"] = "#Microsoft.Skills.Custom.WebApiSkill", + ["name"] = "skill5", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "languageCode", + source = "/document/languageCode", + } + }, + ["outputs"] = new object[] + { + new + { + name = "customresult", + targetName = "result", + } + } + }, + new Dictionary + { + ["outputMode"] = "oneToMany", + ["markdownHeaderDepth"] = "h3", + ["@odata.type"] = "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + ["name"] = "docIntelligenceLayoutSkill", + ["context"] = "/document", + ["inputs"] = new object[] + { + new + { + name = "file_data", + source = "/document/content", + } + }, + ["outputs"] = new object[] + { + new + { + name = "markdown_document", + targetName = "markdown_document", + } + } + } + }, + ["cognitiveServices"] = new Dictionary + { + ["key"] = "myKey", + ["subdomainUrl"] = "https://mySubdomainName.cognitiveservices.azure.com", + ["@odata.type"] = "#Microsoft.Azure.Search.AIServicesByKey", + ["description"] = "Description of the Azure AI service resource attached to a skillset" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } +}); +Response response = await client.CreateAsync(content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("@odata.type").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); +]]> + + + +This sample shows how to call Create and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "tempskillset", + ["description"] = "Skillset for extracting entities and more", + ["skills"] = new object[] + { + new Dictionary + { + ["@odata.type"] = "#Microsoft.Skills.Text.LanguageDetectionSkill", + ["name"] = "skill2", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "countryHint", + source = "/document/countryHint", + } + }, + ["outputs"] = new object[] + { + new + { + name = "languageCode", + targetName = "languageCode", + } + } + }, + new Dictionary + { + ["textSplitMode"] = "pages", + ["maximumPageLength"] = 4000, + ["unit"] = "azureOpenAITokens", + ["azureOpenAITokenizerParameters"] = new + { + encoderModelName = "cl100k_base", + allowedSpecialTokens = new object[] + { + "[START]", + "[END]" + }, + }, + ["@odata.type"] = "#Microsoft.Skills.Text.SplitSkill", + ["name"] = "skill3", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "languageCode", + source = "/document/languageCode", + } + }, + ["outputs"] = new object[] + { + new + { + name = "textItems", + targetName = "pages", + } + } + }, + new Dictionary + { + ["@odata.type"] = "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + ["name"] = "skill4", + ["context"] = "/document/pages/*", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "languageCode", + source = "/document/languageCode", + } + }, + ["outputs"] = new object[] + { + new + { + name = "keyPhrases", + targetName = "keyPhrases", + } + } + }, + new Dictionary + { + ["uri"] = "https://contoso.example.org/", + ["httpMethod"] = "POST", + ["timeout"] = "PT5S", + ["@odata.type"] = "#Microsoft.Skills.Custom.WebApiSkill", + ["name"] = "skill5", + ["inputs"] = new object[] + { + new + { + name = "text", + source = "/document/content", + }, + new + { + name = "languageCode", + source = "/document/languageCode", + } + }, + ["outputs"] = new object[] + { + new + { + name = "customresult", + targetName = "result", + } + } + }, + new Dictionary + { + ["outputMode"] = "oneToMany", + ["markdownHeaderDepth"] = "h3", + ["@odata.type"] = "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + ["name"] = "docIntelligenceLayoutSkill", + ["context"] = "/document", + ["inputs"] = new object[] + { + new + { + name = "file_data", + source = "/document/content", + } + }, + ["outputs"] = new object[] + { + new + { + name = "markdown_document", + targetName = "markdown_document", + } + } + } + }, + ["cognitiveServices"] = new Dictionary + { + ["key"] = "myKey", + ["subdomainUrl"] = "https://mySubdomainName.cognitiveservices.azure.com", + ["@odata.type"] = "#Microsoft.Azure.Search.AIServicesByKey", + ["description"] = "Description of the Azure AI service resource attached to a skillset" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } +}); +Response response = client.Create(content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("@odata.type").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); +]]> + + + +This sample shows how to call ResetSkillsAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +SkillNames skillNames = new SkillNames +{ + SkillNamesProperty = { "skill2", "skill3", "skill4" }, +}; +Response response = await client.ResetSkillsAsync("myskillset", skillNames); +]]> + + + +This sample shows how to call ResetSkills. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +SkillNames skillNames = new SkillNames +{ + SkillNamesProperty = { "skill2", "skill3", "skill4" }, +}; +Response response = client.ResetSkills("myskillset", skillNames); +]]> + + + +This sample shows how to call ResetSkillsAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +using RequestContent content = RequestContent.Create(new +{ + skillNames = new object[] + { + "skill2", + "skill3", + "skill4" + }, +}); +Response response = await client.ResetSkillsAsync("myskillset", content); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call ResetSkills. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + +using RequestContent content = RequestContent.Create(new +{ + skillNames = new object[] + { + "skill2", + "skill3", + "skill4" + }, +}); +Response response = client.ResetSkills("myskillset", content); + +Console.WriteLine(response.Status); +]]> + + + \ No newline at end of file diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/SynonymMaps.xml b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/SynonymMaps.xml new file mode 100644 index 000000000000..6a77bcb444ed --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Docs/SynonymMaps.xml @@ -0,0 +1,367 @@ + + + + + +This sample shows how to call CreateOrUpdateAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +SynonymMap synonymMap = new SynonymMap("mysynonymmap", "United States, United States of America, USA\nWashington, Wash. => WA") +{ + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + ETag = "0x1234568AE7E58A1", +}; +Response response = await client.CreateOrUpdateAsync("mysynonymmap", synonymMap); +]]> + + + +This sample shows how to call CreateOrUpdate. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +SynonymMap synonymMap = new SynonymMap("mysynonymmap", "United States, United States of America, USA\nWashington, Wash. => WA") +{ + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + ETag = "0x1234568AE7E58A1", +}; +Response response = client.CreateOrUpdate("mysynonymmap", synonymMap); +]]> + + + +This sample shows how to call CreateOrUpdateAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "mysynonymmap", + ["format"] = "solr", + ["synonyms"] = "United States, United States of America, USA\nWashington, Wash. => WA", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" +}); +Response response = await client.CreateOrUpdateAsync("mysynonymmap", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("format").ToString()); +Console.WriteLine(result.GetProperty("synonyms").ToString()); +]]> + + + +This sample shows how to call CreateOrUpdate and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "mysynonymmap", + ["format"] = "solr", + ["synonyms"] = "United States, United States of America, USA\nWashington, Wash. => WA", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" +}); +Response response = client.CreateOrUpdate("mysynonymmap", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("format").ToString()); +Console.WriteLine(result.GetProperty("synonyms").ToString()); +]]> + + + +This sample shows how to call DeleteAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +Response response = await client.DeleteAsync("tempsynonymmap"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call Delete. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +Response response = client.Delete("tempsynonymmap"); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call GetSynonymMapAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +Response response = await client.GetSynonymMapAsync("mysynonymmap"); +]]> + + + +This sample shows how to call GetSynonymMap. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +Response response = client.GetSynonymMap("mysynonymmap"); +]]> + + + +This sample shows how to call GetSynonymMapAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +Response response = await client.GetSynonymMapAsync("mysynonymmap", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("format").ToString()); +Console.WriteLine(result.GetProperty("synonyms").ToString()); +]]> + + + +This sample shows how to call GetSynonymMap and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +Response response = client.GetSynonymMap("mysynonymmap", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("format").ToString()); +Console.WriteLine(result.GetProperty("synonyms").ToString()); +]]> + + + +This sample shows how to call GetSynonymMapsAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +Response response = await client.GetSynonymMapsAsync(); +]]> + + + +This sample shows how to call GetSynonymMaps. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +Response response = client.GetSynonymMaps(); +]]> + + + +This sample shows how to call GetSynonymMapsAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +Response response = await client.GetSynonymMapsAsync(null, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("format").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("synonyms").ToString()); +]]> + + + +This sample shows how to call GetSynonymMaps and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +Response response = client.GetSynonymMaps(null, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("format").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("synonyms").ToString()); +]]> + + + +This sample shows how to call CreateAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +SynonymMap synonymMap = new SynonymMap("tempsynonymmap", "United States, United States of America, USA\nWashington, Wash. => WA") +{ + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + ETag = "0x1234568AE7E58A1", +}; +Response response = await client.CreateAsync(synonymMap); +]]> + + + +This sample shows how to call Create. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +SynonymMap synonymMap = new SynonymMap("tempsynonymmap", "United States, United States of America, USA\nWashington, Wash. => WA") +{ + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + ETag = "0x1234568AE7E58A1", +}; +Response response = client.Create(synonymMap); +]]> + + + +This sample shows how to call CreateAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "tempsynonymmap", + ["format"] = "solr", + ["synonyms"] = "United States, United States of America, USA\nWashington, Wash. => WA", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" +}); +Response response = await client.CreateAsync(content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("format").ToString()); +Console.WriteLine(result.GetProperty("synonyms").ToString()); +]]> + + + +This sample shows how to call Create and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + +using RequestContent content = RequestContent.Create(new Dictionary +{ + ["name"] = "tempsynonymmap", + ["format"] = "solr", + ["synonyms"] = "United States, United States of America, USA\nWashington, Wash. => WA", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" +}); +Response response = client.Create(content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("name").ToString()); +Console.WriteLine(result.GetProperty("format").ToString()); +Console.WriteLine(result.GetProperty("synonyms").ToString()); +]]> + + + \ No newline at end of file diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentExtractionSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentExtractionSkill.Serialization.cs new file mode 100644 index 000000000000..68847ed9b6d7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentExtractionSkill.Serialization.cs @@ -0,0 +1,243 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class DocumentExtractionSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DocumentExtractionSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(ParsingMode)) + { + writer.WritePropertyName("parsingMode"u8); + writer.WriteStringValue(ParsingMode); + } + if (Optional.IsDefined(DataToExtract)) + { + writer.WritePropertyName("dataToExtract"u8); + writer.WriteStringValue(DataToExtract); + } + if (Optional.IsCollectionDefined(Configuration)) + { + writer.WritePropertyName("configuration"u8); + writer.WriteStartObject(); + foreach (var item in Configuration) + { + writer.WritePropertyName(item.Key); + if (item.Value == null) + { + writer.WriteNullValue(); + continue; + } +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + writer.WriteEndObject(); + } + } + + DocumentExtractionSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DocumentExtractionSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeDocumentExtractionSkill(document.RootElement, options); + } + + internal static DocumentExtractionSkill DeserializeDocumentExtractionSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string parsingMode = default; + string dataToExtract = default; + IDictionary configuration = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("parsingMode"u8)) + { + parsingMode = property.Value.GetString(); + continue; + } + if (property.NameEquals("dataToExtract"u8)) + { + dataToExtract = property.Value.GetString(); + continue; + } + if (property.NameEquals("configuration"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + Dictionary dictionary = new Dictionary(); + foreach (var property0 in property.Value.EnumerateObject()) + { + if (property0.Value.ValueKind == JsonValueKind.Null) + { + dictionary.Add(property0.Name, null); + } + else + { + dictionary.Add(property0.Name, BinaryData.FromString(property0.Value.GetRawText())); + } + } + configuration = dictionary; + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new DocumentExtractionSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + parsingMode, + dataToExtract, + configuration ?? new ChangeTrackingDictionary()); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(DocumentExtractionSkill)} does not support writing '{options.Format}' format."); + } + } + + DocumentExtractionSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDocumentExtractionSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(DocumentExtractionSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new DocumentExtractionSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDocumentExtractionSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentExtractionSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentExtractionSkill.cs new file mode 100644 index 000000000000..e5d30a864d8a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentExtractionSkill.cs @@ -0,0 +1,111 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// A skill that extracts content from a file within the enrichment pipeline. + public partial class DocumentExtractionSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public DocumentExtractionSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Util.DocumentExtractionSkill"; + Configuration = new ChangeTrackingDictionary(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// The parsingMode for the skill. Will be set to 'default' if not defined. + /// The type of data to be extracted for the skill. Will be set to 'contentAndMetadata' if not defined. + /// A dictionary of configurations for the skill. + internal DocumentExtractionSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData, string parsingMode, string dataToExtract, IDictionary configuration) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + ParsingMode = parsingMode; + DataToExtract = dataToExtract; + Configuration = configuration; + } + + /// Initializes a new instance of for deserialization. + internal DocumentExtractionSkill() + { + } + + /// The parsingMode for the skill. Will be set to 'default' if not defined. + public string ParsingMode { get; set; } + /// The type of data to be extracted for the skill. Will be set to 'contentAndMetadata' if not defined. + public string DataToExtract { get; set; } + /// + /// A dictionary of configurations for the skill. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + public IDictionary Configuration { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentIntelligenceLayoutSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentIntelligenceLayoutSkill.Serialization.cs new file mode 100644 index 000000000000..6e9889b4823f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentIntelligenceLayoutSkill.Serialization.cs @@ -0,0 +1,205 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class DocumentIntelligenceLayoutSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DocumentIntelligenceLayoutSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(OutputMode)) + { + writer.WritePropertyName("outputMode"u8); + writer.WriteStringValue(OutputMode.Value.ToString()); + } + if (Optional.IsDefined(MarkdownHeaderDepth)) + { + writer.WritePropertyName("markdownHeaderDepth"u8); + writer.WriteStringValue(MarkdownHeaderDepth.Value.ToString()); + } + } + + DocumentIntelligenceLayoutSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DocumentIntelligenceLayoutSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeDocumentIntelligenceLayoutSkill(document.RootElement, options); + } + + internal static DocumentIntelligenceLayoutSkill DeserializeDocumentIntelligenceLayoutSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + DocumentIntelligenceLayoutSkillOutputMode? outputMode = default; + DocumentIntelligenceLayoutSkillMarkdownHeaderDepth? markdownHeaderDepth = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("outputMode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + outputMode = new DocumentIntelligenceLayoutSkillOutputMode(property.Value.GetString()); + continue; + } + if (property.NameEquals("markdownHeaderDepth"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + markdownHeaderDepth = new DocumentIntelligenceLayoutSkillMarkdownHeaderDepth(property.Value.GetString()); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new DocumentIntelligenceLayoutSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + outputMode, + markdownHeaderDepth); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(DocumentIntelligenceLayoutSkill)} does not support writing '{options.Format}' format."); + } + } + + DocumentIntelligenceLayoutSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDocumentIntelligenceLayoutSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(DocumentIntelligenceLayoutSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new DocumentIntelligenceLayoutSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDocumentIntelligenceLayoutSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentIntelligenceLayoutSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentIntelligenceLayoutSkill.cs new file mode 100644 index 000000000000..b641da829f1e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentIntelligenceLayoutSkill.cs @@ -0,0 +1,80 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A skill that extracts content and layout information (as markdown), via Azure + /// AI Services, from files within the enrichment pipeline. + /// + public partial class DocumentIntelligenceLayoutSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public DocumentIntelligenceLayoutSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// Controls the cardinality of the output produced by the skill. Default is 'oneToMany'. + /// The depth of headers in the markdown output. Default is h6. + internal DocumentIntelligenceLayoutSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData, DocumentIntelligenceLayoutSkillOutputMode? outputMode, DocumentIntelligenceLayoutSkillMarkdownHeaderDepth? markdownHeaderDepth) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + OutputMode = outputMode; + MarkdownHeaderDepth = markdownHeaderDepth; + } + + /// Initializes a new instance of for deserialization. + internal DocumentIntelligenceLayoutSkill() + { + } + + /// Controls the cardinality of the output produced by the skill. Default is 'oneToMany'. + public DocumentIntelligenceLayoutSkillOutputMode? OutputMode { get; set; } + /// The depth of headers in the markdown output. Default is h6. + public DocumentIntelligenceLayoutSkillMarkdownHeaderDepth? MarkdownHeaderDepth { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentIntelligenceLayoutSkillMarkdownHeaderDepth.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentIntelligenceLayoutSkillMarkdownHeaderDepth.cs new file mode 100644 index 000000000000..287ae9ec519c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentIntelligenceLayoutSkillMarkdownHeaderDepth.cs @@ -0,0 +1,63 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The depth of headers in the markdown output. Default is h6. + public readonly partial struct DocumentIntelligenceLayoutSkillMarkdownHeaderDepth : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public DocumentIntelligenceLayoutSkillMarkdownHeaderDepth(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string H1Value = "h1"; + private const string H2Value = "h2"; + private const string H3Value = "h3"; + private const string H4Value = "h4"; + private const string H5Value = "h5"; + private const string H6Value = "h6"; + + /// Header level 1. + public static DocumentIntelligenceLayoutSkillMarkdownHeaderDepth H1 { get; } = new DocumentIntelligenceLayoutSkillMarkdownHeaderDepth(H1Value); + /// Header level 2. + public static DocumentIntelligenceLayoutSkillMarkdownHeaderDepth H2 { get; } = new DocumentIntelligenceLayoutSkillMarkdownHeaderDepth(H2Value); + /// Header level 3. + public static DocumentIntelligenceLayoutSkillMarkdownHeaderDepth H3 { get; } = new DocumentIntelligenceLayoutSkillMarkdownHeaderDepth(H3Value); + /// Header level 4. + public static DocumentIntelligenceLayoutSkillMarkdownHeaderDepth H4 { get; } = new DocumentIntelligenceLayoutSkillMarkdownHeaderDepth(H4Value); + /// Header level 5. + public static DocumentIntelligenceLayoutSkillMarkdownHeaderDepth H5 { get; } = new DocumentIntelligenceLayoutSkillMarkdownHeaderDepth(H5Value); + /// Header level 6. + public static DocumentIntelligenceLayoutSkillMarkdownHeaderDepth H6 { get; } = new DocumentIntelligenceLayoutSkillMarkdownHeaderDepth(H6Value); + /// Determines if two values are the same. + public static bool operator ==(DocumentIntelligenceLayoutSkillMarkdownHeaderDepth left, DocumentIntelligenceLayoutSkillMarkdownHeaderDepth right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(DocumentIntelligenceLayoutSkillMarkdownHeaderDepth left, DocumentIntelligenceLayoutSkillMarkdownHeaderDepth right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator DocumentIntelligenceLayoutSkillMarkdownHeaderDepth(string value) => new DocumentIntelligenceLayoutSkillMarkdownHeaderDepth(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is DocumentIntelligenceLayoutSkillMarkdownHeaderDepth other && Equals(other); + /// + public bool Equals(DocumentIntelligenceLayoutSkillMarkdownHeaderDepth other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentIntelligenceLayoutSkillOutputMode.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentIntelligenceLayoutSkillOutputMode.cs new file mode 100644 index 000000000000..ba059459e27b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentIntelligenceLayoutSkillOutputMode.cs @@ -0,0 +1,48 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Controls the cardinality of the output produced by the skill. Default is 'oneToMany'. + public readonly partial struct DocumentIntelligenceLayoutSkillOutputMode : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public DocumentIntelligenceLayoutSkillOutputMode(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string OneToManyValue = "oneToMany"; + + /// Specify the deepest markdown header section to parse. + public static DocumentIntelligenceLayoutSkillOutputMode OneToMany { get; } = new DocumentIntelligenceLayoutSkillOutputMode(OneToManyValue); + /// Determines if two values are the same. + public static bool operator ==(DocumentIntelligenceLayoutSkillOutputMode left, DocumentIntelligenceLayoutSkillOutputMode right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(DocumentIntelligenceLayoutSkillOutputMode left, DocumentIntelligenceLayoutSkillOutputMode right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator DocumentIntelligenceLayoutSkillOutputMode(string value) => new DocumentIntelligenceLayoutSkillOutputMode(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is DocumentIntelligenceLayoutSkillOutputMode other && Equals(other); + /// + public bool Equals(DocumentIntelligenceLayoutSkillOutputMode other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentKeysOrIds.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentKeysOrIds.Serialization.cs new file mode 100644 index 000000000000..6b306b74427b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentKeysOrIds.Serialization.cs @@ -0,0 +1,184 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class DocumentKeysOrIds : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DocumentKeysOrIds)} does not support writing '{format}' format."); + } + + if (Optional.IsCollectionDefined(DocumentKeys)) + { + writer.WritePropertyName("documentKeys"u8); + writer.WriteStartArray(); + foreach (var item in DocumentKeys) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(DatasourceDocumentIds)) + { + writer.WritePropertyName("datasourceDocumentIds"u8); + writer.WriteStartArray(); + foreach (var item in DatasourceDocumentIds) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + DocumentKeysOrIds IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DocumentKeysOrIds)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeDocumentKeysOrIds(document.RootElement, options); + } + + internal static DocumentKeysOrIds DeserializeDocumentKeysOrIds(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList documentKeys = default; + IList datasourceDocumentIds = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("documentKeys"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + documentKeys = array; + continue; + } + if (property.NameEquals("datasourceDocumentIds"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + datasourceDocumentIds = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new DocumentKeysOrIds(documentKeys ?? new ChangeTrackingList(), datasourceDocumentIds ?? new ChangeTrackingList(), serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(DocumentKeysOrIds)} does not support writing '{options.Format}' format."); + } + } + + DocumentKeysOrIds IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDocumentKeysOrIds(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(DocumentKeysOrIds)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static DocumentKeysOrIds FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDocumentKeysOrIds(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentKeysOrIds.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentKeysOrIds.cs new file mode 100644 index 000000000000..f2573432eba3 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/DocumentKeysOrIds.cs @@ -0,0 +1,71 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// The type of the keysOrIds. + public partial class DocumentKeysOrIds + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public DocumentKeysOrIds() + { + DocumentKeys = new ChangeTrackingList(); + DatasourceDocumentIds = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// document keys to be reset. + /// datasource document identifiers to be reset. + /// Keeps track of any properties unknown to the library. + internal DocumentKeysOrIds(IList documentKeys, IList datasourceDocumentIds, IDictionary serializedAdditionalRawData) + { + DocumentKeys = documentKeys; + DatasourceDocumentIds = datasourceDocumentIds; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// document keys to be reset. + public IList DocumentKeys { get; } + /// datasource document identifiers to be reset. + public IList DatasourceDocumentIds { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EdgeNGramTokenFilterSide.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EdgeNGramTokenFilterSide.cs new file mode 100644 index 000000000000..8d55de0817e3 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EdgeNGramTokenFilterSide.cs @@ -0,0 +1,51 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Specifies which side of the input an n-gram should be generated from. + public readonly partial struct EdgeNGramTokenFilterSide : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public EdgeNGramTokenFilterSide(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string FrontValue = "front"; + private const string BackValue = "back"; + + /// Specifies that the n-gram should be generated from the front of the input. + public static EdgeNGramTokenFilterSide Front { get; } = new EdgeNGramTokenFilterSide(FrontValue); + /// Specifies that the n-gram should be generated from the back of the input. + public static EdgeNGramTokenFilterSide Back { get; } = new EdgeNGramTokenFilterSide(BackValue); + /// Determines if two values are the same. + public static bool operator ==(EdgeNGramTokenFilterSide left, EdgeNGramTokenFilterSide right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(EdgeNGramTokenFilterSide left, EdgeNGramTokenFilterSide right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator EdgeNGramTokenFilterSide(string value) => new EdgeNGramTokenFilterSide(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is EdgeNGramTokenFilterSide other && Equals(other); + /// + public bool Equals(EdgeNGramTokenFilterSide other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EdgeNGramTokenFilterV2.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EdgeNGramTokenFilterV2.Serialization.cs new file mode 100644 index 000000000000..646db64d85f0 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EdgeNGramTokenFilterV2.Serialization.cs @@ -0,0 +1,183 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class EdgeNGramTokenFilterV2 : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(EdgeNGramTokenFilterV2)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(MinGram)) + { + writer.WritePropertyName("minGram"u8); + writer.WriteNumberValue(MinGram.Value); + } + if (Optional.IsDefined(MaxGram)) + { + writer.WritePropertyName("maxGram"u8); + writer.WriteNumberValue(MaxGram.Value); + } + if (Optional.IsDefined(Side)) + { + writer.WritePropertyName("side"u8); + writer.WriteStringValue(Side.Value.ToString()); + } + } + + EdgeNGramTokenFilterV2 IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(EdgeNGramTokenFilterV2)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeEdgeNGramTokenFilterV2(document.RootElement, options); + } + + internal static EdgeNGramTokenFilterV2 DeserializeEdgeNGramTokenFilterV2(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? minGram = default; + int? maxGram = default; + EdgeNGramTokenFilterSide? side = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("minGram"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + minGram = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("maxGram"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxGram = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("side"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + side = new EdgeNGramTokenFilterSide(property.Value.GetString()); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new EdgeNGramTokenFilterV2( + odataType, + name, + serializedAdditionalRawData, + minGram, + maxGram, + side); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(EdgeNGramTokenFilterV2)} does not support writing '{options.Format}' format."); + } + } + + EdgeNGramTokenFilterV2 IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeEdgeNGramTokenFilterV2(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(EdgeNGramTokenFilterV2)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new EdgeNGramTokenFilterV2 FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeEdgeNGramTokenFilterV2(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EdgeNGramTokenFilterV2.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EdgeNGramTokenFilterV2.cs new file mode 100644 index 000000000000..07de74a8ad02 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EdgeNGramTokenFilterV2.cs @@ -0,0 +1,75 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Generates n-grams of the given size(s) starting from the front or the back of + /// an input token. This token filter is implemented using Apache Lucene. + /// + public partial class EdgeNGramTokenFilterV2 : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public EdgeNGramTokenFilterV2(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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. + /// + /// Specifies which side of the input the n-gram should be generated from. Default + /// is "front". + /// + internal EdgeNGramTokenFilterV2(string odataType, string name, IDictionary serializedAdditionalRawData, int? minGram, int? maxGram, EdgeNGramTokenFilterSide? side) : base(odataType, name, serializedAdditionalRawData) + { + MinGram = minGram; + MaxGram = maxGram; + Side = side; + } + + /// Initializes a new instance of for deserialization. + internal EdgeNGramTokenFilterV2() + { + } + + /// + /// The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the + /// value of maxGram. + /// + public int? MinGram { get; set; } + /// The maximum n-gram length. Default is 2. Maximum is 300. + public int? MaxGram { get; set; } + /// + /// Specifies which side of the input the n-gram should be generated from. Default + /// is "front". + /// + public EdgeNGramTokenFilterSide? Side { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EdgeNGramTokenizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EdgeNGramTokenizer.Serialization.cs new file mode 100644 index 000000000000..87a5acaf46d6 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EdgeNGramTokenizer.Serialization.cs @@ -0,0 +1,193 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class EdgeNGramTokenizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(EdgeNGramTokenizer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(MinGram)) + { + writer.WritePropertyName("minGram"u8); + writer.WriteNumberValue(MinGram.Value); + } + if (Optional.IsDefined(MaxGram)) + { + writer.WritePropertyName("maxGram"u8); + writer.WriteNumberValue(MaxGram.Value); + } + if (Optional.IsCollectionDefined(TokenChars)) + { + writer.WritePropertyName("tokenChars"u8); + writer.WriteStartArray(); + foreach (var item in TokenChars) + { + writer.WriteStringValue(item.ToString()); + } + writer.WriteEndArray(); + } + } + + EdgeNGramTokenizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(EdgeNGramTokenizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeEdgeNGramTokenizer(document.RootElement, options); + } + + internal static EdgeNGramTokenizer DeserializeEdgeNGramTokenizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? minGram = default; + int? maxGram = default; + IList tokenChars = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("minGram"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + minGram = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("maxGram"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxGram = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("tokenChars"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(new TokenCharacterKind(item.GetString())); + } + tokenChars = array; + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new EdgeNGramTokenizer( + odataType, + name, + serializedAdditionalRawData, + minGram, + maxGram, + tokenChars ?? new ChangeTrackingList()); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(EdgeNGramTokenizer)} does not support writing '{options.Format}' format."); + } + } + + EdgeNGramTokenizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeEdgeNGramTokenizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(EdgeNGramTokenizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new EdgeNGramTokenizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeEdgeNGramTokenizer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EdgeNGramTokenizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EdgeNGramTokenizer.cs new file mode 100644 index 000000000000..9c2b3c6b4526 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EdgeNGramTokenizer.cs @@ -0,0 +1,70 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Tokenizes the input from an edge into n-grams of the given size(s). This + /// tokenizer is implemented using Apache Lucene. + /// + public partial class EdgeNGramTokenizer : LexicalTokenizer + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public EdgeNGramTokenizer(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.EdgeNGramTokenizer"; + TokenChars = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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. + /// Character classes to keep in the tokens. + internal EdgeNGramTokenizer(string odataType, string name, IDictionary serializedAdditionalRawData, int? minGram, int? maxGram, IList tokenChars) : base(odataType, name, serializedAdditionalRawData) + { + MinGram = minGram; + MaxGram = maxGram; + TokenChars = tokenChars; + } + + /// Initializes a new instance of for deserialization. + internal EdgeNGramTokenizer() + { + } + + /// + /// The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the + /// value of maxGram. + /// + public int? MinGram { get; set; } + /// The maximum n-gram length. Default is 2. Maximum is 300. + public int? MaxGram { get; set; } + /// Character classes to keep in the tokens. + public IList TokenChars { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ElisionTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ElisionTokenFilter.Serialization.cs new file mode 100644 index 000000000000..2df5770559e1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ElisionTokenFilter.Serialization.cs @@ -0,0 +1,157 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ElisionTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ElisionTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsCollectionDefined(Articles)) + { + writer.WritePropertyName("articles"u8); + writer.WriteStartArray(); + foreach (var item in Articles) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + } + + ElisionTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ElisionTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeElisionTokenFilter(document.RootElement, options); + } + + internal static ElisionTokenFilter DeserializeElisionTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList articles = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("articles"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + articles = array; + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ElisionTokenFilter(odataType, name, serializedAdditionalRawData, articles ?? new ChangeTrackingList()); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ElisionTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + ElisionTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeElisionTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ElisionTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new ElisionTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeElisionTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ElisionTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ElisionTokenFilter.cs new file mode 100644 index 000000000000..64888034257e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ElisionTokenFilter.cs @@ -0,0 +1,56 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Removes elisions. For example, "l'avion" (the plane) will be converted to + /// "avion" (plane). This token filter is implemented using Apache Lucene. + /// + public partial class ElisionTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public ElisionTokenFilter(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.ElisionTokenFilter"; + Articles = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// The set of articles to remove. + internal ElisionTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, IList articles) : base(odataType, name, serializedAdditionalRawData) + { + Articles = articles; + } + + /// Initializes a new instance of for deserialization. + internal ElisionTokenFilter() + { + } + + /// The set of articles to remove. + public IList Articles { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityCategory.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityCategory.cs new file mode 100644 index 000000000000..dcc8506854ff --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityCategory.cs @@ -0,0 +1,66 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// A string indicating what entity categories to return. + public readonly partial struct EntityCategory : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public EntityCategory(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string LocationValue = "location"; + private const string OrganizationValue = "organization"; + private const string PersonValue = "person"; + private const string QuantityValue = "quantity"; + private const string DatetimeValue = "datetime"; + private const string UrlValue = "url"; + private const string EmailValue = "email"; + + /// Entities describing a physical location. + public static EntityCategory Location { get; } = new EntityCategory(LocationValue); + /// Entities describing an organization. + public static EntityCategory Organization { get; } = new EntityCategory(OrganizationValue); + /// Entities describing a person. + public static EntityCategory Person { get; } = new EntityCategory(PersonValue); + /// Entities describing a quantity. + public static EntityCategory Quantity { get; } = new EntityCategory(QuantityValue); + /// Entities describing a date and time. + public static EntityCategory Datetime { get; } = new EntityCategory(DatetimeValue); + /// Entities describing a URL. + public static EntityCategory Url { get; } = new EntityCategory(UrlValue); + /// Entities describing an email address. + public static EntityCategory Email { get; } = new EntityCategory(EmailValue); + /// Determines if two values are the same. + public static bool operator ==(EntityCategory left, EntityCategory right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(EntityCategory left, EntityCategory right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator EntityCategory(string value) => new EntityCategory(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is EntityCategory other && Equals(other); + /// + public bool Equals(EntityCategory other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityLinkingSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityLinkingSkill.Serialization.cs new file mode 100644 index 000000000000..59f3502ad70c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityLinkingSkill.Serialization.cs @@ -0,0 +1,213 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class EntityLinkingSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(EntityLinkingSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(DefaultLanguageCode)) + { + writer.WritePropertyName("defaultLanguageCode"u8); + writer.WriteStringValue(DefaultLanguageCode); + } + if (Optional.IsDefined(MinimumPrecision)) + { + writer.WritePropertyName("minimumPrecision"u8); + writer.WriteNumberValue(MinimumPrecision.Value); + } + if (Optional.IsDefined(ModelVersion)) + { + writer.WritePropertyName("modelVersion"u8); + writer.WriteStringValue(ModelVersion); + } + } + + EntityLinkingSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(EntityLinkingSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeEntityLinkingSkill(document.RootElement, options); + } + + internal static EntityLinkingSkill DeserializeEntityLinkingSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string defaultLanguageCode = default; + double? minimumPrecision = default; + string modelVersion = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("defaultLanguageCode"u8)) + { + defaultLanguageCode = property.Value.GetString(); + continue; + } + if (property.NameEquals("minimumPrecision"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + minimumPrecision = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("modelVersion"u8)) + { + modelVersion = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new EntityLinkingSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + defaultLanguageCode, + minimumPrecision, + modelVersion); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(EntityLinkingSkill)} does not support writing '{options.Format}' format."); + } + } + + EntityLinkingSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeEntityLinkingSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(EntityLinkingSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new EntityLinkingSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeEntityLinkingSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityLinkingSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityLinkingSkill.cs new file mode 100644 index 000000000000..a7c442257cdf --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityLinkingSkill.cs @@ -0,0 +1,97 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Using the Text Analytics API, extracts linked entities from text. + public partial class EntityLinkingSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public EntityLinkingSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Text.V3.EntityLinkingSkill"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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, IDictionary serializedAdditionalRawData, string defaultLanguageCode, double? minimumPrecision, string modelVersion) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + DefaultLanguageCode = defaultLanguageCode; + MinimumPrecision = minimumPrecision; + ModelVersion = modelVersion; + } + + /// Initializes a new instance of for deserialization. + internal EntityLinkingSkill() + { + } + + /// 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. + /// + public string ModelVersion { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityRecognitionSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityRecognitionSkill.Serialization.cs new file mode 100644 index 000000000000..1ab1c9c7753f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityRecognitionSkill.Serialization.cs @@ -0,0 +1,247 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class EntityRecognitionSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(EntityRecognitionSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsCollectionDefined(Categories)) + { + writer.WritePropertyName("categories"u8); + writer.WriteStartArray(); + foreach (var item in Categories) + { + writer.WriteStringValue(item.ToString()); + } + writer.WriteEndArray(); + } + if (Optional.IsDefined(DefaultLanguageCode)) + { + writer.WritePropertyName("defaultLanguageCode"u8); + writer.WriteStringValue(DefaultLanguageCode.Value.ToString()); + } + if (Optional.IsDefined(IncludeTypelessEntities)) + { + writer.WritePropertyName("includeTypelessEntities"u8); + writer.WriteBooleanValue(IncludeTypelessEntities.Value); + } + if (Optional.IsDefined(MinimumPrecision)) + { + writer.WritePropertyName("minimumPrecision"u8); + writer.WriteNumberValue(MinimumPrecision.Value); + } + } + + EntityRecognitionSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(EntityRecognitionSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeEntityRecognitionSkill(document.RootElement, options); + } + + internal static EntityRecognitionSkill DeserializeEntityRecognitionSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList categories = default; + EntityRecognitionSkillLanguage? defaultLanguageCode = default; + bool? includeTypelessEntities = default; + double? minimumPrecision = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("categories"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(new EntityCategory(item.GetString())); + } + categories = array; + continue; + } + if (property.NameEquals("defaultLanguageCode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + defaultLanguageCode = new EntityRecognitionSkillLanguage(property.Value.GetString()); + continue; + } + if (property.NameEquals("includeTypelessEntities"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + includeTypelessEntities = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("minimumPrecision"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + minimumPrecision = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new EntityRecognitionSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + categories ?? new ChangeTrackingList(), + defaultLanguageCode, + includeTypelessEntities, + minimumPrecision); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(EntityRecognitionSkill)} does not support writing '{options.Format}' format."); + } + } + + EntityRecognitionSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeEntityRecognitionSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(EntityRecognitionSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new EntityRecognitionSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeEntityRecognitionSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityRecognitionSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityRecognitionSkill.cs new file mode 100644 index 000000000000..fe37f3cb7dc2 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityRecognitionSkill.cs @@ -0,0 +1,104 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// This skill is deprecated. Use the V3.EntityRecognitionSkill instead. + public partial class EntityRecognitionSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public EntityRecognitionSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Text.EntityRecognitionSkill"; + Categories = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// A list of entity categories that should be extracted. + /// 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, IDictionary serializedAdditionalRawData, IList categories, EntityRecognitionSkillLanguage? defaultLanguageCode, bool? includeTypelessEntities, double? minimumPrecision) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + Categories = categories; + DefaultLanguageCode = defaultLanguageCode; + IncludeTypelessEntities = includeTypelessEntities; + MinimumPrecision = minimumPrecision; + } + + /// Initializes a new instance of for deserialization. + internal EntityRecognitionSkill() + { + } + + /// A list of entity categories that should be extracted. + public IList Categories { get; } + /// A value indicating which language code to use. Default is `en`. + public EntityRecognitionSkillLanguage? DefaultLanguageCode { get; set; } + /// + /// 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. + /// + public bool? IncludeTypelessEntities { 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.Indexes/src/Generated/EntityRecognitionSkillLanguage.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityRecognitionSkillLanguage.cs new file mode 100644 index 000000000000..c65efc14e354 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityRecognitionSkillLanguage.cs @@ -0,0 +1,117 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Deprecated. The language codes supported for input text by + /// EntityRecognitionSkill. + /// + public readonly partial struct EntityRecognitionSkillLanguage : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public EntityRecognitionSkillLanguage(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string ArValue = "ar"; + private const string CsValue = "cs"; + private const string ZhHansValue = "zh-Hans"; + private const string ZhHantValue = "zh-Hant"; + private const string DaValue = "da"; + private const string NlValue = "nl"; + private const string EnValue = "en"; + private const string FiValue = "fi"; + private const string FrValue = "fr"; + private const string DeValue = "de"; + private const string ElValue = "el"; + private const string HuValue = "hu"; + private const string ItValue = "it"; + private const string JaValue = "ja"; + private const string KoValue = "ko"; + private const string NoValue = "no"; + private const string PlValue = "pl"; + private const string PtPTValue = "pt-PT"; + private const string PtBRValue = "pt-BR"; + private const string RuValue = "ru"; + private const string EsValue = "es"; + private const string SvValue = "sv"; + private const string TrValue = "tr"; + + /// Arabic. + public static EntityRecognitionSkillLanguage Ar { get; } = new EntityRecognitionSkillLanguage(ArValue); + /// Czech. + public static EntityRecognitionSkillLanguage Cs { get; } = new EntityRecognitionSkillLanguage(CsValue); + /// Chinese-Simplified. + public static EntityRecognitionSkillLanguage ZhHans { get; } = new EntityRecognitionSkillLanguage(ZhHansValue); + /// Chinese-Traditional. + public static EntityRecognitionSkillLanguage ZhHant { get; } = new EntityRecognitionSkillLanguage(ZhHantValue); + /// Danish. + public static EntityRecognitionSkillLanguage Da { get; } = new EntityRecognitionSkillLanguage(DaValue); + /// Dutch. + public static EntityRecognitionSkillLanguage Nl { get; } = new EntityRecognitionSkillLanguage(NlValue); + /// English. + public static EntityRecognitionSkillLanguage En { get; } = new EntityRecognitionSkillLanguage(EnValue); + /// Finnish. + public static EntityRecognitionSkillLanguage Fi { get; } = new EntityRecognitionSkillLanguage(FiValue); + /// French. + public static EntityRecognitionSkillLanguage Fr { get; } = new EntityRecognitionSkillLanguage(FrValue); + /// German. + public static EntityRecognitionSkillLanguage De { get; } = new EntityRecognitionSkillLanguage(DeValue); + /// Greek. + public static EntityRecognitionSkillLanguage El { get; } = new EntityRecognitionSkillLanguage(ElValue); + /// Hungarian. + public static EntityRecognitionSkillLanguage Hu { get; } = new EntityRecognitionSkillLanguage(HuValue); + /// Italian. + public static EntityRecognitionSkillLanguage It { get; } = new EntityRecognitionSkillLanguage(ItValue); + /// Japanese. + public static EntityRecognitionSkillLanguage Ja { get; } = new EntityRecognitionSkillLanguage(JaValue); + /// Korean. + public static EntityRecognitionSkillLanguage Ko { get; } = new EntityRecognitionSkillLanguage(KoValue); + /// Norwegian (Bokmaal). + public static EntityRecognitionSkillLanguage No { get; } = new EntityRecognitionSkillLanguage(NoValue); + /// Polish. + public static EntityRecognitionSkillLanguage Pl { get; } = new EntityRecognitionSkillLanguage(PlValue); + /// Portuguese (Portugal). + public static EntityRecognitionSkillLanguage PtPT { get; } = new EntityRecognitionSkillLanguage(PtPTValue); + /// Portuguese (Brazil). + public static EntityRecognitionSkillLanguage PtBR { get; } = new EntityRecognitionSkillLanguage(PtBRValue); + /// Russian. + public static EntityRecognitionSkillLanguage Ru { get; } = new EntityRecognitionSkillLanguage(RuValue); + /// Spanish. + public static EntityRecognitionSkillLanguage Es { get; } = new EntityRecognitionSkillLanguage(EsValue); + /// Swedish. + public static EntityRecognitionSkillLanguage Sv { get; } = new EntityRecognitionSkillLanguage(SvValue); + /// Turkish. + public static EntityRecognitionSkillLanguage Tr { get; } = new EntityRecognitionSkillLanguage(TrValue); + /// Determines if two values are the same. + public static bool operator ==(EntityRecognitionSkillLanguage left, EntityRecognitionSkillLanguage right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(EntityRecognitionSkillLanguage left, EntityRecognitionSkillLanguage right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator EntityRecognitionSkillLanguage(string value) => new EntityRecognitionSkillLanguage(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is EntityRecognitionSkillLanguage other && Equals(other); + /// + public bool Equals(EntityRecognitionSkillLanguage other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityRecognitionSkillV3.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityRecognitionSkillV3.Serialization.cs new file mode 100644 index 000000000000..6f2830b11555 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityRecognitionSkillV3.Serialization.cs @@ -0,0 +1,239 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class EntityRecognitionSkillV3 : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(EntityRecognitionSkillV3)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsCollectionDefined(Categories)) + { + writer.WritePropertyName("categories"u8); + writer.WriteStartArray(); + foreach (var item in Categories) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + if (Optional.IsDefined(DefaultLanguageCode)) + { + writer.WritePropertyName("defaultLanguageCode"u8); + writer.WriteStringValue(DefaultLanguageCode); + } + if (Optional.IsDefined(MinimumPrecision)) + { + writer.WritePropertyName("minimumPrecision"u8); + writer.WriteNumberValue(MinimumPrecision.Value); + } + if (Optional.IsDefined(ModelVersion)) + { + writer.WritePropertyName("modelVersion"u8); + writer.WriteStringValue(ModelVersion); + } + } + + EntityRecognitionSkillV3 IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(EntityRecognitionSkillV3)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeEntityRecognitionSkillV3(document.RootElement, options); + } + + internal static EntityRecognitionSkillV3 DeserializeEntityRecognitionSkillV3(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList categories = default; + string defaultLanguageCode = default; + double? minimumPrecision = default; + string modelVersion = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("categories"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + categories = array; + continue; + } + if (property.NameEquals("defaultLanguageCode"u8)) + { + defaultLanguageCode = property.Value.GetString(); + continue; + } + if (property.NameEquals("minimumPrecision"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + minimumPrecision = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("modelVersion"u8)) + { + modelVersion = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new EntityRecognitionSkillV3( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + categories ?? new ChangeTrackingList(), + defaultLanguageCode, + minimumPrecision, + modelVersion); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(EntityRecognitionSkillV3)} does not support writing '{options.Format}' format."); + } + } + + EntityRecognitionSkillV3 IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeEntityRecognitionSkillV3(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(EntityRecognitionSkillV3)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new EntityRecognitionSkillV3 FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeEntityRecognitionSkillV3(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityRecognitionSkillV3.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityRecognitionSkillV3.cs new file mode 100644 index 000000000000..8493caa0e088 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/EntityRecognitionSkillV3.cs @@ -0,0 +1,102 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Using the Text Analytics API, extracts entities of different types from text. + public partial class EntityRecognitionSkillV3 : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public EntityRecognitionSkillV3(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Text.V3.EntityRecognitionSkill"; + Categories = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// A list of entity categories that should be extracted. + /// 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 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, IDictionary serializedAdditionalRawData, IList categories, string defaultLanguageCode, double? minimumPrecision, string modelVersion) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + Categories = categories; + DefaultLanguageCode = defaultLanguageCode; + MinimumPrecision = minimumPrecision; + ModelVersion = modelVersion; + } + + /// Initializes a new instance of for deserialization. + internal EntityRecognitionSkillV3() + { + } + + /// A list of entity categories that should be extracted. + public IList Categories { get; } + /// 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 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.Indexes/src/Generated/ExhaustiveKnnAlgorithmConfiguration.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ExhaustiveKnnAlgorithmConfiguration.Serialization.cs new file mode 100644 index 000000000000..b58f66c63697 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ExhaustiveKnnAlgorithmConfiguration.Serialization.cs @@ -0,0 +1,147 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ExhaustiveKnnAlgorithmConfiguration : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ExhaustiveKnnAlgorithmConfiguration)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(ExhaustiveKnnParameters)) + { + writer.WritePropertyName("exhaustiveKnnParameters"u8); + writer.WriteObjectValue(ExhaustiveKnnParameters, options); + } + } + + ExhaustiveKnnAlgorithmConfiguration IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ExhaustiveKnnAlgorithmConfiguration)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeExhaustiveKnnAlgorithmConfiguration(document.RootElement, options); + } + + internal static ExhaustiveKnnAlgorithmConfiguration DeserializeExhaustiveKnnAlgorithmConfiguration(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + ExhaustiveKnnParameters exhaustiveKnnParameters = default; + string name = default; + VectorSearchAlgorithmKind kind = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("exhaustiveKnnParameters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + exhaustiveKnnParameters = ExhaustiveKnnParameters.DeserializeExhaustiveKnnParameters(property.Value, options); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorSearchAlgorithmKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ExhaustiveKnnAlgorithmConfiguration(name, kind, serializedAdditionalRawData, exhaustiveKnnParameters); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ExhaustiveKnnAlgorithmConfiguration)} does not support writing '{options.Format}' format."); + } + } + + ExhaustiveKnnAlgorithmConfiguration IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeExhaustiveKnnAlgorithmConfiguration(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ExhaustiveKnnAlgorithmConfiguration)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new ExhaustiveKnnAlgorithmConfiguration FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeExhaustiveKnnAlgorithmConfiguration(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ExhaustiveKnnAlgorithmConfiguration.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ExhaustiveKnnAlgorithmConfiguration.cs new file mode 100644 index 000000000000..033740910b11 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ExhaustiveKnnAlgorithmConfiguration.cs @@ -0,0 +1,48 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Contains configuration options specific to the exhaustive KNN algorithm used + /// during querying, which will perform brute-force search across the entire vector + /// index. + /// + public partial class ExhaustiveKnnAlgorithmConfiguration : VectorSearchAlgorithmConfiguration + { + /// Initializes a new instance of . + /// The name to associate with this particular configuration. + /// is null. + public ExhaustiveKnnAlgorithmConfiguration(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + Kind = VectorSearchAlgorithmKind.ExhaustiveKnn; + } + + /// Initializes a new instance of . + /// The name to associate with this particular configuration. + /// Type of VectorSearchAlgorithmConfiguration. + /// Keeps track of any properties unknown to the library. + /// Contains the parameters specific to exhaustive KNN algorithm. + internal ExhaustiveKnnAlgorithmConfiguration(string name, VectorSearchAlgorithmKind kind, IDictionary serializedAdditionalRawData, ExhaustiveKnnParameters exhaustiveKnnParameters) : base(name, kind, serializedAdditionalRawData) + { + ExhaustiveKnnParameters = exhaustiveKnnParameters; + } + + /// Initializes a new instance of for deserialization. + internal ExhaustiveKnnAlgorithmConfiguration() + { + } + + /// Contains the parameters specific to exhaustive KNN algorithm. + public ExhaustiveKnnParameters ExhaustiveKnnParameters { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ExhaustiveKnnParameters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ExhaustiveKnnParameters.Serialization.cs new file mode 100644 index 000000000000..ac1df384ec79 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ExhaustiveKnnParameters.Serialization.cs @@ -0,0 +1,149 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ExhaustiveKnnParameters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ExhaustiveKnnParameters)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(Metric)) + { + writer.WritePropertyName("metric"u8); + writer.WriteStringValue(Metric.Value.ToString()); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + ExhaustiveKnnParameters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ExhaustiveKnnParameters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeExhaustiveKnnParameters(document.RootElement, options); + } + + internal static ExhaustiveKnnParameters DeserializeExhaustiveKnnParameters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + VectorSearchAlgorithmMetric? metric = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("metric"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + metric = new VectorSearchAlgorithmMetric(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ExhaustiveKnnParameters(metric, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ExhaustiveKnnParameters)} does not support writing '{options.Format}' format."); + } + } + + ExhaustiveKnnParameters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeExhaustiveKnnParameters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ExhaustiveKnnParameters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static ExhaustiveKnnParameters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeExhaustiveKnnParameters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ExhaustiveKnnParameters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ExhaustiveKnnParameters.cs new file mode 100644 index 000000000000..2df5852e0a8d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ExhaustiveKnnParameters.cs @@ -0,0 +1,65 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Contains the parameters specific to exhaustive KNN algorithm. + public partial class ExhaustiveKnnParameters + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public ExhaustiveKnnParameters() + { + } + + /// Initializes a new instance of . + /// The similarity metric to use for vector comparisons. + /// Keeps track of any properties unknown to the library. + internal ExhaustiveKnnParameters(VectorSearchAlgorithmMetric? metric, IDictionary serializedAdditionalRawData) + { + Metric = metric; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The similarity metric to use for vector comparisons. + public VectorSearchAlgorithmMetric? Metric { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FieldMapping.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FieldMapping.Serialization.cs new file mode 100644 index 000000000000..97c0d9dca38e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FieldMapping.Serialization.cs @@ -0,0 +1,168 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class FieldMapping : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(FieldMapping)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("sourceFieldName"u8); + writer.WriteStringValue(SourceFieldName); + if (Optional.IsDefined(TargetFieldName)) + { + writer.WritePropertyName("targetFieldName"u8); + writer.WriteStringValue(TargetFieldName); + } + if (Optional.IsDefined(MappingFunction)) + { + writer.WritePropertyName("mappingFunction"u8); + writer.WriteObjectValue(MappingFunction, options); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + FieldMapping IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(FieldMapping)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeFieldMapping(document.RootElement, options); + } + + internal static FieldMapping DeserializeFieldMapping(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string sourceFieldName = default; + string targetFieldName = default; + FieldMappingFunction mappingFunction = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("sourceFieldName"u8)) + { + sourceFieldName = property.Value.GetString(); + continue; + } + if (property.NameEquals("targetFieldName"u8)) + { + targetFieldName = property.Value.GetString(); + continue; + } + if (property.NameEquals("mappingFunction"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + mappingFunction = FieldMappingFunction.DeserializeFieldMappingFunction(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new FieldMapping(sourceFieldName, targetFieldName, mappingFunction, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(FieldMapping)} does not support writing '{options.Format}' format."); + } + } + + FieldMapping IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeFieldMapping(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(FieldMapping)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static FieldMapping FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeFieldMapping(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FieldMapping.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FieldMapping.cs new file mode 100644 index 000000000000..bded5da06f47 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FieldMapping.cs @@ -0,0 +1,92 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Defines a mapping between a field in a data source and a target field in an + /// index. + /// + public partial class FieldMapping + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name of the field in the data source. + /// is null. + public FieldMapping(string sourceFieldName) + { + Argument.AssertNotNull(sourceFieldName, nameof(sourceFieldName)); + + SourceFieldName = sourceFieldName; + } + + /// Initializes a new instance of . + /// The name of the field in the data source. + /// + /// The name of the target field in the index. Same as the source field name by + /// default. + /// + /// A function to apply to each source field value before indexing. + /// Keeps track of any properties unknown to the library. + internal FieldMapping(string sourceFieldName, string targetFieldName, FieldMappingFunction mappingFunction, IDictionary serializedAdditionalRawData) + { + SourceFieldName = sourceFieldName; + TargetFieldName = targetFieldName; + MappingFunction = mappingFunction; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal FieldMapping() + { + } + + /// The name of the field in the data source. + public string SourceFieldName { get; set; } + /// + /// The name of the target field in the index. Same as the source field name by + /// default. + /// + public string TargetFieldName { get; set; } + /// A function to apply to each source field value before indexing. + public FieldMappingFunction MappingFunction { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FieldMappingFunction.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FieldMappingFunction.Serialization.cs new file mode 100644 index 000000000000..6e13a3e7883b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FieldMappingFunction.Serialization.cs @@ -0,0 +1,187 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class FieldMappingFunction : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(FieldMappingFunction)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + if (Optional.IsCollectionDefined(Parameters)) + { + writer.WritePropertyName("parameters"u8); + writer.WriteStartObject(); + foreach (var item in Parameters) + { + writer.WritePropertyName(item.Key); + if (item.Value == null) + { + writer.WriteNullValue(); + continue; + } +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + writer.WriteEndObject(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + FieldMappingFunction IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(FieldMappingFunction)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeFieldMappingFunction(document.RootElement, options); + } + + internal static FieldMappingFunction DeserializeFieldMappingFunction(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + IDictionary parameters = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("parameters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + Dictionary dictionary = new Dictionary(); + foreach (var property0 in property.Value.EnumerateObject()) + { + if (property0.Value.ValueKind == JsonValueKind.Null) + { + dictionary.Add(property0.Name, null); + } + else + { + dictionary.Add(property0.Name, BinaryData.FromString(property0.Value.GetRawText())); + } + } + parameters = dictionary; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new FieldMappingFunction(name, parameters ?? new ChangeTrackingDictionary(), serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(FieldMappingFunction)} does not support writing '{options.Format}' format."); + } + } + + FieldMappingFunction IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeFieldMappingFunction(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(FieldMappingFunction)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static FieldMappingFunction FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeFieldMappingFunction(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FieldMappingFunction.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FieldMappingFunction.cs new file mode 100644 index 000000000000..6d68c9a2faf0 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FieldMappingFunction.cs @@ -0,0 +1,116 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Represents a function that transforms a value from a data source before + /// indexing. + /// + public partial class FieldMappingFunction + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name of the field mapping function. + /// is null. + public FieldMappingFunction(string name) + { + Argument.AssertNotNull(name, nameof(name)); + + Name = name; + Parameters = new ChangeTrackingDictionary(); + } + + /// Initializes a new instance of . + /// The name of the field mapping function. + /// + /// A dictionary of parameter name/value pairs to pass to the function. Each value + /// must be of a primitive type. + /// + /// Keeps track of any properties unknown to the library. + internal FieldMappingFunction(string name, IDictionary parameters, IDictionary serializedAdditionalRawData) + { + Name = name; + Parameters = parameters; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal FieldMappingFunction() + { + } + + /// The name of the field mapping function. + public string Name { get; set; } + /// + /// A dictionary of parameter name/value pairs to pass to the function. Each value + /// must be of a primitive type. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + public IDictionary Parameters { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FreshnessScoringFunction.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FreshnessScoringFunction.Serialization.cs new file mode 100644 index 000000000000..dd705625e0fc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FreshnessScoringFunction.Serialization.cs @@ -0,0 +1,162 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class FreshnessScoringFunction : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(FreshnessScoringFunction)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("freshness"u8); + writer.WriteObjectValue(Freshness, options); + } + + FreshnessScoringFunction IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(FreshnessScoringFunction)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeFreshnessScoringFunction(document.RootElement, options); + } + + internal static FreshnessScoringFunction DeserializeFreshnessScoringFunction(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + FreshnessScoringParameters freshness = default; + string fieldName = default; + double boost = default; + ScoringFunctionInterpolation? interpolation = default; + string type = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("freshness"u8)) + { + freshness = FreshnessScoringParameters.DeserializeFreshnessScoringParameters(property.Value, options); + continue; + } + if (property.NameEquals("fieldName"u8)) + { + fieldName = property.Value.GetString(); + continue; + } + if (property.NameEquals("boost"u8)) + { + boost = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("interpolation"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + interpolation = new ScoringFunctionInterpolation(property.Value.GetString()); + continue; + } + if (property.NameEquals("type"u8)) + { + type = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new FreshnessScoringFunction( + fieldName, + boost, + interpolation, + type, + serializedAdditionalRawData, + freshness); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(FreshnessScoringFunction)} does not support writing '{options.Format}' format."); + } + } + + FreshnessScoringFunction IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeFreshnessScoringFunction(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(FreshnessScoringFunction)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new FreshnessScoringFunction FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeFreshnessScoringFunction(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FreshnessScoringFunction.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FreshnessScoringFunction.cs new file mode 100644 index 000000000000..bd9988bdd81f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FreshnessScoringFunction.cs @@ -0,0 +1,53 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Defines a function that boosts scores based on the value of a date-time field. + public partial class FreshnessScoringFunction : ScoringFunction + { + /// Initializes a new instance of . + /// The name of the field used as input to the scoring function. + /// A multiplier for the raw score. Must be a positive number not equal to 1.0. + /// Parameter values for the freshness scoring function. + /// or is null. + public FreshnessScoringFunction(string fieldName, double boost, FreshnessScoringParameters freshness) : base(fieldName, boost) + { + Argument.AssertNotNull(fieldName, nameof(fieldName)); + Argument.AssertNotNull(freshness, nameof(freshness)); + + Type = "freshness"; + Freshness = freshness; + } + + /// Initializes a new instance of . + /// The name of the field used as input to the scoring function. + /// A multiplier for the raw score. Must be a positive number not equal to 1.0. + /// + /// A value indicating how boosting will be interpolated across document scores; + /// defaults to "Linear". + /// + /// Type of ScoringFunction. + /// Keeps track of any properties unknown to the library. + /// Parameter values for the freshness scoring function. + internal FreshnessScoringFunction(string fieldName, double boost, ScoringFunctionInterpolation? interpolation, string type, IDictionary serializedAdditionalRawData, FreshnessScoringParameters freshness) : base(fieldName, boost, interpolation, type, serializedAdditionalRawData) + { + Freshness = freshness; + } + + /// Initializes a new instance of for deserialization. + internal FreshnessScoringFunction() + { + } + + /// Parameter values for the freshness scoring function. + public FreshnessScoringParameters Freshness { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FreshnessScoringParameters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FreshnessScoringParameters.Serialization.cs new file mode 100644 index 000000000000..346da284121b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FreshnessScoringParameters.Serialization.cs @@ -0,0 +1,142 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class FreshnessScoringParameters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(FreshnessScoringParameters)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("boostingDuration"u8); + writer.WriteStringValue(BoostingDuration, "P"); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + FreshnessScoringParameters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(FreshnessScoringParameters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeFreshnessScoringParameters(document.RootElement, options); + } + + internal static FreshnessScoringParameters DeserializeFreshnessScoringParameters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + TimeSpan boostingDuration = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("boostingDuration"u8)) + { + boostingDuration = property.Value.GetTimeSpan("P"); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new FreshnessScoringParameters(boostingDuration, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(FreshnessScoringParameters)} does not support writing '{options.Format}' format."); + } + } + + FreshnessScoringParameters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeFreshnessScoringParameters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(FreshnessScoringParameters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static FreshnessScoringParameters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeFreshnessScoringParameters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FreshnessScoringParameters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FreshnessScoringParameters.cs new file mode 100644 index 000000000000..915998750068 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/FreshnessScoringParameters.cs @@ -0,0 +1,72 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Provides parameter values to a freshness scoring function. + public partial class FreshnessScoringParameters + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The expiration period after which boosting will stop for a particular document. + public FreshnessScoringParameters(TimeSpan boostingDuration) + { + BoostingDuration = boostingDuration; + } + + /// Initializes a new instance of . + /// The expiration period after which boosting will stop for a particular document. + /// Keeps track of any properties unknown to the library. + internal FreshnessScoringParameters(TimeSpan boostingDuration, IDictionary serializedAdditionalRawData) + { + BoostingDuration = boostingDuration; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal FreshnessScoringParameters() + { + } + + /// The expiration period after which boosting will stop for a particular document. + public TimeSpan BoostingDuration { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/GetIndexStatisticsResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/GetIndexStatisticsResult.Serialization.cs new file mode 100644 index 000000000000..0b51869f1cae --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/GetIndexStatisticsResult.Serialization.cs @@ -0,0 +1,158 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class GetIndexStatisticsResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(GetIndexStatisticsResult)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("documentCount"u8); + writer.WriteNumberValue(DocumentCount); + writer.WritePropertyName("storageSize"u8); + writer.WriteNumberValue(StorageSize); + writer.WritePropertyName("vectorIndexSize"u8); + writer.WriteNumberValue(VectorIndexSize); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + GetIndexStatisticsResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(GetIndexStatisticsResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeGetIndexStatisticsResult(document.RootElement, options); + } + + internal static GetIndexStatisticsResult DeserializeGetIndexStatisticsResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + long documentCount = default; + long storageSize = default; + long vectorIndexSize = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("documentCount"u8)) + { + documentCount = property.Value.GetInt64(); + continue; + } + if (property.NameEquals("storageSize"u8)) + { + storageSize = property.Value.GetInt64(); + continue; + } + if (property.NameEquals("vectorIndexSize"u8)) + { + vectorIndexSize = property.Value.GetInt64(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new GetIndexStatisticsResult(documentCount, storageSize, vectorIndexSize, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(GetIndexStatisticsResult)} does not support writing '{options.Format}' format."); + } + } + + GetIndexStatisticsResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeGetIndexStatisticsResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(GetIndexStatisticsResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static GetIndexStatisticsResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeGetIndexStatisticsResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/GetIndexStatisticsResult.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/GetIndexStatisticsResult.cs new file mode 100644 index 000000000000..2fa5ab1600bc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/GetIndexStatisticsResult.cs @@ -0,0 +1,87 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Statistics for a given index. Statistics are collected periodically and are not + /// guaranteed to always be up-to-date. + /// + public partial class GetIndexStatisticsResult + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The number of documents in the index. + /// The amount of storage in bytes consumed by the index. + /// The amount of memory in bytes consumed by vectors in the index. + internal GetIndexStatisticsResult(long documentCount, long storageSize, long vectorIndexSize) + { + DocumentCount = documentCount; + StorageSize = storageSize; + VectorIndexSize = vectorIndexSize; + } + + /// Initializes a new instance of . + /// The number of documents in the index. + /// The amount of storage in bytes consumed by the index. + /// The amount of memory in bytes consumed by vectors in the index. + /// Keeps track of any properties unknown to the library. + internal GetIndexStatisticsResult(long documentCount, long storageSize, long vectorIndexSize, IDictionary serializedAdditionalRawData) + { + DocumentCount = documentCount; + StorageSize = storageSize; + VectorIndexSize = vectorIndexSize; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal GetIndexStatisticsResult() + { + } + + /// The number of documents in the index. + public long DocumentCount { get; } + /// The amount of storage in bytes consumed by the index. + public long StorageSize { get; } + /// The amount of memory in bytes consumed by vectors in the index. + public long VectorIndexSize { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HighWaterMarkChangeDetectionPolicy.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HighWaterMarkChangeDetectionPolicy.Serialization.cs new file mode 100644 index 000000000000..b7d2166975a7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HighWaterMarkChangeDetectionPolicy.Serialization.cs @@ -0,0 +1,134 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class HighWaterMarkChangeDetectionPolicy : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(HighWaterMarkChangeDetectionPolicy)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("highWaterMarkColumnName"u8); + writer.WriteStringValue(HighWaterMarkColumnName); + } + + HighWaterMarkChangeDetectionPolicy IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(HighWaterMarkChangeDetectionPolicy)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeHighWaterMarkChangeDetectionPolicy(document.RootElement, options); + } + + internal static HighWaterMarkChangeDetectionPolicy DeserializeHighWaterMarkChangeDetectionPolicy(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string highWaterMarkColumnName = default; + string odataType = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("highWaterMarkColumnName"u8)) + { + highWaterMarkColumnName = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new HighWaterMarkChangeDetectionPolicy(odataType, serializedAdditionalRawData, highWaterMarkColumnName); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(HighWaterMarkChangeDetectionPolicy)} does not support writing '{options.Format}' format."); + } + } + + HighWaterMarkChangeDetectionPolicy IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeHighWaterMarkChangeDetectionPolicy(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(HighWaterMarkChangeDetectionPolicy)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new HighWaterMarkChangeDetectionPolicy FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeHighWaterMarkChangeDetectionPolicy(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HighWaterMarkChangeDetectionPolicy.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HighWaterMarkChangeDetectionPolicy.cs new file mode 100644 index 000000000000..93133305498f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HighWaterMarkChangeDetectionPolicy.cs @@ -0,0 +1,47 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Defines a data change detection policy that captures changes based on the value + /// of a high water mark column. + /// + public partial class HighWaterMarkChangeDetectionPolicy : DataChangeDetectionPolicy + { + /// Initializes a new instance of . + /// The name of the high water mark column. + /// is null. + public HighWaterMarkChangeDetectionPolicy(string highWaterMarkColumnName) + { + Argument.AssertNotNull(highWaterMarkColumnName, nameof(highWaterMarkColumnName)); + + OdataType = "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy"; + HighWaterMarkColumnName = highWaterMarkColumnName; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Keeps track of any properties unknown to the library. + /// The name of the high water mark column. + internal HighWaterMarkChangeDetectionPolicy(string odataType, IDictionary serializedAdditionalRawData, string highWaterMarkColumnName) : base(odataType, serializedAdditionalRawData) + { + HighWaterMarkColumnName = highWaterMarkColumnName; + } + + /// Initializes a new instance of for deserialization. + internal HighWaterMarkChangeDetectionPolicy() + { + } + + /// The name of the high water mark column. + public string HighWaterMarkColumnName { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HnswAlgorithmConfiguration.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HnswAlgorithmConfiguration.Serialization.cs new file mode 100644 index 000000000000..af158851cd50 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HnswAlgorithmConfiguration.Serialization.cs @@ -0,0 +1,147 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class HnswAlgorithmConfiguration : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(HnswAlgorithmConfiguration)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(HnswParameters)) + { + writer.WritePropertyName("hnswParameters"u8); + writer.WriteObjectValue(HnswParameters, options); + } + } + + HnswAlgorithmConfiguration IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(HnswAlgorithmConfiguration)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeHnswAlgorithmConfiguration(document.RootElement, options); + } + + internal static HnswAlgorithmConfiguration DeserializeHnswAlgorithmConfiguration(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + HnswParameters hnswParameters = default; + string name = default; + VectorSearchAlgorithmKind kind = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("hnswParameters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + hnswParameters = HnswParameters.DeserializeHnswParameters(property.Value, options); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorSearchAlgorithmKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new HnswAlgorithmConfiguration(name, kind, serializedAdditionalRawData, hnswParameters); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(HnswAlgorithmConfiguration)} does not support writing '{options.Format}' format."); + } + } + + HnswAlgorithmConfiguration IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeHnswAlgorithmConfiguration(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(HnswAlgorithmConfiguration)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new HnswAlgorithmConfiguration FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeHnswAlgorithmConfiguration(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HnswAlgorithmConfiguration.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HnswAlgorithmConfiguration.cs new file mode 100644 index 000000000000..4279b1071e72 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HnswAlgorithmConfiguration.cs @@ -0,0 +1,48 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// 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 HnswAlgorithmConfiguration : VectorSearchAlgorithmConfiguration + { + /// Initializes a new instance of . + /// The name to associate with this particular configuration. + /// is null. + public HnswAlgorithmConfiguration(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + Kind = VectorSearchAlgorithmKind.Hnsw; + } + + /// Initializes a new instance of . + /// The name to associate with this particular configuration. + /// Type of VectorSearchAlgorithmConfiguration. + /// Keeps track of any properties unknown to the library. + /// Contains the parameters specific to HNSW algorithm. + internal HnswAlgorithmConfiguration(string name, VectorSearchAlgorithmKind kind, IDictionary serializedAdditionalRawData, HnswParameters hnswParameters) : base(name, kind, serializedAdditionalRawData) + { + HnswParameters = hnswParameters; + } + + /// Initializes a new instance of for deserialization. + internal HnswAlgorithmConfiguration() + { + } + + /// Contains the parameters specific to HNSW algorithm. + public HnswParameters HnswParameters { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HnswParameters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HnswParameters.Serialization.cs new file mode 100644 index 000000000000..7c22c079b62e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HnswParameters.Serialization.cs @@ -0,0 +1,194 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class HnswParameters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(HnswParameters)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(M)) + { + writer.WritePropertyName("m"u8); + writer.WriteNumberValue(M.Value); + } + if (Optional.IsDefined(EfConstruction)) + { + writer.WritePropertyName("efConstruction"u8); + writer.WriteNumberValue(EfConstruction.Value); + } + if (Optional.IsDefined(EfSearch)) + { + writer.WritePropertyName("efSearch"u8); + writer.WriteNumberValue(EfSearch.Value); + } + if (Optional.IsDefined(Metric)) + { + writer.WritePropertyName("metric"u8); + writer.WriteStringValue(Metric.Value.ToString()); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + HnswParameters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(HnswParameters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeHnswParameters(document.RootElement, options); + } + + internal static HnswParameters DeserializeHnswParameters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? m = default; + int? efConstruction = default; + int? efSearch = default; + VectorSearchAlgorithmMetric? metric = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("m"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + m = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("efConstruction"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + efConstruction = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("efSearch"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + efSearch = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("metric"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + metric = new VectorSearchAlgorithmMetric(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new HnswParameters(m, efConstruction, efSearch, metric, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(HnswParameters)} does not support writing '{options.Format}' format."); + } + } + + HnswParameters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeHnswParameters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(HnswParameters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static HnswParameters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeHnswParameters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HnswParameters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HnswParameters.cs new file mode 100644 index 000000000000..bfeb5753a9e7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/HnswParameters.cs @@ -0,0 +1,107 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Contains the parameters specific to the HNSW algorithm. + public partial class HnswParameters + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public HnswParameters() + { + } + + /// Initializes a new instance of . + /// + /// The number of bi-directional links created for every new element during + /// construction. Increasing this parameter value may improve recall and reduce + /// retrieval times for datasets with high intrinsic dimensionality at the expense + /// of increased memory consumption and longer indexing time. + /// + /// + /// The size of the dynamic list containing the nearest neighbors, which is used + /// during index time. Increasing this parameter may improve index quality, at the + /// expense of increased indexing time. At a certain point, increasing this + /// parameter leads to diminishing returns. + /// + /// + /// The size of the dynamic list containing the nearest neighbors, which is used + /// during search time. Increasing this parameter may improve search results, at + /// the expense of slower search. At a certain point, increasing this parameter + /// leads to diminishing returns. + /// + /// The similarity metric to use for vector comparisons. + /// Keeps track of any properties unknown to the library. + internal HnswParameters(int? m, int? efConstruction, int? efSearch, VectorSearchAlgorithmMetric? metric, IDictionary serializedAdditionalRawData) + { + M = m; + EfConstruction = efConstruction; + EfSearch = efSearch; + Metric = metric; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// + /// The number of bi-directional links created for every new element during + /// construction. Increasing this parameter value may improve recall and reduce + /// retrieval times for datasets with high intrinsic dimensionality at the expense + /// of increased memory consumption and longer indexing time. + /// + public int? M { get; set; } + /// + /// The size of the dynamic list containing the nearest neighbors, which is used + /// during index time. Increasing this parameter may improve index quality, at the + /// expense of increased indexing time. At a certain point, increasing this + /// parameter leads to diminishing returns. + /// + public int? EfConstruction { get; set; } + /// + /// The size of the dynamic list containing the nearest neighbors, which is used + /// during search time. Increasing this parameter may improve search results, at + /// the expense of slower search. At a certain point, increasing this parameter + /// leads to diminishing returns. + /// + public int? EfSearch { get; set; } + /// The similarity metric to use for vector comparisons. + public VectorSearchAlgorithmMetric? Metric { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ImageAnalysisSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ImageAnalysisSkill.Serialization.cs new file mode 100644 index 000000000000..fee47d10538b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ImageAnalysisSkill.Serialization.cs @@ -0,0 +1,241 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ImageAnalysisSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ImageAnalysisSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(DefaultLanguageCode)) + { + writer.WritePropertyName("defaultLanguageCode"u8); + writer.WriteStringValue(DefaultLanguageCode.Value.ToString()); + } + if (Optional.IsCollectionDefined(VisualFeatures)) + { + writer.WritePropertyName("visualFeatures"u8); + writer.WriteStartArray(); + foreach (var item in VisualFeatures) + { + writer.WriteStringValue(item.ToString()); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(Details)) + { + writer.WritePropertyName("details"u8); + writer.WriteStartArray(); + foreach (var item in Details) + { + writer.WriteStringValue(item.ToString()); + } + writer.WriteEndArray(); + } + } + + ImageAnalysisSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ImageAnalysisSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeImageAnalysisSkill(document.RootElement, options); + } + + internal static ImageAnalysisSkill DeserializeImageAnalysisSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + ImageAnalysisSkillLanguage? defaultLanguageCode = default; + IList visualFeatures = default; + IList details = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("defaultLanguageCode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + defaultLanguageCode = new ImageAnalysisSkillLanguage(property.Value.GetString()); + continue; + } + if (property.NameEquals("visualFeatures"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(new VisualFeature(item.GetString())); + } + visualFeatures = array; + continue; + } + if (property.NameEquals("details"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(new ImageDetail(item.GetString())); + } + details = array; + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ImageAnalysisSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + defaultLanguageCode, + visualFeatures ?? new ChangeTrackingList(), + details ?? new ChangeTrackingList()); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ImageAnalysisSkill)} does not support writing '{options.Format}' format."); + } + } + + ImageAnalysisSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeImageAnalysisSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ImageAnalysisSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new ImageAnalysisSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeImageAnalysisSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ImageAnalysisSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ImageAnalysisSkill.cs new file mode 100644 index 000000000000..35e1d4bd8136 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ImageAnalysisSkill.cs @@ -0,0 +1,86 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A skill that analyzes image files. It extracts a rich set of visual features + /// based on the image content. + /// + public partial class ImageAnalysisSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public ImageAnalysisSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Vision.ImageAnalysisSkill"; + VisualFeatures = new ChangeTrackingList(); + Details = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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, IDictionary serializedAdditionalRawData, ImageAnalysisSkillLanguage? defaultLanguageCode, IList visualFeatures, IList details) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + DefaultLanguageCode = defaultLanguageCode; + VisualFeatures = visualFeatures; + Details = details; + } + + /// Initializes a new instance of for deserialization. + internal ImageAnalysisSkill() + { + } + + /// A value indicating which language code to use. Default is `en`. + public ImageAnalysisSkillLanguage? DefaultLanguageCode { get; set; } + /// A list of visual features. + public IList VisualFeatures { get; } + /// A string indicating which domain-specific details to return. + public IList Details { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ImageAnalysisSkillLanguage.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ImageAnalysisSkillLanguage.cs new file mode 100644 index 000000000000..0a137123b196 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ImageAnalysisSkillLanguage.cs @@ -0,0 +1,201 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The language codes supported for input by ImageAnalysisSkill. + public readonly partial struct ImageAnalysisSkillLanguage : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public ImageAnalysisSkillLanguage(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string ArValue = "ar"; + private const string AzValue = "az"; + private const string BgValue = "bg"; + private const string BsValue = "bs"; + private const string CaValue = "ca"; + private const string CsValue = "cs"; + private const string CyValue = "cy"; + private const string DaValue = "da"; + private const string DeValue = "de"; + private const string ElValue = "el"; + private const string EnValue = "en"; + private const string EsValue = "es"; + private const string EtValue = "et"; + private const string EuValue = "eu"; + private const string FiValue = "fi"; + private const string FrValue = "fr"; + private const string GaValue = "ga"; + private const string GlValue = "gl"; + private const string HeValue = "he"; + private const string HiValue = "hi"; + private const string HrValue = "hr"; + private const string HuValue = "hu"; + private const string IdValue = "id"; + private const string ItValue = "it"; + private const string JaValue = "ja"; + private const string KkValue = "kk"; + private const string KoValue = "ko"; + private const string LtValue = "lt"; + private const string LvValue = "lv"; + private const string MkValue = "mk"; + private const string MsValue = "ms"; + private const string NbValue = "nb"; + private const string NlValue = "nl"; + private const string PlValue = "pl"; + private const string PrsValue = "prs"; + private const string PtBRValue = "pt-BR"; + private const string PtValue = "pt"; + private const string PtPTValue = "pt-PT"; + private const string RoValue = "ro"; + private const string RuValue = "ru"; + private const string SkValue = "sk"; + private const string SlValue = "sl"; + private const string SrCyrlValue = "sr-Cyrl"; + private const string SrLatnValue = "sr-Latn"; + private const string SvValue = "sv"; + private const string ThValue = "th"; + private const string TrValue = "tr"; + private const string UkValue = "uk"; + private const string ViValue = "vi"; + private const string ZhValue = "zh"; + private const string ZhHansValue = "zh-Hans"; + private const string ZhHantValue = "zh-Hant"; + + /// Arabic. + public static ImageAnalysisSkillLanguage Ar { get; } = new ImageAnalysisSkillLanguage(ArValue); + /// Azerbaijani. + public static ImageAnalysisSkillLanguage Az { get; } = new ImageAnalysisSkillLanguage(AzValue); + /// Bulgarian. + public static ImageAnalysisSkillLanguage Bg { get; } = new ImageAnalysisSkillLanguage(BgValue); + /// Bosnian Latin. + public static ImageAnalysisSkillLanguage Bs { get; } = new ImageAnalysisSkillLanguage(BsValue); + /// Catalan. + public static ImageAnalysisSkillLanguage Ca { get; } = new ImageAnalysisSkillLanguage(CaValue); + /// Czech. + public static ImageAnalysisSkillLanguage Cs { get; } = new ImageAnalysisSkillLanguage(CsValue); + /// Welsh. + public static ImageAnalysisSkillLanguage Cy { get; } = new ImageAnalysisSkillLanguage(CyValue); + /// Danish. + public static ImageAnalysisSkillLanguage Da { get; } = new ImageAnalysisSkillLanguage(DaValue); + /// German. + public static ImageAnalysisSkillLanguage De { get; } = new ImageAnalysisSkillLanguage(DeValue); + /// Greek. + public static ImageAnalysisSkillLanguage El { get; } = new ImageAnalysisSkillLanguage(ElValue); + /// English. + public static ImageAnalysisSkillLanguage En { get; } = new ImageAnalysisSkillLanguage(EnValue); + /// Spanish. + public static ImageAnalysisSkillLanguage Es { get; } = new ImageAnalysisSkillLanguage(EsValue); + /// Estonian. + public static ImageAnalysisSkillLanguage Et { get; } = new ImageAnalysisSkillLanguage(EtValue); + /// Basque. + public static ImageAnalysisSkillLanguage Eu { get; } = new ImageAnalysisSkillLanguage(EuValue); + /// Finnish. + public static ImageAnalysisSkillLanguage Fi { get; } = new ImageAnalysisSkillLanguage(FiValue); + /// French. + public static ImageAnalysisSkillLanguage Fr { get; } = new ImageAnalysisSkillLanguage(FrValue); + /// Irish. + public static ImageAnalysisSkillLanguage Ga { get; } = new ImageAnalysisSkillLanguage(GaValue); + /// Galician. + public static ImageAnalysisSkillLanguage Gl { get; } = new ImageAnalysisSkillLanguage(GlValue); + /// Hebrew. + public static ImageAnalysisSkillLanguage He { get; } = new ImageAnalysisSkillLanguage(HeValue); + /// Hindi. + public static ImageAnalysisSkillLanguage Hi { get; } = new ImageAnalysisSkillLanguage(HiValue); + /// Croatian. + public static ImageAnalysisSkillLanguage Hr { get; } = new ImageAnalysisSkillLanguage(HrValue); + /// Hungarian. + public static ImageAnalysisSkillLanguage Hu { get; } = new ImageAnalysisSkillLanguage(HuValue); + /// Indonesian. + public static ImageAnalysisSkillLanguage Id { get; } = new ImageAnalysisSkillLanguage(IdValue); + /// Italian. + public static ImageAnalysisSkillLanguage It { get; } = new ImageAnalysisSkillLanguage(ItValue); + /// Japanese. + public static ImageAnalysisSkillLanguage Ja { get; } = new ImageAnalysisSkillLanguage(JaValue); + /// Kazakh. + public static ImageAnalysisSkillLanguage Kk { get; } = new ImageAnalysisSkillLanguage(KkValue); + /// Korean. + public static ImageAnalysisSkillLanguage Ko { get; } = new ImageAnalysisSkillLanguage(KoValue); + /// Lithuanian. + public static ImageAnalysisSkillLanguage Lt { get; } = new ImageAnalysisSkillLanguage(LtValue); + /// Latvian. + public static ImageAnalysisSkillLanguage Lv { get; } = new ImageAnalysisSkillLanguage(LvValue); + /// Macedonian. + public static ImageAnalysisSkillLanguage Mk { get; } = new ImageAnalysisSkillLanguage(MkValue); + /// Malay Malaysia. + public static ImageAnalysisSkillLanguage Ms { get; } = new ImageAnalysisSkillLanguage(MsValue); + /// Norwegian (Bokmal). + public static ImageAnalysisSkillLanguage Nb { get; } = new ImageAnalysisSkillLanguage(NbValue); + /// Dutch. + public static ImageAnalysisSkillLanguage Nl { get; } = new ImageAnalysisSkillLanguage(NlValue); + /// Polish. + public static ImageAnalysisSkillLanguage Pl { get; } = new ImageAnalysisSkillLanguage(PlValue); + /// Dari. + public static ImageAnalysisSkillLanguage Prs { get; } = new ImageAnalysisSkillLanguage(PrsValue); + /// Portuguese-Brazil. + public static ImageAnalysisSkillLanguage PtBR { get; } = new ImageAnalysisSkillLanguage(PtBRValue); + /// Portuguese-Portugal. + public static ImageAnalysisSkillLanguage Pt { get; } = new ImageAnalysisSkillLanguage(PtValue); + /// Portuguese-Portugal. + public static ImageAnalysisSkillLanguage PtPT { get; } = new ImageAnalysisSkillLanguage(PtPTValue); + /// Romanian. + public static ImageAnalysisSkillLanguage Ro { get; } = new ImageAnalysisSkillLanguage(RoValue); + /// Russian. + public static ImageAnalysisSkillLanguage Ru { get; } = new ImageAnalysisSkillLanguage(RuValue); + /// Slovak. + public static ImageAnalysisSkillLanguage Sk { get; } = new ImageAnalysisSkillLanguage(SkValue); + /// Slovenian. + public static ImageAnalysisSkillLanguage Sl { get; } = new ImageAnalysisSkillLanguage(SlValue); + /// Serbian - Cyrillic RS. + public static ImageAnalysisSkillLanguage SrCyrl { get; } = new ImageAnalysisSkillLanguage(SrCyrlValue); + /// Serbian - Latin RS. + public static ImageAnalysisSkillLanguage SrLatn { get; } = new ImageAnalysisSkillLanguage(SrLatnValue); + /// Swedish. + public static ImageAnalysisSkillLanguage Sv { get; } = new ImageAnalysisSkillLanguage(SvValue); + /// Thai. + public static ImageAnalysisSkillLanguage Th { get; } = new ImageAnalysisSkillLanguage(ThValue); + /// Turkish. + public static ImageAnalysisSkillLanguage Tr { get; } = new ImageAnalysisSkillLanguage(TrValue); + /// Ukrainian. + public static ImageAnalysisSkillLanguage Uk { get; } = new ImageAnalysisSkillLanguage(UkValue); + /// Vietnamese. + public static ImageAnalysisSkillLanguage Vi { get; } = new ImageAnalysisSkillLanguage(ViValue); + /// Chinese Simplified. + public static ImageAnalysisSkillLanguage Zh { get; } = new ImageAnalysisSkillLanguage(ZhValue); + /// Chinese Simplified. + public static ImageAnalysisSkillLanguage ZhHans { get; } = new ImageAnalysisSkillLanguage(ZhHansValue); + /// Chinese Traditional. + public static ImageAnalysisSkillLanguage ZhHant { get; } = new ImageAnalysisSkillLanguage(ZhHantValue); + /// Determines if two values are the same. + public static bool operator ==(ImageAnalysisSkillLanguage left, ImageAnalysisSkillLanguage right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(ImageAnalysisSkillLanguage left, ImageAnalysisSkillLanguage right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator ImageAnalysisSkillLanguage(string value) => new ImageAnalysisSkillLanguage(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is ImageAnalysisSkillLanguage other && Equals(other); + /// + public bool Equals(ImageAnalysisSkillLanguage other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ImageDetail.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ImageDetail.cs new file mode 100644 index 000000000000..217a876ec0c1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ImageDetail.cs @@ -0,0 +1,51 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// A string indicating which domain-specific details to return. + public readonly partial struct ImageDetail : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public ImageDetail(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string CelebritiesValue = "celebrities"; + private const string LandmarksValue = "landmarks"; + + /// Details recognized as celebrities. + public static ImageDetail Celebrities { get; } = new ImageDetail(CelebritiesValue); + /// Details recognized as landmarks. + public static ImageDetail Landmarks { get; } = new ImageDetail(LandmarksValue); + /// Determines if two values are the same. + public static bool operator ==(ImageDetail left, ImageDetail right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(ImageDetail left, ImageDetail right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator ImageDetail(string value) => new ImageDetail(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is ImageDetail other && Equals(other); + /// + public bool Equals(ImageDetail other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexProjectionMode.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexProjectionMode.cs new file mode 100644 index 000000000000..49689bf70436 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexProjectionMode.cs @@ -0,0 +1,60 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Defines behavior of the index projections in relation to the rest of the + /// indexer. + /// + public readonly partial struct IndexProjectionMode : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public IndexProjectionMode(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string SkipIndexingParentDocumentsValue = "skipIndexingParentDocuments"; + private const string IncludeIndexingParentDocumentsValue = "includeIndexingParentDocuments"; + + /// + /// The source document will be skipped from writing into the indexer's target + /// index. + /// + public static IndexProjectionMode SkipIndexingParentDocuments { get; } = new IndexProjectionMode(SkipIndexingParentDocumentsValue); + /// + /// The source document will be written into the indexer's target index. This is + /// the default pattern. + /// + public static IndexProjectionMode IncludeIndexingParentDocuments { get; } = new IndexProjectionMode(IncludeIndexingParentDocumentsValue); + /// Determines if two values are the same. + public static bool operator ==(IndexProjectionMode left, IndexProjectionMode right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(IndexProjectionMode left, IndexProjectionMode right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator IndexProjectionMode(string value) => new IndexProjectionMode(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is IndexProjectionMode other && Equals(other); + /// + public bool Equals(IndexProjectionMode other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexStatisticsSummary.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexStatisticsSummary.Serialization.cs new file mode 100644 index 000000000000..3f70f0ae37f8 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexStatisticsSummary.Serialization.cs @@ -0,0 +1,182 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class IndexStatisticsSummary : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexStatisticsSummary)} does not support writing '{format}' format."); + } + + if (options.Format != "W") + { + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + } + if (options.Format != "W") + { + writer.WritePropertyName("documentCount"u8); + writer.WriteNumberValue(DocumentCount); + } + if (options.Format != "W") + { + writer.WritePropertyName("storageSize"u8); + writer.WriteNumberValue(StorageSize); + } + if (options.Format != "W" && Optional.IsDefined(VectorIndexSize)) + { + writer.WritePropertyName("vectorIndexSize"u8); + writer.WriteNumberValue(VectorIndexSize.Value); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + IndexStatisticsSummary IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexStatisticsSummary)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeIndexStatisticsSummary(document.RootElement, options); + } + + internal static IndexStatisticsSummary DeserializeIndexStatisticsSummary(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + long documentCount = default; + long storageSize = default; + long? vectorIndexSize = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("documentCount"u8)) + { + documentCount = property.Value.GetInt64(); + continue; + } + if (property.NameEquals("storageSize"u8)) + { + storageSize = property.Value.GetInt64(); + continue; + } + if (property.NameEquals("vectorIndexSize"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + vectorIndexSize = property.Value.GetInt64(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new IndexStatisticsSummary(name, documentCount, storageSize, vectorIndexSize, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(IndexStatisticsSummary)} does not support writing '{options.Format}' format."); + } + } + + IndexStatisticsSummary IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexStatisticsSummary(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(IndexStatisticsSummary)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static IndexStatisticsSummary FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexStatisticsSummary(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexStatisticsSummary.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexStatisticsSummary.cs new file mode 100644 index 000000000000..c25131d029d0 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexStatisticsSummary.cs @@ -0,0 +1,77 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date. + public partial class IndexStatisticsSummary + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + internal IndexStatisticsSummary() + { + } + + /// Initializes a new instance of . + /// The name of the index. + /// The number of documents in the index. + /// The amount of storage in bytes consumed by the index. + /// The amount of memory in bytes consumed by vectors in the index. + /// Keeps track of any properties unknown to the library. + internal IndexStatisticsSummary(string name, long documentCount, long storageSize, long? vectorIndexSize, IDictionary serializedAdditionalRawData) + { + Name = name; + DocumentCount = documentCount; + StorageSize = storageSize; + VectorIndexSize = vectorIndexSize; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The name of the index. + public string Name { get; } + /// The number of documents in the index. + public long DocumentCount { get; } + /// The amount of storage in bytes consumed by the index. + public long StorageSize { get; } + /// The amount of memory in bytes consumed by vectors in the index. + public long? VectorIndexSize { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerCurrentState.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerCurrentState.Serialization.cs new file mode 100644 index 000000000000..0aa0f054527f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerCurrentState.Serialization.cs @@ -0,0 +1,251 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class IndexerCurrentState : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexerCurrentState)} does not support writing '{format}' format."); + } + + if (options.Format != "W" && Optional.IsDefined(Mode)) + { + writer.WritePropertyName("mode"u8); + writer.WriteStringValue(Mode.Value.ToString()); + } + if (options.Format != "W" && Optional.IsDefined(AllDocsInitialChangeTrackingState)) + { + writer.WritePropertyName("allDocsInitialChangeTrackingState"u8); + writer.WriteStringValue(AllDocsInitialChangeTrackingState); + } + if (options.Format != "W" && Optional.IsDefined(AllDocsFinalChangeTrackingState)) + { + writer.WritePropertyName("allDocsFinalChangeTrackingState"u8); + writer.WriteStringValue(AllDocsFinalChangeTrackingState); + } + if (options.Format != "W" && Optional.IsDefined(ResetDocsInitialChangeTrackingState)) + { + writer.WritePropertyName("resetDocsInitialChangeTrackingState"u8); + writer.WriteStringValue(ResetDocsInitialChangeTrackingState); + } + if (options.Format != "W" && Optional.IsDefined(ResetDocsFinalChangeTrackingState)) + { + writer.WritePropertyName("resetDocsFinalChangeTrackingState"u8); + writer.WriteStringValue(ResetDocsFinalChangeTrackingState); + } + if (options.Format != "W" && Optional.IsCollectionDefined(ResetDocumentKeys)) + { + writer.WritePropertyName("resetDocumentKeys"u8); + writer.WriteStartArray(); + foreach (var item in ResetDocumentKeys) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && Optional.IsCollectionDefined(ResetDatasourceDocumentIds)) + { + writer.WritePropertyName("resetDatasourceDocumentIds"u8); + writer.WriteStartArray(); + foreach (var item in ResetDatasourceDocumentIds) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + IndexerCurrentState IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexerCurrentState)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeIndexerCurrentState(document.RootElement, options); + } + + internal static IndexerCurrentState DeserializeIndexerCurrentState(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IndexingMode? mode = default; + string allDocsInitialChangeTrackingState = default; + string allDocsFinalChangeTrackingState = default; + string resetDocsInitialChangeTrackingState = default; + string resetDocsFinalChangeTrackingState = default; + IReadOnlyList resetDocumentKeys = default; + IReadOnlyList resetDatasourceDocumentIds = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("mode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + mode = new IndexingMode(property.Value.GetString()); + continue; + } + if (property.NameEquals("allDocsInitialChangeTrackingState"u8)) + { + allDocsInitialChangeTrackingState = property.Value.GetString(); + continue; + } + if (property.NameEquals("allDocsFinalChangeTrackingState"u8)) + { + allDocsFinalChangeTrackingState = property.Value.GetString(); + continue; + } + if (property.NameEquals("resetDocsInitialChangeTrackingState"u8)) + { + resetDocsInitialChangeTrackingState = property.Value.GetString(); + continue; + } + if (property.NameEquals("resetDocsFinalChangeTrackingState"u8)) + { + resetDocsFinalChangeTrackingState = property.Value.GetString(); + continue; + } + if (property.NameEquals("resetDocumentKeys"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + resetDocumentKeys = array; + continue; + } + if (property.NameEquals("resetDatasourceDocumentIds"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + resetDatasourceDocumentIds = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new IndexerCurrentState( + mode, + allDocsInitialChangeTrackingState, + allDocsFinalChangeTrackingState, + resetDocsInitialChangeTrackingState, + resetDocsFinalChangeTrackingState, + resetDocumentKeys ?? new ChangeTrackingList(), + resetDatasourceDocumentIds ?? new ChangeTrackingList(), + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(IndexerCurrentState)} does not support writing '{options.Format}' format."); + } + } + + IndexerCurrentState IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexerCurrentState(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(IndexerCurrentState)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static IndexerCurrentState FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexerCurrentState(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerCurrentState.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerCurrentState.cs new file mode 100644 index 000000000000..f826a04cbeba --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerCurrentState.cs @@ -0,0 +1,134 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Represents all of the state that defines and dictates the indexer's current + /// execution. + /// + public partial class IndexerCurrentState + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + internal IndexerCurrentState() + { + ResetDocumentKeys = new ChangeTrackingList(); + ResetDatasourceDocumentIds = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The mode the indexer is running in. + /// + /// Change tracking state used when indexing starts on all documents in the + /// datasource. + /// + /// + /// Change tracking state value when indexing finishes on all documents in the + /// datasource. + /// + /// + /// Change tracking state used when indexing starts on select, reset documents in + /// the datasource. + /// + /// + /// Change tracking state value when indexing finishes on select, reset documents + /// in the datasource. + /// + /// + /// The list of document keys that have been reset. The document key is the + /// document's unique identifier for the data in the search index. The indexer will + /// prioritize selectively re-ingesting these keys. + /// + /// + /// The list of datasource document ids that have been reset. The datasource + /// document id is the unique identifier for the data in the datasource. The + /// indexer will prioritize selectively re-ingesting these ids. + /// + /// Keeps track of any properties unknown to the library. + internal IndexerCurrentState(IndexingMode? mode, string allDocsInitialChangeTrackingState, string allDocsFinalChangeTrackingState, string resetDocsInitialChangeTrackingState, string resetDocsFinalChangeTrackingState, IReadOnlyList resetDocumentKeys, IReadOnlyList resetDatasourceDocumentIds, IDictionary serializedAdditionalRawData) + { + Mode = mode; + AllDocsInitialChangeTrackingState = allDocsInitialChangeTrackingState; + AllDocsFinalChangeTrackingState = allDocsFinalChangeTrackingState; + ResetDocsInitialChangeTrackingState = resetDocsInitialChangeTrackingState; + ResetDocsFinalChangeTrackingState = resetDocsFinalChangeTrackingState; + ResetDocumentKeys = resetDocumentKeys; + ResetDatasourceDocumentIds = resetDatasourceDocumentIds; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The mode the indexer is running in. + public IndexingMode? Mode { get; } + /// + /// Change tracking state used when indexing starts on all documents in the + /// datasource. + /// + public string AllDocsInitialChangeTrackingState { get; } + /// + /// Change tracking state value when indexing finishes on all documents in the + /// datasource. + /// + public string AllDocsFinalChangeTrackingState { get; } + /// + /// Change tracking state used when indexing starts on select, reset documents in + /// the datasource. + /// + public string ResetDocsInitialChangeTrackingState { get; } + /// + /// Change tracking state value when indexing finishes on select, reset documents + /// in the datasource. + /// + public string ResetDocsFinalChangeTrackingState { get; } + /// + /// The list of document keys that have been reset. The document key is the + /// document's unique identifier for the data in the search index. The indexer will + /// prioritize selectively re-ingesting these keys. + /// + public IReadOnlyList ResetDocumentKeys { get; } + /// + /// The list of datasource document ids that have been reset. The datasource + /// document id is the unique identifier for the data in the datasource. The + /// indexer will prioritize selectively re-ingesting these ids. + /// + public IReadOnlyList ResetDatasourceDocumentIds { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerExecutionEnvironment.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerExecutionEnvironment.cs new file mode 100644 index 000000000000..9e0b3d88a60e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerExecutionEnvironment.cs @@ -0,0 +1,60 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Specifies the environment in which the indexer should execute. + public readonly partial struct IndexerExecutionEnvironment : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public IndexerExecutionEnvironment(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string StandardValue = "standard"; + private const string PrivateValue = "private"; + + /// + /// 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); + /// Determines if two values are the same. + public static bool operator ==(IndexerExecutionEnvironment left, IndexerExecutionEnvironment right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(IndexerExecutionEnvironment left, IndexerExecutionEnvironment right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator IndexerExecutionEnvironment(string value) => new IndexerExecutionEnvironment(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is IndexerExecutionEnvironment other && Equals(other); + /// + public bool Equals(IndexerExecutionEnvironment other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerExecutionResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerExecutionResult.Serialization.cs new file mode 100644 index 000000000000..4ca5df77d00d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerExecutionResult.Serialization.cs @@ -0,0 +1,300 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class IndexerExecutionResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexerExecutionResult)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("status"u8); + writer.WriteStringValue(Status.ToString()); + if (options.Format != "W" && Optional.IsDefined(StatusDetail)) + { + writer.WritePropertyName("statusDetail"u8); + writer.WriteStringValue(StatusDetail.Value.ToString()); + } + if (options.Format != "W" && Optional.IsDefined(CurrentState)) + { + writer.WritePropertyName("currentState"u8); + writer.WriteObjectValue(CurrentState, options); + } + if (Optional.IsDefined(ErrorMessage)) + { + writer.WritePropertyName("errorMessage"u8); + writer.WriteStringValue(ErrorMessage); + } + if (Optional.IsDefined(StartTime)) + { + writer.WritePropertyName("startTime"u8); + writer.WriteStringValue(StartTime.Value, "O"); + } + if (Optional.IsDefined(EndTime)) + { + writer.WritePropertyName("endTime"u8); + writer.WriteStringValue(EndTime.Value, "O"); + } + writer.WritePropertyName("errors"u8); + writer.WriteStartArray(); + foreach (var item in Errors) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + writer.WritePropertyName("warnings"u8); + writer.WriteStartArray(); + foreach (var item in Warnings) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + writer.WritePropertyName("itemsProcessed"u8); + writer.WriteNumberValue(ItemsProcessed); + writer.WritePropertyName("itemsFailed"u8); + writer.WriteNumberValue(ItemsFailed); + if (Optional.IsDefined(InitialTrackingState)) + { + writer.WritePropertyName("initialTrackingState"u8); + writer.WriteStringValue(InitialTrackingState); + } + if (Optional.IsDefined(FinalTrackingState)) + { + writer.WritePropertyName("finalTrackingState"u8); + writer.WriteStringValue(FinalTrackingState); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + IndexerExecutionResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexerExecutionResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeIndexerExecutionResult(document.RootElement, options); + } + + internal static IndexerExecutionResult DeserializeIndexerExecutionResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IndexerExecutionStatus status = default; + IndexerExecutionStatusDetail? statusDetail = default; + IndexerCurrentState currentState = default; + string errorMessage = default; + DateTimeOffset? startTime = default; + DateTimeOffset? endTime = default; + IReadOnlyList errors = default; + IReadOnlyList warnings = default; + int itemsProcessed = default; + int itemsFailed = default; + string initialTrackingState = default; + string finalTrackingState = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("status"u8)) + { + status = new IndexerExecutionStatus(property.Value.GetString()); + continue; + } + if (property.NameEquals("statusDetail"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + statusDetail = new IndexerExecutionStatusDetail(property.Value.GetString()); + continue; + } + if (property.NameEquals("currentState"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + currentState = IndexerCurrentState.DeserializeIndexerCurrentState(property.Value, options); + continue; + } + if (property.NameEquals("errorMessage"u8)) + { + errorMessage = property.Value.GetString(); + continue; + } + if (property.NameEquals("startTime"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + startTime = property.Value.GetDateTimeOffset("O"); + continue; + } + if (property.NameEquals("endTime"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + endTime = property.Value.GetDateTimeOffset("O"); + continue; + } + if (property.NameEquals("errors"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SearchIndexerError.DeserializeSearchIndexerError(item, options)); + } + errors = array; + continue; + } + if (property.NameEquals("warnings"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SearchIndexerWarning.DeserializeSearchIndexerWarning(item, options)); + } + warnings = array; + continue; + } + if (property.NameEquals("itemsProcessed"u8)) + { + itemsProcessed = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("itemsFailed"u8)) + { + itemsFailed = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("initialTrackingState"u8)) + { + initialTrackingState = property.Value.GetString(); + continue; + } + if (property.NameEquals("finalTrackingState"u8)) + { + finalTrackingState = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new IndexerExecutionResult( + status, + statusDetail, + currentState, + errorMessage, + startTime, + endTime, + errors, + warnings, + itemsProcessed, + itemsFailed, + initialTrackingState, + finalTrackingState, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(IndexerExecutionResult)} does not support writing '{options.Format}' format."); + } + } + + IndexerExecutionResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexerExecutionResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(IndexerExecutionResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static IndexerExecutionResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexerExecutionResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerExecutionResult.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerExecutionResult.cs new file mode 100644 index 000000000000..6d280c982875 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerExecutionResult.cs @@ -0,0 +1,141 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents the result of an individual indexer execution. + public partial class IndexerExecutionResult + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The outcome of this indexer execution. + /// The item-level indexing errors. + /// The item-level indexing warnings. + /// + /// The number of items that were processed during this indexer execution. This + /// includes both successfully processed items and items where indexing was + /// attempted but failed. + /// + /// The number of items that failed to be indexed during this indexer execution. + /// or is null. + internal IndexerExecutionResult(IndexerExecutionStatus status, IEnumerable errors, IEnumerable warnings, int itemsProcessed, int itemsFailed) + { + Argument.AssertNotNull(errors, nameof(errors)); + Argument.AssertNotNull(warnings, nameof(warnings)); + + Status = status; + Errors = errors.ToList(); + Warnings = warnings.ToList(); + ItemsProcessed = itemsProcessed; + ItemsFailed = itemsFailed; + } + + /// Initializes a new instance of . + /// The outcome of this indexer execution. + /// The outcome of this indexer execution. + /// All of the state that defines and dictates the indexer's current execution. + /// The error message indicating the top-level error, if any. + /// The start time of this indexer execution. + /// The end time of this indexer execution, if the execution has already completed. + /// The item-level indexing errors. + /// The item-level indexing warnings. + /// + /// The number of items that were processed during this indexer execution. This + /// includes both successfully processed items and items where indexing was + /// attempted but failed. + /// + /// The number of items that failed to be indexed during this indexer execution. + /// Change tracking state with which an indexer execution started. + /// Change tracking state with which an indexer execution finished. + /// Keeps track of any properties unknown to the library. + internal IndexerExecutionResult(IndexerExecutionStatus status, IndexerExecutionStatusDetail? statusDetail, IndexerCurrentState currentState, string errorMessage, DateTimeOffset? startTime, DateTimeOffset? endTime, IReadOnlyList errors, IReadOnlyList warnings, int itemsProcessed, int itemsFailed, string initialTrackingState, string finalTrackingState, IDictionary serializedAdditionalRawData) + { + Status = status; + StatusDetail = statusDetail; + CurrentState = currentState; + ErrorMessage = errorMessage; + StartTime = startTime; + EndTime = endTime; + Errors = errors; + Warnings = warnings; + ItemsProcessed = itemsProcessed; + ItemsFailed = itemsFailed; + InitialTrackingState = initialTrackingState; + FinalTrackingState = finalTrackingState; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal IndexerExecutionResult() + { + } + + /// The outcome of this indexer execution. + public IndexerExecutionStatus Status { get; } + /// The outcome of this indexer execution. + public IndexerExecutionStatusDetail? StatusDetail { get; } + /// All of the state that defines and dictates the indexer's current execution. + public IndexerCurrentState CurrentState { get; } + /// The error message indicating the top-level error, if any. + public string ErrorMessage { get; } + /// The start time of this indexer execution. + public DateTimeOffset? StartTime { get; } + /// The end time of this indexer execution, if the execution has already completed. + public DateTimeOffset? EndTime { get; } + /// The item-level indexing errors. + public IReadOnlyList Errors { get; } + /// The item-level indexing warnings. + public IReadOnlyList Warnings { get; } + /// + /// The number of items that were processed during this indexer execution. This + /// includes both successfully processed items and items where indexing was + /// attempted but failed. + /// + public int ItemsProcessed { get; } + /// The number of items that failed to be indexed during this indexer execution. + public int ItemsFailed { get; } + /// Change tracking state with which an indexer execution started. + public string InitialTrackingState { get; } + /// Change tracking state with which an indexer execution finished. + public string FinalTrackingState { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerExecutionStatus.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerExecutionStatus.cs new file mode 100644 index 000000000000..678cdd86fb50 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerExecutionStatus.cs @@ -0,0 +1,60 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents the status of an individual indexer execution. + public readonly partial struct IndexerExecutionStatus : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public IndexerExecutionStatus(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string TransientFailureValue = "transientFailure"; + private const string SuccessValue = "success"; + private const string InProgressValue = "inProgress"; + private const string ResetValue = "reset"; + + /// + /// An indexer invocation has failed, but the failure may be transient. Indexer + /// invocations will continue per schedule. + /// + public static IndexerExecutionStatus TransientFailure { get; } = new IndexerExecutionStatus(TransientFailureValue); + /// Indexer execution completed successfully. + public static IndexerExecutionStatus Success { get; } = new IndexerExecutionStatus(SuccessValue); + /// Indexer execution is in progress. + public static IndexerExecutionStatus InProgress { get; } = new IndexerExecutionStatus(InProgressValue); + /// Indexer has been reset. + public static IndexerExecutionStatus Reset { get; } = new IndexerExecutionStatus(ResetValue); + /// Determines if two values are the same. + public static bool operator ==(IndexerExecutionStatus left, IndexerExecutionStatus right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(IndexerExecutionStatus left, IndexerExecutionStatus right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator IndexerExecutionStatus(string value) => new IndexerExecutionStatus(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is IndexerExecutionStatus other && Equals(other); + /// + public bool Equals(IndexerExecutionStatus other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerExecutionStatusDetail.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerExecutionStatusDetail.cs new file mode 100644 index 000000000000..42eaabc60f5b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerExecutionStatusDetail.cs @@ -0,0 +1,48 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Details the status of an individual indexer execution. + public readonly partial struct IndexerExecutionStatusDetail : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public IndexerExecutionStatusDetail(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string ResetDocsValue = "resetDocs"; + + /// Indicates that the reset that occurred was for a call to ResetDocs. + public static IndexerExecutionStatusDetail ResetDocs { get; } = new IndexerExecutionStatusDetail(ResetDocsValue); + /// Determines if two values are the same. + public static bool operator ==(IndexerExecutionStatusDetail left, IndexerExecutionStatusDetail right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(IndexerExecutionStatusDetail left, IndexerExecutionStatusDetail right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator IndexerExecutionStatusDetail(string value) => new IndexerExecutionStatusDetail(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is IndexerExecutionStatusDetail other && Equals(other); + /// + public bool Equals(IndexerExecutionStatusDetail other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerStatus.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerStatus.cs new file mode 100644 index 000000000000..42f541ed0c05 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexerStatus.cs @@ -0,0 +1,57 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents the overall indexer status. + public readonly partial struct IndexerStatus : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public IndexerStatus(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string UnknownValue = "unknown"; + private const string ErrorValue = "error"; + private const string RunningValue = "running"; + + /// Indicates that the indexer is in an unknown state. + public static IndexerStatus Unknown { get; } = new IndexerStatus(UnknownValue); + /// + /// Indicates that the indexer experienced an error that cannot be corrected + /// without human intervention. + /// + public static IndexerStatus Error { get; } = new IndexerStatus(ErrorValue); + /// Indicates that the indexer is running normally. + public static IndexerStatus Running { get; } = new IndexerStatus(RunningValue); + /// Determines if two values are the same. + public static bool operator ==(IndexerStatus left, IndexerStatus right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(IndexerStatus left, IndexerStatus right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator IndexerStatus(string value) => new IndexerStatus(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is IndexerStatus other && Equals(other); + /// + public bool Equals(IndexerStatus other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Indexers.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Indexers.cs new file mode 100644 index 000000000000..e27f3f329d80 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Indexers.cs @@ -0,0 +1,1187 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading; +using System.Threading.Tasks; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Search.Documents.Indexes +{ + // Data plane generated sub-client. + /// The Indexers sub-client. + public partial class Indexers + { + private const string AuthorizationHeader = "api-key"; + private readonly AzureKeyCredential _keyCredential; + private static readonly string[] AuthorizationScopes = new string[] { "https://search.azure.com/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + private readonly string _apiVersion; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of Indexers for mocking. + protected Indexers() + { + } + + /// Initializes a new instance of Indexers. + /// The handler for diagnostic messaging in the client. + /// The HTTP pipeline for sending and receiving REST requests and responses. + /// The key credential to copy. + /// The token credential to copy. + /// Service host. + /// The API version to use for this operation. + internal Indexers(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, AzureKeyCredential keyCredential, TokenCredential tokenCredential, Uri endpoint, string apiVersion) + { + ClientDiagnostics = clientDiagnostics; + _pipeline = pipeline; + _keyCredential = keyCredential; + _tokenCredential = tokenCredential; + _endpoint = endpoint; + _apiVersion = apiVersion; + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Resets the change tracking state associated with an indexer. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the indexer. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task ResetAsync(string indexerName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.Reset"); + scope.Start(); + try + { + using HttpMessage message = CreateResetRequest(indexerName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Resets the change tracking state associated with an indexer. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the indexer. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Reset(string indexerName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.Reset"); + scope.Start(); + try + { + using HttpMessage message = CreateResetRequest(indexerName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Resets specific documents in the datasource to be selectively re-ingested by + /// the indexer. + /// + /// The name of the indexer. + /// + /// The keys or ids of the documents to be re-ingested. If keys are provided, the + /// document key field must be specified in the indexer configuration. If ids are + /// provided, the document key field is ignored. + /// + /// + /// If false, keys or ids will be appended to existing ones. If true, only the keys + /// or ids in this payload will be queued to be re-ingested. + /// + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task ResetDocsAsync(string indexerName, DocumentKeysOrIds keysOrIds = null, bool? overwrite = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + using RequestContent content = keysOrIds?.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await ResetDocsAsync(indexerName, content, overwrite, context).ConfigureAwait(false); + return response; + } + + /// + /// Resets specific documents in the datasource to be selectively re-ingested by + /// the indexer. + /// + /// The name of the indexer. + /// + /// The keys or ids of the documents to be re-ingested. If keys are provided, the + /// document key field must be specified in the indexer configuration. If ids are + /// provided, the document key field is ignored. + /// + /// + /// If false, keys or ids will be appended to existing ones. If true, only the keys + /// or ids in this payload will be queued to be re-ingested. + /// + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response ResetDocs(string indexerName, DocumentKeysOrIds keysOrIds = null, bool? overwrite = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + using RequestContent content = keysOrIds?.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = ResetDocs(indexerName, content, overwrite, context); + return response; + } + + /// + /// [Protocol Method] Resets specific documents in the datasource to be selectively re-ingested by + /// the indexer. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the indexer. + /// The content to send as the body of the request. + /// + /// If false, keys or ids will be appended to existing ones. If true, only the keys + /// or ids in this payload will be queued to be re-ingested. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task ResetDocsAsync(string indexerName, RequestContent content, bool? overwrite = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.ResetDocs"); + scope.Start(); + try + { + using HttpMessage message = CreateResetDocsRequest(indexerName, content, overwrite, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Resets specific documents in the datasource to be selectively re-ingested by + /// the indexer. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the indexer. + /// The content to send as the body of the request. + /// + /// If false, keys or ids will be appended to existing ones. If true, only the keys + /// or ids in this payload will be queued to be re-ingested. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response ResetDocs(string indexerName, RequestContent content, bool? overwrite = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.ResetDocs"); + scope.Start(); + try + { + using HttpMessage message = CreateResetDocsRequest(indexerName, content, overwrite, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Runs an indexer on-demand. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the indexer. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task RunAsync(string indexerName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.Run"); + scope.Start(); + try + { + using HttpMessage message = CreateRunRequest(indexerName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Runs an indexer on-demand. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the indexer. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Run(string indexerName, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.Run"); + scope.Start(); + try + { + using HttpMessage message = CreateRunRequest(indexerName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates a new indexer or updates an indexer if it already exists. + /// The name of the indexer. + /// The definition of the indexer to create or update. + /// Ignores cache reset requirements. + /// Disables cache reprocessing change detection. + /// The content to send as the request conditions of the request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> CreateOrUpdateAsync(string indexerName, SearchIndexer indexer, bool? skipIndexerResetRequirementForCache = null, bool? disableCacheReprocessingChangeDetection = null, MatchConditions matchConditions = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + Argument.AssertNotNull(indexer, nameof(indexer)); + + using RequestContent content = indexer.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await CreateOrUpdateAsync(indexerName, content, skipIndexerResetRequirementForCache, disableCacheReprocessingChangeDetection, matchConditions, context).ConfigureAwait(false); + return Response.FromValue(SearchIndexer.FromResponse(response), response); + } + + /// Creates a new indexer or updates an indexer if it already exists. + /// The name of the indexer. + /// The definition of the indexer to create or update. + /// Ignores cache reset requirements. + /// Disables cache reprocessing change detection. + /// The content to send as the request conditions of the request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response CreateOrUpdate(string indexerName, SearchIndexer indexer, bool? skipIndexerResetRequirementForCache = null, bool? disableCacheReprocessingChangeDetection = null, MatchConditions matchConditions = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + Argument.AssertNotNull(indexer, nameof(indexer)); + + using RequestContent content = indexer.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = CreateOrUpdate(indexerName, content, skipIndexerResetRequirementForCache, disableCacheReprocessingChangeDetection, matchConditions, context); + return Response.FromValue(SearchIndexer.FromResponse(response), response); + } + + /// + /// [Protocol Method] Creates a new indexer or updates an indexer if it already exists. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the indexer. + /// The content to send as the body of the request. + /// Ignores cache reset requirements. + /// Disables cache reprocessing change detection. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task CreateOrUpdateAsync(string indexerName, RequestContent content, bool? skipIndexerResetRequirementForCache = null, bool? disableCacheReprocessingChangeDetection = null, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(indexerName, content, skipIndexerResetRequirementForCache, disableCacheReprocessingChangeDetection, matchConditions, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Creates a new indexer or updates an indexer if it already exists. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the indexer. + /// The content to send as the body of the request. + /// Ignores cache reset requirements. + /// Disables cache reprocessing change detection. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response CreateOrUpdate(string indexerName, RequestContent content, bool? skipIndexerResetRequirementForCache = null, bool? disableCacheReprocessingChangeDetection = null, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(indexerName, content, skipIndexerResetRequirementForCache, disableCacheReprocessingChangeDetection, matchConditions, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Deletes an indexer. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the indexer. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteAsync(string indexerName, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(indexerName, matchConditions, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Deletes an indexer. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the indexer. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Delete(string indexerName, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(indexerName, matchConditions, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Retrieves an indexer definition. + /// The name of the indexer. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> GetIndexerAsync(string indexerName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await GetIndexerAsync(indexerName, context).ConfigureAwait(false); + return Response.FromValue(SearchIndexer.FromResponse(response), response); + } + + /// Retrieves an indexer definition. + /// The name of the indexer. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response GetIndexer(string indexerName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = GetIndexer(indexerName, context); + return Response.FromValue(SearchIndexer.FromResponse(response), response); + } + + /// + /// [Protocol Method] Retrieves an indexer definition. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the indexer. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task GetIndexerAsync(string indexerName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.GetIndexer"); + scope.Start(); + try + { + using HttpMessage message = CreateGetIndexerRequest(indexerName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Retrieves an indexer definition. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the indexer. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response GetIndexer(string indexerName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.GetIndexer"); + scope.Start(); + try + { + using HttpMessage message = CreateGetIndexerRequest(indexerName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Lists all indexers available for a search service. + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The cancellation token to use. + /// + public virtual async Task> GetIndexersAsync(string select = null, CancellationToken cancellationToken = default) + { + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await GetIndexersAsync(select, context).ConfigureAwait(false); + return Response.FromValue(ListIndexersResult.FromResponse(response), response); + } + + /// Lists all indexers available for a search service. + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The cancellation token to use. + /// + public virtual Response GetIndexers(string select = null, CancellationToken cancellationToken = default) + { + RequestContext context = FromCancellationToken(cancellationToken); + Response response = GetIndexers(select, context); + return Response.FromValue(ListIndexersResult.FromResponse(response), response); + } + + /// + /// [Protocol Method] Lists all indexers available for a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task GetIndexersAsync(string select, RequestContext context) + { + using var scope = ClientDiagnostics.CreateScope("Indexers.GetIndexers"); + scope.Start(); + try + { + using HttpMessage message = CreateGetIndexersRequest(select, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Lists all indexers available for a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response GetIndexers(string select, RequestContext context) + { + using var scope = ClientDiagnostics.CreateScope("Indexers.GetIndexers"); + scope.Start(); + try + { + using HttpMessage message = CreateGetIndexersRequest(select, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates a new indexer. + /// The definition of the indexer to create. + /// The cancellation token to use. + /// is null. + /// + public virtual async Task> CreateAsync(SearchIndexer indexer, CancellationToken cancellationToken = default) + { + Argument.AssertNotNull(indexer, nameof(indexer)); + + using RequestContent content = indexer.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await CreateAsync(content, context).ConfigureAwait(false); + return Response.FromValue(SearchIndexer.FromResponse(response), response); + } + + /// Creates a new indexer. + /// The definition of the indexer to create. + /// The cancellation token to use. + /// is null. + /// + public virtual Response Create(SearchIndexer indexer, CancellationToken cancellationToken = default) + { + Argument.AssertNotNull(indexer, nameof(indexer)); + + using RequestContent content = indexer.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = Create(content, context); + return Response.FromValue(SearchIndexer.FromResponse(response), response); + } + + /// + /// [Protocol Method] Creates a new indexer. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task CreateAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Creates a new indexer. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Create(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Returns the current status and execution history of an indexer. + /// The name of the indexer. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> GetStatusAsync(string indexerName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await GetStatusAsync(indexerName, context).ConfigureAwait(false); + return Response.FromValue(SearchIndexerStatus.FromResponse(response), response); + } + + /// Returns the current status and execution history of an indexer. + /// The name of the indexer. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response GetStatus(string indexerName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = GetStatus(indexerName, context); + return Response.FromValue(SearchIndexerStatus.FromResponse(response), response); + } + + /// + /// [Protocol Method] Returns the current status and execution history of an indexer. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the indexer. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task GetStatusAsync(string indexerName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.GetStatus"); + scope.Start(); + try + { + using HttpMessage message = CreateGetStatusRequest(indexerName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Returns the current status and execution history of an indexer. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the indexer. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response GetStatus(string indexerName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexerName, nameof(indexerName)); + + using var scope = ClientDiagnostics.CreateScope("Indexers.GetStatus"); + scope.Start(); + try + { + using HttpMessage message = CreateGetStatusRequest(indexerName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateResetRequest(string indexerName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexers('", false); + uri.AppendPath(indexerName, true); + uri.AppendPath("')/search.reset", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateResetDocsRequest(string indexerName, RequestContent content, bool? overwrite, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexers('", false); + uri.AppendPath(indexerName, true); + uri.AppendPath("')/search.resetdocs", false); + uri.AppendQuery("api-version", _apiVersion, true); + if (overwrite != null) + { + uri.AppendQuery("overwrite", overwrite.Value, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateRunRequest(string indexerName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier202); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexers('", false); + uri.AppendPath(indexerName, true); + uri.AppendPath("')/search.run", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateOrUpdateRequest(string indexerName, RequestContent content, bool? skipIndexerResetRequirementForCache, bool? disableCacheReprocessingChangeDetection, MatchConditions matchConditions, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200201); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexers('", false); + uri.AppendPath(indexerName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + if (skipIndexerResetRequirementForCache != null) + { + uri.AppendQuery("ignoreResetRequirements", skipIndexerResetRequirementForCache.Value, true); + } + if (disableCacheReprocessingChangeDetection != null) + { + uri.AppendQuery("disableCacheReprocessingChangeDetection", disableCacheReprocessingChangeDetection.Value, true); + } + request.Uri = uri; + request.Headers.Add("Prefer", "return=representation"); + request.Headers.Add("Accept", "application/json"); + if (matchConditions != null) + { + request.Headers.Add(matchConditions); + } + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteRequest(string indexerName, MatchConditions matchConditions, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204404); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexers('", false); + uri.AppendPath(indexerName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + if (matchConditions != null) + { + request.Headers.Add(matchConditions); + } + return message; + } + + internal HttpMessage CreateGetIndexerRequest(string indexerName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexers('", false); + uri.AppendPath(indexerName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetIndexersRequest(string select, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexers", false); + uri.AppendQuery("api-version", _apiVersion, true); + if (select != null) + { + uri.AppendQuery("$select", select, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier201); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexers", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetStatusRequest(string indexerName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexers('", false); + uri.AppendPath(indexerName, true); + uri.AppendPath("')/search.status", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static RequestContext DefaultRequestContext = new RequestContext(); + internal static RequestContext FromCancellationToken(CancellationToken cancellationToken = default) + { + if (!cancellationToken.CanBeCanceled) + { + return DefaultRequestContext; + } + + return new RequestContext() { CancellationToken = cancellationToken }; + } + + private static ResponseClassifier _responseClassifier204; + private static ResponseClassifier ResponseClassifier204 => _responseClassifier204 ??= new StatusCodeClassifier(stackalloc ushort[] { 204 }); + private static ResponseClassifier _responseClassifier202; + private static ResponseClassifier ResponseClassifier202 => _responseClassifier202 ??= new StatusCodeClassifier(stackalloc ushort[] { 202 }); + private static ResponseClassifier _responseClassifier200201; + private static ResponseClassifier ResponseClassifier200201 => _responseClassifier200201 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 201 }); + private static ResponseClassifier _responseClassifier204404; + private static ResponseClassifier ResponseClassifier204404 => _responseClassifier204404 ??= new StatusCodeClassifier(stackalloc ushort[] { 204, 404 }); + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier201; + private static ResponseClassifier ResponseClassifier201 => _responseClassifier201 ??= new StatusCodeClassifier(stackalloc ushort[] { 201 }); + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Indexes.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Indexes.cs new file mode 100644 index 000000000000..72c07bdf66af --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Indexes.cs @@ -0,0 +1,986 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading; +using System.Threading.Tasks; +using Autorest.CSharp.Core; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Search.Documents.Indexes +{ + // Data plane generated sub-client. + /// The Indexes sub-client. + public partial class Indexes + { + private const string AuthorizationHeader = "api-key"; + private readonly AzureKeyCredential _keyCredential; + private static readonly string[] AuthorizationScopes = new string[] { "https://search.azure.com/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + private readonly string _apiVersion; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of Indexes for mocking. + protected Indexes() + { + } + + /// Initializes a new instance of Indexes. + /// The handler for diagnostic messaging in the client. + /// The HTTP pipeline for sending and receiving REST requests and responses. + /// The key credential to copy. + /// The token credential to copy. + /// Service host. + /// The API version to use for this operation. + internal Indexes(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, AzureKeyCredential keyCredential, TokenCredential tokenCredential, Uri endpoint, string apiVersion) + { + ClientDiagnostics = clientDiagnostics; + _pipeline = pipeline; + _keyCredential = keyCredential; + _tokenCredential = tokenCredential; + _endpoint = endpoint; + _apiVersion = apiVersion; + } + + /// Creates a new search index. + /// The definition of the index to create. + /// The cancellation token to use. + /// is null. + /// + public virtual async Task> CreateAsync(SearchIndex index, CancellationToken cancellationToken = default) + { + Argument.AssertNotNull(index, nameof(index)); + + using RequestContent content = index.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await CreateAsync(content, context).ConfigureAwait(false); + return Response.FromValue(SearchIndex.FromResponse(response), response); + } + + /// Creates a new search index. + /// The definition of the index to create. + /// The cancellation token to use. + /// is null. + /// + public virtual Response Create(SearchIndex index, CancellationToken cancellationToken = default) + { + Argument.AssertNotNull(index, nameof(index)); + + using RequestContent content = index.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = Create(content, context); + return Response.FromValue(SearchIndex.FromResponse(response), response); + } + + /// + /// [Protocol Method] Creates a new search index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task CreateAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Indexes.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Creates a new search index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Create(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Indexes.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates a new search index or updates an index if it already exists. + /// The name of the index. + /// The definition of the index to create or update. + /// + /// Allows new analyzers, tokenizers, token filters, or char filters to be added to + /// an index by taking the index offline for at least a few seconds. This + /// temporarily causes indexing and query requests to fail. Performance and write + /// availability of the index can be impaired for several minutes after the index + /// is updated, or longer for very large indexes. + /// + /// The content to send as the request conditions of the request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> CreateOrUpdateAsync(string indexName, SearchIndex index, bool? allowIndexDowntime = null, MatchConditions matchConditions = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(index, nameof(index)); + + using RequestContent content = index.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await CreateOrUpdateAsync(indexName, content, allowIndexDowntime, matchConditions, context).ConfigureAwait(false); + return Response.FromValue(SearchIndex.FromResponse(response), response); + } + + /// Creates a new search index or updates an index if it already exists. + /// The name of the index. + /// The definition of the index to create or update. + /// + /// Allows new analyzers, tokenizers, token filters, or char filters to be added to + /// an index by taking the index offline for at least a few seconds. This + /// temporarily causes indexing and query requests to fail. Performance and write + /// availability of the index can be impaired for several minutes after the index + /// is updated, or longer for very large indexes. + /// + /// The content to send as the request conditions of the request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response CreateOrUpdate(string indexName, SearchIndex index, bool? allowIndexDowntime = null, MatchConditions matchConditions = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(index, nameof(index)); + + using RequestContent content = index.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = CreateOrUpdate(indexName, content, allowIndexDowntime, matchConditions, context); + return Response.FromValue(SearchIndex.FromResponse(response), response); + } + + /// + /// [Protocol Method] Creates a new search index or updates an index if it already exists. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The content to send as the body of the request. + /// + /// Allows new analyzers, tokenizers, token filters, or char filters to be added to + /// an index by taking the index offline for at least a few seconds. This + /// temporarily causes indexing and query requests to fail. Performance and write + /// availability of the index can be impaired for several minutes after the index + /// is updated, or longer for very large indexes. + /// + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task CreateOrUpdateAsync(string indexName, RequestContent content, bool? allowIndexDowntime = null, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Indexes.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(indexName, content, allowIndexDowntime, matchConditions, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Creates a new search index or updates an index if it already exists. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The content to send as the body of the request. + /// + /// Allows new analyzers, tokenizers, token filters, or char filters to be added to + /// an index by taking the index offline for at least a few seconds. This + /// temporarily causes indexing and query requests to fail. Performance and write + /// availability of the index can be impaired for several minutes after the index + /// is updated, or longer for very large indexes. + /// + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response CreateOrUpdate(string indexName, RequestContent content, bool? allowIndexDowntime = null, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Indexes.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(indexName, content, allowIndexDowntime, matchConditions, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Deletes a search index and all the documents it contains. This operation is + /// permanent, with no recovery option. Make sure you have a master copy of your + /// index definition, data ingestion code, and a backup of the primary data source + /// in case you need to re-build the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the index. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteAsync(string indexName, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + using var scope = ClientDiagnostics.CreateScope("Indexes.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(indexName, matchConditions, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Deletes a search index and all the documents it contains. This operation is + /// permanent, with no recovery option. Make sure you have a master copy of your + /// index definition, data ingestion code, and a backup of the primary data source + /// in case you need to re-build the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the index. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Delete(string indexName, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + using var scope = ClientDiagnostics.CreateScope("Indexes.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(indexName, matchConditions, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Retrieves an index definition. + /// The name of the index. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> GetIndexAsync(string indexName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await GetIndexAsync(indexName, context).ConfigureAwait(false); + return Response.FromValue(SearchIndex.FromResponse(response), response); + } + + /// Retrieves an index definition. + /// The name of the index. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response GetIndex(string indexName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = GetIndex(indexName, context); + return Response.FromValue(SearchIndex.FromResponse(response), response); + } + + /// + /// [Protocol Method] Retrieves an index definition. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task GetIndexAsync(string indexName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + using var scope = ClientDiagnostics.CreateScope("Indexes.GetIndex"); + scope.Start(); + try + { + using HttpMessage message = CreateGetIndexRequest(indexName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Retrieves an index definition. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response GetIndex(string indexName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + using var scope = ClientDiagnostics.CreateScope("Indexes.GetIndex"); + scope.Start(); + try + { + using HttpMessage message = CreateGetIndexRequest(indexName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Returns statistics for the given index, including a document count and storage + /// usage. + /// + /// The name of the index. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> GetStatisticsAsync(string indexName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await GetStatisticsAsync(indexName, context).ConfigureAwait(false); + return Response.FromValue(GetIndexStatisticsResult.FromResponse(response), response); + } + + /// + /// Returns statistics for the given index, including a document count and storage + /// usage. + /// + /// The name of the index. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response GetStatistics(string indexName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = GetStatistics(indexName, context); + return Response.FromValue(GetIndexStatisticsResult.FromResponse(response), response); + } + + /// + /// [Protocol Method] Returns statistics for the given index, including a document count and storage + /// usage. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task GetStatisticsAsync(string indexName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + using var scope = ClientDiagnostics.CreateScope("Indexes.GetStatistics"); + scope.Start(); + try + { + using HttpMessage message = CreateGetStatisticsRequest(indexName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Returns statistics for the given index, including a document count and storage + /// usage. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response GetStatistics(string indexName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + using var scope = ClientDiagnostics.CreateScope("Indexes.GetStatistics"); + scope.Start(); + try + { + using HttpMessage message = CreateGetStatisticsRequest(indexName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Shows how an analyzer breaks text into tokens. + /// The name of the index. + /// The text and analyzer or analysis components to test. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> AnalyzeAsync(string indexName, AnalyzeRequest request, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(request, nameof(request)); + + using RequestContent content = request.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await AnalyzeAsync(indexName, content, context).ConfigureAwait(false); + return Response.FromValue(AnalyzeResult.FromResponse(response), response); + } + + /// Shows how an analyzer breaks text into tokens. + /// The name of the index. + /// The text and analyzer or analysis components to test. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response Analyze(string indexName, AnalyzeRequest request, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(request, nameof(request)); + + using RequestContent content = request.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = Analyze(indexName, content, context); + return Response.FromValue(AnalyzeResult.FromResponse(response), response); + } + + /// + /// [Protocol Method] Shows how an analyzer breaks text into tokens. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task AnalyzeAsync(string indexName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Indexes.Analyze"); + scope.Start(); + try + { + using HttpMessage message = CreateAnalyzeRequest(indexName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Shows how an analyzer breaks text into tokens. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Analyze(string indexName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Indexes.Analyze"); + scope.Start(); + try + { + using HttpMessage message = CreateAnalyzeRequest(indexName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Lists all indexes available for a search service. + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The cancellation token to use. + /// + public virtual AsyncPageable GetIndexesAsync(string select = null, CancellationToken cancellationToken = default) + { + RequestContext context = cancellationToken.CanBeCanceled ? new RequestContext { CancellationToken = cancellationToken } : null; + HttpMessage FirstPageRequest(int? pageSizeHint) => CreateGetIndexesRequest(select, context); + return GeneratorPageableHelpers.CreateAsyncPageable(FirstPageRequest, null, e => SearchIndex.DeserializeSearchIndex(e), ClientDiagnostics, _pipeline, "Indexes.GetIndexes", "value", null, context); + } + + /// Lists all indexes available for a search service. + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The cancellation token to use. + /// + public virtual Pageable GetIndexes(string select = null, CancellationToken cancellationToken = default) + { + RequestContext context = cancellationToken.CanBeCanceled ? new RequestContext { CancellationToken = cancellationToken } : null; + HttpMessage FirstPageRequest(int? pageSizeHint) => CreateGetIndexesRequest(select, context); + return GeneratorPageableHelpers.CreatePageable(FirstPageRequest, null, e => SearchIndex.DeserializeSearchIndex(e), ClientDiagnostics, _pipeline, "Indexes.GetIndexes", "value", null, context); + } + + /// + /// [Protocol Method] Lists all indexes available for a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetIndexesAsync(string select, RequestContext context) + { + HttpMessage FirstPageRequest(int? pageSizeHint) => CreateGetIndexesRequest(select, context); + return GeneratorPageableHelpers.CreateAsyncPageable(FirstPageRequest, null, e => BinaryData.FromString(e.GetRawText()), ClientDiagnostics, _pipeline, "Indexes.GetIndexes", "value", null, context); + } + + /// + /// [Protocol Method] Lists all indexes available for a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetIndexes(string select, RequestContext context) + { + HttpMessage FirstPageRequest(int? pageSizeHint) => CreateGetIndexesRequest(select, context); + return GeneratorPageableHelpers.CreatePageable(FirstPageRequest, null, e => BinaryData.FromString(e.GetRawText()), ClientDiagnostics, _pipeline, "Indexes.GetIndexes", "value", null, context); + } + + internal HttpMessage CreateCreateRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier201); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetIndexesRequest(string select, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes", false); + uri.AppendQuery("api-version", _apiVersion, true); + if (select != null) + { + uri.AppendQuery("$select", select, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateOrUpdateRequest(string indexName, RequestContent content, bool? allowIndexDowntime, MatchConditions matchConditions, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200201); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes('", false); + uri.AppendPath(indexName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + if (allowIndexDowntime != null) + { + uri.AppendQuery("allowIndexDowntime", allowIndexDowntime.Value, true); + } + request.Uri = uri; + request.Headers.Add("Prefer", "return=representation"); + request.Headers.Add("Accept", "application/json"); + if (matchConditions != null) + { + request.Headers.Add(matchConditions); + } + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteRequest(string indexName, MatchConditions matchConditions, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204404); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes('", false); + uri.AppendPath(indexName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + if (matchConditions != null) + { + request.Headers.Add(matchConditions); + } + return message; + } + + internal HttpMessage CreateGetIndexRequest(string indexName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes('", false); + uri.AppendPath(indexName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetStatisticsRequest(string indexName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes('", false); + uri.AppendPath(indexName, true); + uri.AppendPath("')/search.stats", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateAnalyzeRequest(string indexName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes('", false); + uri.AppendPath(indexName, true); + uri.AppendPath("')/search.analyze", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + private static RequestContext DefaultRequestContext = new RequestContext(); + internal static RequestContext FromCancellationToken(CancellationToken cancellationToken = default) + { + if (!cancellationToken.CanBeCanceled) + { + return DefaultRequestContext; + } + + return new RequestContext() { CancellationToken = cancellationToken }; + } + + private static ResponseClassifier _responseClassifier201; + private static ResponseClassifier ResponseClassifier201 => _responseClassifier201 ??= new StatusCodeClassifier(stackalloc ushort[] { 201 }); + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier200201; + private static ResponseClassifier ResponseClassifier200201 => _responseClassifier200201 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 201 }); + private static ResponseClassifier _responseClassifier204404; + private static ResponseClassifier ResponseClassifier204404 => _responseClassifier204404 ??= new StatusCodeClassifier(stackalloc ushort[] { 204, 404 }); + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingMode.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingMode.cs new file mode 100644 index 000000000000..290980d78aec --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingMode.cs @@ -0,0 +1,54 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents the mode the indexer is executing in. + public readonly partial struct IndexingMode : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public IndexingMode(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string IndexingAllDocsValue = "indexingAllDocs"; + private const string IndexingResetDocsValue = "indexingResetDocs"; + + /// The indexer is indexing all documents in the datasource. + public static IndexingMode IndexingAllDocs { get; } = new IndexingMode(IndexingAllDocsValue); + /// + /// The indexer is indexing selective, reset documents in the datasource. The + /// documents being indexed are defined on indexer status. + /// + public static IndexingMode IndexingResetDocs { get; } = new IndexingMode(IndexingResetDocsValue); + /// Determines if two values are the same. + public static bool operator ==(IndexingMode left, IndexingMode right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(IndexingMode left, IndexingMode right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator IndexingMode(string value) => new IndexingMode(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is IndexingMode other && Equals(other); + /// + public bool Equals(IndexingMode other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingParameters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingParameters.Serialization.cs new file mode 100644 index 000000000000..5712014cff04 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingParameters.Serialization.cs @@ -0,0 +1,194 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class IndexingParameters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexingParameters)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(BatchSize)) + { + writer.WritePropertyName("batchSize"u8); + writer.WriteNumberValue(BatchSize.Value); + } + if (Optional.IsDefined(MaxFailedItems)) + { + writer.WritePropertyName("maxFailedItems"u8); + writer.WriteNumberValue(MaxFailedItems.Value); + } + if (Optional.IsDefined(MaxFailedItemsPerBatch)) + { + writer.WritePropertyName("maxFailedItemsPerBatch"u8); + writer.WriteNumberValue(MaxFailedItemsPerBatch.Value); + } + if (Optional.IsDefined(Configuration)) + { + writer.WritePropertyName("configuration"u8); + writer.WriteObjectValue(Configuration, options); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + IndexingParameters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexingParameters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeIndexingParameters(document.RootElement, options); + } + + internal static IndexingParameters DeserializeIndexingParameters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? batchSize = default; + int? maxFailedItems = default; + int? maxFailedItemsPerBatch = default; + IndexingParametersConfiguration configuration = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("batchSize"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + batchSize = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("maxFailedItems"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxFailedItems = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("maxFailedItemsPerBatch"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxFailedItemsPerBatch = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("configuration"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + configuration = IndexingParametersConfiguration.DeserializeIndexingParametersConfiguration(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new IndexingParameters(batchSize, maxFailedItems, maxFailedItemsPerBatch, configuration, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(IndexingParameters)} does not support writing '{options.Format}' format."); + } + } + + IndexingParameters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexingParameters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(IndexingParameters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static IndexingParameters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexingParameters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingParameters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingParameters.cs new file mode 100644 index 000000000000..f464b2ede1cc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingParameters.cs @@ -0,0 +1,103 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents parameters for indexer execution. + public partial class IndexingParameters + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public IndexingParameters() + { + } + + /// Initializes a new instance of . + /// + /// The number of items that are read from the data source and indexed as a single + /// batch in order to improve performance. The default depends on the data source + /// type. + /// + /// + /// The maximum number of items that can fail indexing for indexer execution to + /// still be considered successful. -1 means no limit. Default is 0. + /// + /// + /// The maximum number of items in a single batch that can fail indexing for the + /// batch to still be considered successful. -1 means no limit. Default is 0. + /// + /// + /// A dictionary of indexer-specific configuration properties. Each name is the + /// name of a specific property. Each value must be of a primitive type. + /// + /// Keeps track of any properties unknown to the library. + internal IndexingParameters(int? batchSize, int? maxFailedItems, int? maxFailedItemsPerBatch, IndexingParametersConfiguration configuration, IDictionary serializedAdditionalRawData) + { + BatchSize = batchSize; + MaxFailedItems = maxFailedItems; + MaxFailedItemsPerBatch = maxFailedItemsPerBatch; + Configuration = configuration; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// + /// The number of items that are read from the data source and indexed as a single + /// batch in order to improve performance. The default depends on the data source + /// type. + /// + public int? BatchSize { get; set; } + /// + /// The maximum number of items that can fail indexing for indexer execution to + /// still be considered successful. -1 means no limit. Default is 0. + /// + public int? MaxFailedItems { get; set; } + /// + /// The maximum number of items in a single batch that can fail indexing for the + /// batch to still be considered successful. -1 means no limit. Default is 0. + /// + public int? MaxFailedItemsPerBatch { get; set; } + /// + /// A dictionary of indexer-specific configuration properties. Each name is the + /// name of a specific property. Each value must be of a primitive type. + /// + public IndexingParametersConfiguration Configuration { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingParametersConfiguration.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingParametersConfiguration.Serialization.cs new file mode 100644 index 000000000000..c1e701906d0a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingParametersConfiguration.Serialization.cs @@ -0,0 +1,393 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class IndexingParametersConfiguration : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexingParametersConfiguration)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(ParsingMode)) + { + writer.WritePropertyName("parsingMode"u8); + writer.WriteStringValue(ParsingMode.Value.ToString()); + } + if (Optional.IsDefined(ExcludedFileNameExtensions)) + { + writer.WritePropertyName("excludedFileNameExtensions"u8); + writer.WriteStringValue(ExcludedFileNameExtensions); + } + if (Optional.IsDefined(IndexedFileNameExtensions)) + { + writer.WritePropertyName("indexedFileNameExtensions"u8); + writer.WriteStringValue(IndexedFileNameExtensions); + } + if (Optional.IsDefined(FailOnUnsupportedContentType)) + { + writer.WritePropertyName("failOnUnsupportedContentType"u8); + writer.WriteBooleanValue(FailOnUnsupportedContentType.Value); + } + if (Optional.IsDefined(FailOnUnprocessableDocument)) + { + writer.WritePropertyName("failOnUnprocessableDocument"u8); + writer.WriteBooleanValue(FailOnUnprocessableDocument.Value); + } + if (Optional.IsDefined(IndexStorageMetadataOnlyForOversizedDocuments)) + { + writer.WritePropertyName("indexStorageMetadataOnlyForOversizedDocuments"u8); + writer.WriteBooleanValue(IndexStorageMetadataOnlyForOversizedDocuments.Value); + } + if (Optional.IsDefined(DelimitedTextHeaders)) + { + writer.WritePropertyName("delimitedTextHeaders"u8); + writer.WriteStringValue(DelimitedTextHeaders); + } + if (Optional.IsDefined(DelimitedTextDelimiter)) + { + writer.WritePropertyName("delimitedTextDelimiter"u8); + writer.WriteStringValue(DelimitedTextDelimiter); + } + if (Optional.IsDefined(FirstLineContainsHeaders)) + { + writer.WritePropertyName("firstLineContainsHeaders"u8); + writer.WriteBooleanValue(FirstLineContainsHeaders.Value); + } + if (Optional.IsDefined(MarkdownParsingSubmode)) + { + writer.WritePropertyName("markdownParsingSubmode"u8); + writer.WriteStringValue(MarkdownParsingSubmode.Value.ToString()); + } + if (Optional.IsDefined(MarkdownHeaderDepth)) + { + writer.WritePropertyName("markdownHeaderDepth"u8); + writer.WriteStringValue(MarkdownHeaderDepth.Value.ToString()); + } + if (Optional.IsDefined(DocumentRoot)) + { + writer.WritePropertyName("documentRoot"u8); + writer.WriteStringValue(DocumentRoot); + } + if (Optional.IsDefined(DataToExtract)) + { + writer.WritePropertyName("dataToExtract"u8); + writer.WriteStringValue(DataToExtract.Value.ToString()); + } + if (Optional.IsDefined(ImageAction)) + { + writer.WritePropertyName("imageAction"u8); + writer.WriteStringValue(ImageAction.Value.ToString()); + } + if (Optional.IsDefined(AllowSkillsetToReadFileData)) + { + writer.WritePropertyName("allowSkillsetToReadFileData"u8); + writer.WriteBooleanValue(AllowSkillsetToReadFileData.Value); + } + if (Optional.IsDefined(PdfTextRotationAlgorithm)) + { + writer.WritePropertyName("pdfTextRotationAlgorithm"u8); + writer.WriteStringValue(PdfTextRotationAlgorithm.Value.ToString()); + } + if (Optional.IsDefined(ExecutionEnvironment)) + { + writer.WritePropertyName("executionEnvironment"u8); + writer.WriteStringValue(ExecutionEnvironment.Value.ToString()); + } + if (Optional.IsDefined(QueryTimeout)) + { + writer.WritePropertyName("queryTimeout"u8); + writer.WriteStringValue(QueryTimeout); + } + foreach (var item in AdditionalProperties) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + + IndexingParametersConfiguration IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexingParametersConfiguration)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeIndexingParametersConfiguration(document.RootElement, options); + } + + internal static IndexingParametersConfiguration DeserializeIndexingParametersConfiguration(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + BlobIndexerParsingMode? parsingMode = default; + string excludedFileNameExtensions = default; + string indexedFileNameExtensions = default; + bool? failOnUnsupportedContentType = default; + bool? failOnUnprocessableDocument = default; + bool? indexStorageMetadataOnlyForOversizedDocuments = default; + string delimitedTextHeaders = default; + string delimitedTextDelimiter = default; + bool? firstLineContainsHeaders = default; + MarkdownParsingSubmode? markdownParsingSubmode = default; + MarkdownHeaderDepth? markdownHeaderDepth = default; + string documentRoot = default; + BlobIndexerDataToExtract? dataToExtract = default; + BlobIndexerImageAction? imageAction = default; + bool? allowSkillsetToReadFileData = default; + BlobIndexerPDFTextRotationAlgorithm? pdfTextRotationAlgorithm = default; + IndexerExecutionEnvironment? executionEnvironment = default; + string queryTimeout = default; + IDictionary additionalProperties = default; + Dictionary additionalPropertiesDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("parsingMode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + parsingMode = new BlobIndexerParsingMode(property.Value.GetString()); + continue; + } + if (property.NameEquals("excludedFileNameExtensions"u8)) + { + excludedFileNameExtensions = property.Value.GetString(); + continue; + } + if (property.NameEquals("indexedFileNameExtensions"u8)) + { + indexedFileNameExtensions = property.Value.GetString(); + continue; + } + if (property.NameEquals("failOnUnsupportedContentType"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + failOnUnsupportedContentType = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("failOnUnprocessableDocument"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + failOnUnprocessableDocument = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("indexStorageMetadataOnlyForOversizedDocuments"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + indexStorageMetadataOnlyForOversizedDocuments = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("delimitedTextHeaders"u8)) + { + delimitedTextHeaders = property.Value.GetString(); + continue; + } + if (property.NameEquals("delimitedTextDelimiter"u8)) + { + delimitedTextDelimiter = property.Value.GetString(); + continue; + } + if (property.NameEquals("firstLineContainsHeaders"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + firstLineContainsHeaders = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("markdownParsingSubmode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + markdownParsingSubmode = new MarkdownParsingSubmode(property.Value.GetString()); + continue; + } + if (property.NameEquals("markdownHeaderDepth"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + markdownHeaderDepth = new MarkdownHeaderDepth(property.Value.GetString()); + continue; + } + if (property.NameEquals("documentRoot"u8)) + { + documentRoot = property.Value.GetString(); + continue; + } + if (property.NameEquals("dataToExtract"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + dataToExtract = new BlobIndexerDataToExtract(property.Value.GetString()); + continue; + } + if (property.NameEquals("imageAction"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + imageAction = new BlobIndexerImageAction(property.Value.GetString()); + continue; + } + if (property.NameEquals("allowSkillsetToReadFileData"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + allowSkillsetToReadFileData = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("pdfTextRotationAlgorithm"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + pdfTextRotationAlgorithm = new BlobIndexerPDFTextRotationAlgorithm(property.Value.GetString()); + continue; + } + if (property.NameEquals("executionEnvironment"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + executionEnvironment = new IndexerExecutionEnvironment(property.Value.GetString()); + continue; + } + if (property.NameEquals("queryTimeout"u8)) + { + queryTimeout = property.Value.GetString(); + continue; + } + additionalPropertiesDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + additionalProperties = additionalPropertiesDictionary; + return new IndexingParametersConfiguration( + parsingMode, + excludedFileNameExtensions, + indexedFileNameExtensions, + failOnUnsupportedContentType, + failOnUnprocessableDocument, + indexStorageMetadataOnlyForOversizedDocuments, + delimitedTextHeaders, + delimitedTextDelimiter, + firstLineContainsHeaders, + markdownParsingSubmode, + markdownHeaderDepth, + documentRoot, + dataToExtract, + imageAction, + allowSkillsetToReadFileData, + pdfTextRotationAlgorithm, + executionEnvironment, + queryTimeout, + additionalProperties); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(IndexingParametersConfiguration)} does not support writing '{options.Format}' format."); + } + } + + IndexingParametersConfiguration IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexingParametersConfiguration(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(IndexingParametersConfiguration)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static IndexingParametersConfiguration FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexingParametersConfiguration(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingParametersConfiguration.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingParametersConfiguration.cs new file mode 100644 index 000000000000..05eb391b22a1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingParametersConfiguration.cs @@ -0,0 +1,250 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A dictionary of indexer-specific configuration properties. Each name is the + /// name of a specific property. Each value must be of a primitive type. + /// + public partial class IndexingParametersConfiguration + { + /// Initializes a new instance of . + public IndexingParametersConfiguration() + { + AdditionalProperties = new ChangeTrackingDictionary(); + } + + /// Initializes a new instance of . + /// Represents the parsing mode for indexing from an Azure blob data source. + /// + /// Comma-delimited list of filename extensions to ignore when processing from + /// Azure blob storage. For example, you could exclude ".png, .mp4" to skip over + /// those files during indexing. + /// + /// + /// Comma-delimited list of filename extensions to select when processing from + /// Azure blob storage. For example, you could focus indexing on specific + /// application files ".docx, .pptx, .msg" to specifically include those file + /// types. + /// + /// + /// For Azure blobs, set to false if you want to continue indexing when an + /// unsupported content type is encountered, and you don't know all the content + /// types (file extensions) in advance. + /// + /// + /// For Azure blobs, set to false if you want to continue indexing if a document + /// fails indexing. + /// + /// + /// For Azure blobs, set this property to true to still index storage metadata for + /// blob content that is too large to process. Oversized blobs are treated as + /// errors by default. For limits on blob size, see + /// https://learn.microsoft.com/azure/search/search-limits-quotas-capacity. + /// + /// + /// For CSV blobs, specifies a comma-delimited list of column headers, useful for + /// mapping source fields to destination fields in an index. + /// + /// + /// For CSV blobs, specifies the end-of-line single-character delimiter for CSV + /// files where each line starts a new document (for example, "|"). + /// + /// + /// For CSV blobs, indicates that the first (non-blank) line of each blob contains + /// headers. + /// + /// + /// Specifies the submode that will determine whether a markdown file will be + /// parsed into exactly one search document or multiple search documents. Default + /// is `oneToMany`. + /// + /// + /// Specifies the max header depth that will be considered while grouping markdown + /// content. Default is `h6`. + /// + /// + /// For JSON arrays, given a structured or semi-structured document, you can + /// specify a path to the array using this property. + /// + /// + /// Specifies the data to extract from Azure blob storage and tells the indexer + /// which data to extract from image content when "imageAction" is set to a value + /// other than "none". This applies to embedded image content in a .PDF or other + /// application, or image files such as .jpg and .png, in Azure blobs. + /// + /// + /// Determines how to process embedded images and image files in Azure blob + /// storage. Setting the "imageAction" configuration to any value other than + /// "none" requires that a skillset also be attached to that indexer. + /// + /// + /// If true, will create a path //document//file_data that is an object + /// representing the original file data downloaded from your blob data source. + /// This allows you to pass the original file data to a custom skill for processing + /// within the enrichment pipeline, or to the Document Extraction skill. + /// + /// Determines algorithm for text extraction from PDF files in Azure blob storage. + /// Specifies the environment in which the indexer should execute. + /// + /// Increases the timeout beyond the 5-minute default for Azure SQL database data + /// sources, specified in the format "hh:mm:ss". + /// + /// Additional Properties. + internal IndexingParametersConfiguration(BlobIndexerParsingMode? parsingMode, string excludedFileNameExtensions, string indexedFileNameExtensions, bool? failOnUnsupportedContentType, bool? failOnUnprocessableDocument, bool? indexStorageMetadataOnlyForOversizedDocuments, string delimitedTextHeaders, string delimitedTextDelimiter, bool? firstLineContainsHeaders, MarkdownParsingSubmode? markdownParsingSubmode, MarkdownHeaderDepth? markdownHeaderDepth, string documentRoot, BlobIndexerDataToExtract? dataToExtract, BlobIndexerImageAction? imageAction, bool? allowSkillsetToReadFileData, BlobIndexerPDFTextRotationAlgorithm? pdfTextRotationAlgorithm, IndexerExecutionEnvironment? executionEnvironment, string queryTimeout, IDictionary additionalProperties) + { + ParsingMode = parsingMode; + ExcludedFileNameExtensions = excludedFileNameExtensions; + IndexedFileNameExtensions = indexedFileNameExtensions; + FailOnUnsupportedContentType = failOnUnsupportedContentType; + FailOnUnprocessableDocument = failOnUnprocessableDocument; + IndexStorageMetadataOnlyForOversizedDocuments = indexStorageMetadataOnlyForOversizedDocuments; + DelimitedTextHeaders = delimitedTextHeaders; + DelimitedTextDelimiter = delimitedTextDelimiter; + FirstLineContainsHeaders = firstLineContainsHeaders; + MarkdownParsingSubmode = markdownParsingSubmode; + MarkdownHeaderDepth = markdownHeaderDepth; + DocumentRoot = documentRoot; + DataToExtract = dataToExtract; + ImageAction = imageAction; + AllowSkillsetToReadFileData = allowSkillsetToReadFileData; + PdfTextRotationAlgorithm = pdfTextRotationAlgorithm; + ExecutionEnvironment = executionEnvironment; + QueryTimeout = queryTimeout; + AdditionalProperties = additionalProperties; + } + + /// Represents the parsing mode for indexing from an Azure blob data source. + public BlobIndexerParsingMode? ParsingMode { get; set; } + /// + /// Comma-delimited list of filename extensions to ignore when processing from + /// Azure blob storage. For example, you could exclude ".png, .mp4" to skip over + /// those files during indexing. + /// + public string ExcludedFileNameExtensions { get; set; } + /// + /// Comma-delimited list of filename extensions to select when processing from + /// Azure blob storage. For example, you could focus indexing on specific + /// application files ".docx, .pptx, .msg" to specifically include those file + /// types. + /// + public string IndexedFileNameExtensions { get; set; } + /// + /// For Azure blobs, set to false if you want to continue indexing when an + /// unsupported content type is encountered, and you don't know all the content + /// types (file extensions) in advance. + /// + public bool? FailOnUnsupportedContentType { get; set; } + /// + /// For Azure blobs, set to false if you want to continue indexing if a document + /// fails indexing. + /// + public bool? FailOnUnprocessableDocument { get; set; } + /// + /// For Azure blobs, set this property to true to still index storage metadata for + /// blob content that is too large to process. Oversized blobs are treated as + /// errors by default. For limits on blob size, see + /// https://learn.microsoft.com/azure/search/search-limits-quotas-capacity. + /// + public bool? IndexStorageMetadataOnlyForOversizedDocuments { get; set; } + /// + /// For CSV blobs, specifies a comma-delimited list of column headers, useful for + /// mapping source fields to destination fields in an index. + /// + public string DelimitedTextHeaders { get; set; } + /// + /// For CSV blobs, specifies the end-of-line single-character delimiter for CSV + /// files where each line starts a new document (for example, "|"). + /// + public string DelimitedTextDelimiter { get; set; } + /// + /// For CSV blobs, indicates that the first (non-blank) line of each blob contains + /// headers. + /// + public bool? FirstLineContainsHeaders { get; set; } + /// + /// Specifies the submode that will determine whether a markdown file will be + /// parsed into exactly one search document or multiple search documents. Default + /// is `oneToMany`. + /// + public MarkdownParsingSubmode? MarkdownParsingSubmode { get; set; } + /// + /// Specifies the max header depth that will be considered while grouping markdown + /// content. Default is `h6`. + /// + public MarkdownHeaderDepth? MarkdownHeaderDepth { get; set; } + /// + /// For JSON arrays, given a structured or semi-structured document, you can + /// specify a path to the array using this property. + /// + public string DocumentRoot { get; set; } + /// + /// Specifies the data to extract from Azure blob storage and tells the indexer + /// which data to extract from image content when "imageAction" is set to a value + /// other than "none". This applies to embedded image content in a .PDF or other + /// application, or image files such as .jpg and .png, in Azure blobs. + /// + public BlobIndexerDataToExtract? DataToExtract { get; set; } + /// + /// Determines how to process embedded images and image files in Azure blob + /// storage. Setting the "imageAction" configuration to any value other than + /// "none" requires that a skillset also be attached to that indexer. + /// + public BlobIndexerImageAction? ImageAction { get; set; } + /// + /// If true, will create a path //document//file_data that is an object + /// representing the original file data downloaded from your blob data source. + /// This allows you to pass the original file data to a custom skill for processing + /// within the enrichment pipeline, or to the Document Extraction skill. + /// + public bool? AllowSkillsetToReadFileData { get; set; } + /// Determines algorithm for text extraction from PDF files in Azure blob storage. + public BlobIndexerPDFTextRotationAlgorithm? PdfTextRotationAlgorithm { get; set; } + /// Specifies the environment in which the indexer should execute. + public IndexerExecutionEnvironment? ExecutionEnvironment { get; set; } + /// + /// Increases the timeout beyond the 5-minute default for Azure SQL database data + /// sources, specified in the format "hh:mm:ss". + /// + public string QueryTimeout { get; set; } + /// + /// Additional Properties + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + public IDictionary AdditionalProperties { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingSchedule.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingSchedule.Serialization.cs new file mode 100644 index 000000000000..2f06dae5b520 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingSchedule.Serialization.cs @@ -0,0 +1,157 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class IndexingSchedule : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexingSchedule)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("interval"u8); + writer.WriteStringValue(Interval, "P"); + if (Optional.IsDefined(StartTime)) + { + writer.WritePropertyName("startTime"u8); + writer.WriteStringValue(StartTime.Value, "O"); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + IndexingSchedule IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexingSchedule)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeIndexingSchedule(document.RootElement, options); + } + + internal static IndexingSchedule DeserializeIndexingSchedule(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + TimeSpan interval = default; + DateTimeOffset? startTime = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("interval"u8)) + { + interval = property.Value.GetTimeSpan("P"); + continue; + } + if (property.NameEquals("startTime"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + startTime = property.Value.GetDateTimeOffset("O"); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new IndexingSchedule(interval, startTime, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(IndexingSchedule)} does not support writing '{options.Format}' format."); + } + } + + IndexingSchedule IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexingSchedule(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(IndexingSchedule)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static IndexingSchedule FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexingSchedule(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingSchedule.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingSchedule.cs new file mode 100644 index 000000000000..b30f32dc8dce --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/IndexingSchedule.cs @@ -0,0 +1,76 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents a schedule for indexer execution. + public partial class IndexingSchedule + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The interval of time between indexer executions. + public IndexingSchedule(TimeSpan interval) + { + Interval = interval; + } + + /// Initializes a new instance of . + /// The interval of time between indexer executions. + /// The time when an indexer should start running. + /// Keeps track of any properties unknown to the library. + internal IndexingSchedule(TimeSpan interval, DateTimeOffset? startTime, IDictionary serializedAdditionalRawData) + { + Interval = interval; + StartTime = startTime; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal IndexingSchedule() + { + } + + /// The interval of time between indexer executions. + public TimeSpan Interval { get; set; } + /// The time when an indexer should start running. + public DateTimeOffset? StartTime { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/InputFieldMappingEntry.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/InputFieldMappingEntry.Serialization.cs new file mode 100644 index 000000000000..c94767f32ebd --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/InputFieldMappingEntry.Serialization.cs @@ -0,0 +1,189 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class InputFieldMappingEntry : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(InputFieldMappingEntry)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + if (Optional.IsDefined(Source)) + { + writer.WritePropertyName("source"u8); + writer.WriteStringValue(Source); + } + if (Optional.IsDefined(SourceContext)) + { + writer.WritePropertyName("sourceContext"u8); + writer.WriteStringValue(SourceContext); + } + if (Optional.IsCollectionDefined(Inputs)) + { + writer.WritePropertyName("inputs"u8); + writer.WriteStartArray(); + foreach (var item in Inputs) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + InputFieldMappingEntry IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(InputFieldMappingEntry)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeInputFieldMappingEntry(document.RootElement, options); + } + + internal static InputFieldMappingEntry DeserializeInputFieldMappingEntry(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + string source = default; + string sourceContext = default; + IList inputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("source"u8)) + { + source = property.Value.GetString(); + continue; + } + if (property.NameEquals("sourceContext"u8)) + { + sourceContext = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new InputFieldMappingEntry(name, source, sourceContext, inputs ?? new ChangeTrackingList(), serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(InputFieldMappingEntry)} does not support writing '{options.Format}' format."); + } + } + + InputFieldMappingEntry IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeInputFieldMappingEntry(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(InputFieldMappingEntry)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static InputFieldMappingEntry FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeInputFieldMappingEntry(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/InputFieldMappingEntry.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/InputFieldMappingEntry.cs new file mode 100644 index 000000000000..7ff64205e702 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/InputFieldMappingEntry.cs @@ -0,0 +1,88 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Input field mapping for a skill. + public partial class InputFieldMappingEntry + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name of the input. + /// is null. + public InputFieldMappingEntry(string name) + { + Argument.AssertNotNull(name, nameof(name)); + + Name = name; + Inputs = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The name of the input. + /// The source of the input. + /// The source context used for selecting recursive inputs. + /// The recursive inputs used when creating a complex type. + /// Keeps track of any properties unknown to the library. + internal InputFieldMappingEntry(string name, string source, string sourceContext, IList inputs, IDictionary serializedAdditionalRawData) + { + Name = name; + Source = source; + SourceContext = sourceContext; + Inputs = inputs; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal InputFieldMappingEntry() + { + } + + /// The name of the input. + public string Name { get; set; } + /// The source of the input. + public string Source { get; set; } + /// The source context used for selecting recursive inputs. + public string SourceContext { get; set; } + /// The recursive inputs used when creating a complex type. + public IList Inputs { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/Argument.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/Argument.cs new file mode 100644 index 000000000000..105a45ef63c1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/Argument.cs @@ -0,0 +1,129 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + internal static class Argument + { + public static void AssertNotNull(T value, string name) + { + if (value is null) + { + throw new ArgumentNullException(name); + } + } + + public static void AssertNotNull(T? value, string name) + where T : struct + { + if (!value.HasValue) + { + throw new ArgumentNullException(name); + } + } + + public static void AssertNotNullOrEmpty(IEnumerable value, string name) + { + if (value is null) + { + throw new ArgumentNullException(name); + } + if (value is ICollection collectionOfT && collectionOfT.Count == 0) + { + throw new ArgumentException("Value cannot be an empty collection.", name); + } + if (value is ICollection collection && collection.Count == 0) + { + throw new ArgumentException("Value cannot be an empty collection.", name); + } + using IEnumerator e = value.GetEnumerator(); + if (!e.MoveNext()) + { + throw new ArgumentException("Value cannot be an empty collection.", name); + } + } + + public static void AssertNotNullOrEmpty(string value, string name) + { + if (value is null) + { + throw new ArgumentNullException(name); + } + if (value.Length == 0) + { + throw new ArgumentException("Value cannot be an empty string.", name); + } + } + + public static void AssertNotNullOrWhiteSpace(string value, string name) + { + if (value is null) + { + throw new ArgumentNullException(name); + } + if (string.IsNullOrWhiteSpace(value)) + { + throw new ArgumentException("Value cannot be empty or contain only white-space characters.", name); + } + } + + public static void AssertNotDefault(ref T value, string name) + where T : struct, IEquatable + { + if (value.Equals(default)) + { + throw new ArgumentException("Value cannot be empty.", name); + } + } + + public static void AssertInRange(T value, T minimum, T maximum, string name) + where T : notnull, IComparable + { + if (minimum.CompareTo(value) > 0) + { + throw new ArgumentOutOfRangeException(name, "Value is less than the minimum allowed."); + } + if (maximum.CompareTo(value) < 0) + { + throw new ArgumentOutOfRangeException(name, "Value is greater than the maximum allowed."); + } + } + + public static void AssertEnumDefined(Type enumType, object value, string name) + { + if (!Enum.IsDefined(enumType, value)) + { + throw new ArgumentException($"Value not defined for {enumType.FullName}.", name); + } + } + + public static T CheckNotNull(T value, string name) + where T : class + { + AssertNotNull(value, name); + return value; + } + + public static string CheckNotNullOrEmpty(string value, string name) + { + AssertNotNullOrEmpty(value, name); + return value; + } + + public static void AssertNull(T value, string name, string message = null) + { + if (value != null) + { + throw new ArgumentException(message ?? "Value must be null.", name); + } + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/ChangeTrackingDictionary.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/ChangeTrackingDictionary.cs new file mode 100644 index 000000000000..b18e4143a90e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/ChangeTrackingDictionary.cs @@ -0,0 +1,167 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + internal class ChangeTrackingDictionary : IDictionary, IReadOnlyDictionary where TKey : notnull + { + private IDictionary _innerDictionary; + + public ChangeTrackingDictionary() + { + } + + public ChangeTrackingDictionary(IDictionary dictionary) + { + if (dictionary == null) + { + return; + } + _innerDictionary = new Dictionary(dictionary); + } + + public ChangeTrackingDictionary(IReadOnlyDictionary dictionary) + { + if (dictionary == null) + { + return; + } + _innerDictionary = new Dictionary(); + foreach (var pair in dictionary) + { + _innerDictionary.Add(pair); + } + } + + public bool IsUndefined => _innerDictionary == null; + + public int Count => IsUndefined ? 0 : EnsureDictionary().Count; + + public bool IsReadOnly => IsUndefined ? false : EnsureDictionary().IsReadOnly; + + public ICollection Keys => IsUndefined ? Array.Empty() : EnsureDictionary().Keys; + + public ICollection Values => IsUndefined ? Array.Empty() : EnsureDictionary().Values; + + public TValue this[TKey key] + { + get + { + if (IsUndefined) + { + throw new KeyNotFoundException(nameof(key)); + } + return EnsureDictionary()[key]; + } + set + { + EnsureDictionary()[key] = value; + } + } + + IEnumerable IReadOnlyDictionary.Keys => Keys; + + IEnumerable IReadOnlyDictionary.Values => Values; + + public IEnumerator> GetEnumerator() + { + if (IsUndefined) + { + IEnumerator> enumerateEmpty() + { + yield break; + } + return enumerateEmpty(); + } + return EnsureDictionary().GetEnumerator(); + } + + IEnumerator IEnumerable.GetEnumerator() + { + return GetEnumerator(); + } + + public void Add(KeyValuePair item) + { + EnsureDictionary().Add(item); + } + + public void Clear() + { + EnsureDictionary().Clear(); + } + + public bool Contains(KeyValuePair item) + { + if (IsUndefined) + { + return false; + } + return EnsureDictionary().Contains(item); + } + + public void CopyTo(KeyValuePair[] array, int index) + { + if (IsUndefined) + { + return; + } + EnsureDictionary().CopyTo(array, index); + } + + public bool Remove(KeyValuePair item) + { + if (IsUndefined) + { + return false; + } + return EnsureDictionary().Remove(item); + } + + public void Add(TKey key, TValue value) + { + EnsureDictionary().Add(key, value); + } + + public bool ContainsKey(TKey key) + { + if (IsUndefined) + { + return false; + } + return EnsureDictionary().ContainsKey(key); + } + + public bool Remove(TKey key) + { + if (IsUndefined) + { + return false; + } + return EnsureDictionary().Remove(key); + } + + public bool TryGetValue(TKey key, out TValue value) + { + if (IsUndefined) + { + value = default; + return false; + } + return EnsureDictionary().TryGetValue(key, out value); + } + + public IDictionary EnsureDictionary() + { + return _innerDictionary ??= new Dictionary(); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/ChangeTrackingList.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/ChangeTrackingList.cs new file mode 100644 index 000000000000..09857cb32f44 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/ChangeTrackingList.cs @@ -0,0 +1,153 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + internal class ChangeTrackingList : IList, IReadOnlyList + { + private IList _innerList; + + public ChangeTrackingList() + { + } + + public ChangeTrackingList(IList innerList) + { + if (innerList != null) + { + _innerList = innerList; + } + } + + public ChangeTrackingList(IReadOnlyList innerList) + { + if (innerList != null) + { + _innerList = innerList.ToList(); + } + } + + public bool IsUndefined => _innerList == null; + + public int Count => IsUndefined ? 0 : EnsureList().Count; + + public bool IsReadOnly => IsUndefined ? false : EnsureList().IsReadOnly; + + public T this[int index] + { + get + { + if (IsUndefined) + { + throw new ArgumentOutOfRangeException(nameof(index)); + } + return EnsureList()[index]; + } + set + { + if (IsUndefined) + { + throw new ArgumentOutOfRangeException(nameof(index)); + } + EnsureList()[index] = value; + } + } + + public void Reset() + { + _innerList = null; + } + + public IEnumerator GetEnumerator() + { + if (IsUndefined) + { + IEnumerator enumerateEmpty() + { + yield break; + } + return enumerateEmpty(); + } + return EnsureList().GetEnumerator(); + } + + IEnumerator IEnumerable.GetEnumerator() + { + return GetEnumerator(); + } + + public void Add(T item) + { + EnsureList().Add(item); + } + + public void Clear() + { + EnsureList().Clear(); + } + + public bool Contains(T item) + { + if (IsUndefined) + { + return false; + } + return EnsureList().Contains(item); + } + + public void CopyTo(T[] array, int arrayIndex) + { + if (IsUndefined) + { + return; + } + EnsureList().CopyTo(array, arrayIndex); + } + + public bool Remove(T item) + { + if (IsUndefined) + { + return false; + } + return EnsureList().Remove(item); + } + + public int IndexOf(T item) + { + if (IsUndefined) + { + return -1; + } + return EnsureList().IndexOf(item); + } + + public void Insert(int index, T item) + { + EnsureList().Insert(index, item); + } + + public void RemoveAt(int index) + { + if (IsUndefined) + { + throw new ArgumentOutOfRangeException(nameof(index)); + } + EnsureList().RemoveAt(index); + } + + public IList EnsureList() + { + return _innerList ??= new List(); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/ModelSerializationExtensions.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/ModelSerializationExtensions.cs new file mode 100644 index 000000000000..21e882f37973 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/ModelSerializationExtensions.cs @@ -0,0 +1,399 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Diagnostics; +using System.Globalization; +using System.Text.Json; +using System.Xml; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal static class ModelSerializationExtensions + { + internal static readonly JsonDocumentOptions JsonDocumentOptions = new JsonDocumentOptions { MaxDepth = 256 }; + internal static readonly ModelReaderWriterOptions WireOptions = new ModelReaderWriterOptions("W"); + + public static object GetObject(this JsonElement element) + { + switch (element.ValueKind) + { + case JsonValueKind.String: + return element.GetString(); + case JsonValueKind.Number: + if (element.TryGetInt32(out int intValue)) + { + return intValue; + } + if (element.TryGetInt64(out long longValue)) + { + return longValue; + } + return element.GetDouble(); + case JsonValueKind.True: + return true; + case JsonValueKind.False: + return false; + case JsonValueKind.Undefined: + case JsonValueKind.Null: + return null; + case JsonValueKind.Object: + var dictionary = new Dictionary(); + foreach (var jsonProperty in element.EnumerateObject()) + { + dictionary.Add(jsonProperty.Name, jsonProperty.Value.GetObject()); + } + return dictionary; + case JsonValueKind.Array: + var list = new List(); + foreach (var item in element.EnumerateArray()) + { + list.Add(item.GetObject()); + } + return list.ToArray(); + default: + throw new NotSupportedException($"Not supported value kind {element.ValueKind}"); + } + } + + public static byte[] GetBytesFromBase64(this JsonElement element, string format) + { + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + + return format switch + { + "U" => TypeFormatters.FromBase64UrlString(element.GetRequiredString()), + "D" => element.GetBytesFromBase64(), + _ => throw new ArgumentException($"Format is not supported: '{format}'", nameof(format)) + }; + } + + public static DateTimeOffset GetDateTimeOffset(this JsonElement element, string format) => format switch + { + "U" when element.ValueKind == JsonValueKind.Number => DateTimeOffset.FromUnixTimeSeconds(element.GetInt64()), + _ => TypeFormatters.ParseDateTimeOffset(element.GetString(), format) + }; + + public static TimeSpan GetTimeSpan(this JsonElement element, string format) => TypeFormatters.ParseTimeSpan(element.GetString(), format); + + public static char GetChar(this JsonElement element) + { + if (element.ValueKind == JsonValueKind.String) + { + var text = element.GetString(); + if (text == null || text.Length != 1) + { + throw new NotSupportedException($"Cannot convert \"{text}\" to a char"); + } + return text[0]; + } + else + { + throw new NotSupportedException($"Cannot convert {element.ValueKind} to a char"); + } + } + + [Conditional("DEBUG")] + public static void ThrowNonNullablePropertyIsNull(this JsonProperty property) + { + throw new JsonException($"A property '{property.Name}' defined as non-nullable but received as null from the service. This exception only happens in DEBUG builds of the library and would be ignored in the release build"); + } + + public static string GetRequiredString(this JsonElement element) + { + var value = element.GetString(); + if (value == null) + { + throw new InvalidOperationException($"The requested operation requires an element of type 'String', but the target element has type '{element.ValueKind}'."); + } + return value; + } + + public static void WriteStringValue(this Utf8JsonWriter writer, DateTimeOffset value, string format) + { + writer.WriteStringValue(TypeFormatters.ToString(value, format)); + } + + public static void WriteStringValue(this Utf8JsonWriter writer, DateTime value, string format) + { + writer.WriteStringValue(TypeFormatters.ToString(value, format)); + } + + public static void WriteStringValue(this Utf8JsonWriter writer, TimeSpan value, string format) + { + writer.WriteStringValue(TypeFormatters.ToString(value, format)); + } + + public static void WriteStringValue(this Utf8JsonWriter writer, char value) + { + writer.WriteStringValue(value.ToString(CultureInfo.InvariantCulture)); + } + + public static void WriteBase64StringValue(this Utf8JsonWriter writer, byte[] value, string format) + { + if (value == null) + { + writer.WriteNullValue(); + return; + } + switch (format) + { + case "U": + writer.WriteStringValue(TypeFormatters.ToBase64UrlString(value)); + break; + case "D": + writer.WriteBase64StringValue(value); + break; + default: + throw new ArgumentException($"Format is not supported: '{format}'", nameof(format)); + } + } + + public static void WriteNumberValue(this Utf8JsonWriter writer, DateTimeOffset value, string format) + { + if (format != "U") + { + throw new ArgumentOutOfRangeException(nameof(format), "Only 'U' format is supported when writing a DateTimeOffset as a Number."); + } + writer.WriteNumberValue(value.ToUnixTimeSeconds()); + } + + public static void WriteObjectValue(this Utf8JsonWriter writer, T value, ModelReaderWriterOptions options = null) + { + switch (value) + { + case null: + writer.WriteNullValue(); + break; + case IJsonModel jsonModel: + jsonModel.Write(writer, options ?? WireOptions); + break; + case IUtf8JsonSerializable serializable: + serializable.Write(writer); + break; + case byte[] bytes: + writer.WriteBase64StringValue(bytes); + break; + case BinaryData bytes0: + writer.WriteBase64StringValue(bytes0); + break; + case JsonElement json: + json.WriteTo(writer); + break; + case int i: + writer.WriteNumberValue(i); + break; + case decimal d: + writer.WriteNumberValue(d); + break; + case double d0: + if (double.IsNaN(d0)) + { + writer.WriteStringValue("NaN"); + } + else + { + writer.WriteNumberValue(d0); + } + break; + case float f: + writer.WriteNumberValue(f); + break; + case long l: + writer.WriteNumberValue(l); + break; + case string s: + writer.WriteStringValue(s); + break; + case bool b: + writer.WriteBooleanValue(b); + break; + case Guid g: + writer.WriteStringValue(g); + break; + case DateTimeOffset dateTimeOffset: + writer.WriteStringValue(dateTimeOffset, "O"); + break; + case DateTime dateTime: + writer.WriteStringValue(dateTime, "O"); + break; + case IEnumerable> enumerable: + writer.WriteStartObject(); + foreach (var pair in enumerable) + { + writer.WritePropertyName(pair.Key); + writer.WriteObjectValue(pair.Value, options); + } + writer.WriteEndObject(); + break; + case IEnumerable objectEnumerable: + writer.WriteStartArray(); + foreach (var item in objectEnumerable) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + break; + case TimeSpan timeSpan: + writer.WriteStringValue(timeSpan, "P"); + break; + default: + throw new NotSupportedException($"Not supported type {value.GetType()}"); + } + } + + public static void WriteObjectValue(this Utf8JsonWriter writer, object value, ModelReaderWriterOptions options = null) + { + writer.WriteObjectValue(value, options); + } + + internal static class TypeFormatters + { + private const string RoundtripZFormat = "yyyy-MM-ddTHH:mm:ss.fffffffZ"; + public const string DefaultNumberFormat = "G"; + + public static string ToString(bool value) => value ? "true" : "false"; + + public static string ToString(DateTime value, string format) => value.Kind switch + { + DateTimeKind.Utc => ToString((DateTimeOffset)value, format), + _ => throw new NotSupportedException($"DateTime {value} has a Kind of {value.Kind}. Azure SDK requires it to be UTC. You can call DateTime.SpecifyKind to change Kind property value to DateTimeKind.Utc.") + }; + + public static string ToString(DateTimeOffset value, string format) => format switch + { + "D" => value.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture), + "U" => value.ToUnixTimeSeconds().ToString(CultureInfo.InvariantCulture), + "O" => value.ToUniversalTime().ToString(RoundtripZFormat, CultureInfo.InvariantCulture), + "o" => value.ToUniversalTime().ToString(RoundtripZFormat, CultureInfo.InvariantCulture), + "R" => value.ToString("r", CultureInfo.InvariantCulture), + _ => value.ToString(format, CultureInfo.InvariantCulture) + }; + + public static string ToString(TimeSpan value, string format) => format switch + { + "P" => XmlConvert.ToString(value), + _ => value.ToString(format, CultureInfo.InvariantCulture) + }; + + public static string ToString(byte[] value, string format) => format switch + { + "U" => ToBase64UrlString(value), + "D" => Convert.ToBase64String(value), + _ => throw new ArgumentException($"Format is not supported: '{format}'", nameof(format)) + }; + + public static string ToBase64UrlString(byte[] value) + { + int numWholeOrPartialInputBlocks = checked(value.Length + 2) / 3; + int size = checked(numWholeOrPartialInputBlocks * 4); + char[] output = new char[size]; + + int numBase64Chars = Convert.ToBase64CharArray(value, 0, value.Length, output, 0); + + int i = 0; + for (; i < numBase64Chars; i++) + { + char ch = output[i]; + if (ch == '+') + { + output[i] = '-'; + } + else + { + if (ch == '/') + { + output[i] = '_'; + } + else + { + if (ch == '=') + { + break; + } + } + } + } + + return new string(output, 0, i); + } + + public static byte[] FromBase64UrlString(string value) + { + int paddingCharsToAdd = (value.Length % 4) switch + { + 0 => 0, + 2 => 2, + 3 => 1, + _ => throw new InvalidOperationException("Malformed input") + }; + char[] output = new char[(value.Length + paddingCharsToAdd)]; + int i = 0; + for (; i < value.Length; i++) + { + char ch = value[i]; + if (ch == '-') + { + output[i] = '+'; + } + else + { + if (ch == '_') + { + output[i] = '/'; + } + else + { + output[i] = ch; + } + } + } + + for (; i < output.Length; i++) + { + output[i] = '='; + } + + return Convert.FromBase64CharArray(output, 0, output.Length); + } + + public static DateTimeOffset ParseDateTimeOffset(string value, string format) => format switch + { + "U" => DateTimeOffset.FromUnixTimeSeconds(long.Parse(value, CultureInfo.InvariantCulture)), + _ => DateTimeOffset.Parse(value, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal) + }; + + public static TimeSpan ParseTimeSpan(string value, string format) => format switch + { + "P" => XmlConvert.ToTimeSpan(value), + _ => TimeSpan.ParseExact(value, format, CultureInfo.InvariantCulture) + }; + + public static string ConvertToString(object value, string format = null) => value switch + { + null => "null", + string s => s, + bool b => ToString(b), + int or float or double or long or decimal => ((IFormattable)value).ToString(DefaultNumberFormat, CultureInfo.InvariantCulture), + byte[] b0 when format != null => ToString(b0, format), + IEnumerable s0 => string.Join(",", s0), + DateTimeOffset dateTime when format != null => ToString(dateTime, format), + TimeSpan timeSpan when format != null => ToString(timeSpan, format), + TimeSpan timeSpan0 => XmlConvert.ToString(timeSpan0), + Guid guid => guid.ToString(), + BinaryData binaryData => ConvertToString(binaryData.ToArray(), format), + _ => value.ToString() + }; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/Optional.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/Optional.cs new file mode 100644 index 000000000000..a32c6f0d5d97 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/Optional.cs @@ -0,0 +1,51 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System.Collections.Generic; +using System.Text.Json; + +namespace Azure.Search.Documents.Indexes +{ + internal static class Optional + { + public static bool IsCollectionDefined(IEnumerable collection) + { + return !(collection is ChangeTrackingList changeTrackingList && changeTrackingList.IsUndefined); + } + + public static bool IsCollectionDefined(IDictionary collection) + { + return !(collection is ChangeTrackingDictionary changeTrackingDictionary && changeTrackingDictionary.IsUndefined); + } + + public static bool IsCollectionDefined(IReadOnlyDictionary collection) + { + return !(collection is ChangeTrackingDictionary changeTrackingDictionary && changeTrackingDictionary.IsUndefined); + } + + public static bool IsDefined(T? value) + where T : struct + { + return value.HasValue; + } + + public static bool IsDefined(object value) + { + return value != null; + } + + public static bool IsDefined(JsonElement value) + { + return value.ValueKind != JsonValueKind.Undefined; + } + + public static bool IsDefined(string value) + { + return value != null; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/Utf8JsonRequestContent.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/Utf8JsonRequestContent.cs new file mode 100644 index 000000000000..075dd34a576b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Internal/Utf8JsonRequestContent.cs @@ -0,0 +1,55 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System.IO; +using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal class Utf8JsonRequestContent : RequestContent + { + private readonly MemoryStream _stream; + private readonly RequestContent _content; + + public Utf8JsonRequestContent() + { + _stream = new MemoryStream(); + _content = Create(_stream); + JsonWriter = new Utf8JsonWriter(_stream); + } + + public Utf8JsonWriter JsonWriter { get; } + + public override async Task WriteToAsync(Stream stream, CancellationToken cancellationToken = default) + { + await JsonWriter.FlushAsync().ConfigureAwait(false); + await _content.WriteToAsync(stream, cancellationToken).ConfigureAwait(false); + } + + public override void WriteTo(Stream stream, CancellationToken cancellationToken = default) + { + JsonWriter.Flush(); + _content.WriteTo(stream, cancellationToken); + } + + public override bool TryComputeLength(out long length) + { + length = JsonWriter.BytesCommitted + JsonWriter.BytesPending; + return true; + } + + public override void Dispose() + { + JsonWriter.Dispose(); + _content.Dispose(); + _stream.Dispose(); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeepTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeepTokenFilter.Serialization.cs new file mode 100644 index 000000000000..28981de382d1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeepTokenFilter.Serialization.cs @@ -0,0 +1,165 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class KeepTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(KeepTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("keepWords"u8); + writer.WriteStartArray(); + foreach (var item in KeepWords) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + if (Optional.IsDefined(KeepWordsCase)) + { + writer.WritePropertyName("keepWordsCase"u8); + writer.WriteBooleanValue(KeepWordsCase.Value); + } + } + + KeepTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(KeepTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeKeepTokenFilter(document.RootElement, options); + } + + internal static KeepTokenFilter DeserializeKeepTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList keepWords = default; + bool? keepWordsCase = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("keepWords"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + keepWords = array; + continue; + } + if (property.NameEquals("keepWordsCase"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + keepWordsCase = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new KeepTokenFilter(odataType, name, serializedAdditionalRawData, keepWords, keepWordsCase); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(KeepTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + KeepTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeKeepTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(KeepTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new KeepTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeKeepTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeepTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeepTokenFilter.cs new file mode 100644 index 000000000000..c9a408c6dcd8 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeepTokenFilter.cs @@ -0,0 +1,63 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A token filter that only keeps tokens with text contained in a specified list + /// of words. This token filter is implemented using Apache Lucene. + /// + public partial class KeepTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// or is null. + public KeepTokenFilter(string name, IEnumerable keepWords) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(keepWords, nameof(keepWords)); + + OdataType = "#Microsoft.Azure.Search.KeepTokenFilter"; + KeepWords = keepWords.ToList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// The list of words to keep. + /// A value indicating whether to lower case all words first. Default is false. + internal KeepTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, IList keepWords, bool? keepWordsCase) : base(odataType, name, serializedAdditionalRawData) + { + KeepWords = keepWords; + KeepWordsCase = keepWordsCase; + } + + /// Initializes a new instance of for deserialization. + internal KeepTokenFilter() + { + } + + /// The list of words to keep. + public IList KeepWords { get; } + /// A value indicating whether to lower case all words first. Default is false. + public bool? KeepWordsCase { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeyPhraseExtractionSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeyPhraseExtractionSkill.Serialization.cs new file mode 100644 index 000000000000..b60ae42fb91f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeyPhraseExtractionSkill.Serialization.cs @@ -0,0 +1,217 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class KeyPhraseExtractionSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(KeyPhraseExtractionSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(DefaultLanguageCode)) + { + writer.WritePropertyName("defaultLanguageCode"u8); + writer.WriteStringValue(DefaultLanguageCode.Value.ToString()); + } + if (Optional.IsDefined(MaxKeyPhraseCount)) + { + writer.WritePropertyName("maxKeyPhraseCount"u8); + writer.WriteNumberValue(MaxKeyPhraseCount.Value); + } + if (Optional.IsDefined(ModelVersion)) + { + writer.WritePropertyName("modelVersion"u8); + writer.WriteStringValue(ModelVersion); + } + } + + KeyPhraseExtractionSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(KeyPhraseExtractionSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeKeyPhraseExtractionSkill(document.RootElement, options); + } + + internal static KeyPhraseExtractionSkill DeserializeKeyPhraseExtractionSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + KeyPhraseExtractionSkillLanguage? defaultLanguageCode = default; + int? maxKeyPhraseCount = default; + string modelVersion = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("defaultLanguageCode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + defaultLanguageCode = new KeyPhraseExtractionSkillLanguage(property.Value.GetString()); + continue; + } + if (property.NameEquals("maxKeyPhraseCount"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxKeyPhraseCount = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("modelVersion"u8)) + { + modelVersion = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new KeyPhraseExtractionSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + defaultLanguageCode, + maxKeyPhraseCount, + modelVersion); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(KeyPhraseExtractionSkill)} does not support writing '{options.Format}' format."); + } + } + + KeyPhraseExtractionSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeKeyPhraseExtractionSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(KeyPhraseExtractionSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new KeyPhraseExtractionSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeKeyPhraseExtractionSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeyPhraseExtractionSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeyPhraseExtractionSkill.cs new file mode 100644 index 000000000000..d03b9bb7aea5 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeyPhraseExtractionSkill.cs @@ -0,0 +1,95 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// A skill that uses text analytics for key phrase extraction. + public partial class KeyPhraseExtractionSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public KeyPhraseExtractionSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Text.KeyPhraseExtractionSkill"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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, IDictionary serializedAdditionalRawData, KeyPhraseExtractionSkillLanguage? defaultLanguageCode, int? maxKeyPhraseCount, string modelVersion) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + DefaultLanguageCode = defaultLanguageCode; + MaxKeyPhraseCount = maxKeyPhraseCount; + ModelVersion = modelVersion; + } + + /// Initializes a new instance of for deserialization. + internal KeyPhraseExtractionSkill() + { + } + + /// 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; } + /// + /// 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. + /// + public string ModelVersion { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeyPhraseExtractionSkillLanguage.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeyPhraseExtractionSkillLanguage.cs new file mode 100644 index 000000000000..ba198c03ff6e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeyPhraseExtractionSkillLanguage.cs @@ -0,0 +1,93 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The language codes supported for input text by KeyPhraseExtractionSkill. + public readonly partial struct KeyPhraseExtractionSkillLanguage : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public KeyPhraseExtractionSkillLanguage(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string DaValue = "da"; + private const string NlValue = "nl"; + private const string EnValue = "en"; + private const string FiValue = "fi"; + private const string FrValue = "fr"; + private const string DeValue = "de"; + private const string ItValue = "it"; + private const string JaValue = "ja"; + private const string KoValue = "ko"; + private const string NoValue = "no"; + private const string PlValue = "pl"; + private const string PtPTValue = "pt-PT"; + private const string PtBRValue = "pt-BR"; + private const string RuValue = "ru"; + private const string EsValue = "es"; + private const string SvValue = "sv"; + + /// Danish. + public static KeyPhraseExtractionSkillLanguage Da { get; } = new KeyPhraseExtractionSkillLanguage(DaValue); + /// Dutch. + public static KeyPhraseExtractionSkillLanguage Nl { get; } = new KeyPhraseExtractionSkillLanguage(NlValue); + /// English. + public static KeyPhraseExtractionSkillLanguage En { get; } = new KeyPhraseExtractionSkillLanguage(EnValue); + /// Finnish. + public static KeyPhraseExtractionSkillLanguage Fi { get; } = new KeyPhraseExtractionSkillLanguage(FiValue); + /// French. + public static KeyPhraseExtractionSkillLanguage Fr { get; } = new KeyPhraseExtractionSkillLanguage(FrValue); + /// German. + public static KeyPhraseExtractionSkillLanguage De { get; } = new KeyPhraseExtractionSkillLanguage(DeValue); + /// Italian. + public static KeyPhraseExtractionSkillLanguage It { get; } = new KeyPhraseExtractionSkillLanguage(ItValue); + /// Japanese. + public static KeyPhraseExtractionSkillLanguage Ja { get; } = new KeyPhraseExtractionSkillLanguage(JaValue); + /// Korean. + public static KeyPhraseExtractionSkillLanguage Ko { get; } = new KeyPhraseExtractionSkillLanguage(KoValue); + /// Norwegian (Bokmaal). + public static KeyPhraseExtractionSkillLanguage No { get; } = new KeyPhraseExtractionSkillLanguage(NoValue); + /// Polish. + public static KeyPhraseExtractionSkillLanguage Pl { get; } = new KeyPhraseExtractionSkillLanguage(PlValue); + /// Portuguese (Portugal). + public static KeyPhraseExtractionSkillLanguage PtPT { get; } = new KeyPhraseExtractionSkillLanguage(PtPTValue); + /// Portuguese (Brazil). + public static KeyPhraseExtractionSkillLanguage PtBR { get; } = new KeyPhraseExtractionSkillLanguage(PtBRValue); + /// Russian. + public static KeyPhraseExtractionSkillLanguage Ru { get; } = new KeyPhraseExtractionSkillLanguage(RuValue); + /// Spanish. + public static KeyPhraseExtractionSkillLanguage Es { get; } = new KeyPhraseExtractionSkillLanguage(EsValue); + /// Swedish. + public static KeyPhraseExtractionSkillLanguage Sv { get; } = new KeyPhraseExtractionSkillLanguage(SvValue); + /// Determines if two values are the same. + public static bool operator ==(KeyPhraseExtractionSkillLanguage left, KeyPhraseExtractionSkillLanguage right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(KeyPhraseExtractionSkillLanguage left, KeyPhraseExtractionSkillLanguage right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator KeyPhraseExtractionSkillLanguage(string value) => new KeyPhraseExtractionSkillLanguage(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is KeyPhraseExtractionSkillLanguage other && Equals(other); + /// + public bool Equals(KeyPhraseExtractionSkillLanguage other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeywordMarkerTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeywordMarkerTokenFilter.Serialization.cs new file mode 100644 index 000000000000..ec030ad6aac9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeywordMarkerTokenFilter.Serialization.cs @@ -0,0 +1,165 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class KeywordMarkerTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(KeywordMarkerTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("keywords"u8); + writer.WriteStartArray(); + foreach (var item in Keywords) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + if (Optional.IsDefined(IgnoreCase)) + { + writer.WritePropertyName("ignoreCase"u8); + writer.WriteBooleanValue(IgnoreCase.Value); + } + } + + KeywordMarkerTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(KeywordMarkerTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeKeywordMarkerTokenFilter(document.RootElement, options); + } + + internal static KeywordMarkerTokenFilter DeserializeKeywordMarkerTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList keywords = default; + bool? ignoreCase = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("keywords"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + keywords = array; + continue; + } + if (property.NameEquals("ignoreCase"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + ignoreCase = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new KeywordMarkerTokenFilter(odataType, name, serializedAdditionalRawData, keywords, ignoreCase); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(KeywordMarkerTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + KeywordMarkerTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeKeywordMarkerTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(KeywordMarkerTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new KeywordMarkerTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeKeywordMarkerTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeywordMarkerTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeywordMarkerTokenFilter.cs new file mode 100644 index 000000000000..66a520a5f354 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeywordMarkerTokenFilter.cs @@ -0,0 +1,66 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// Marks terms as keywords. This token filter is implemented using Apache Lucene. + public partial class KeywordMarkerTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// or is null. + public KeywordMarkerTokenFilter(string name, IEnumerable keywords) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(keywords, nameof(keywords)); + + OdataType = "#Microsoft.Azure.Search.KeywordMarkerTokenFilter"; + Keywords = keywords.ToList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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. + /// + internal KeywordMarkerTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, IList keywords, bool? ignoreCase) : base(odataType, name, serializedAdditionalRawData) + { + Keywords = keywords; + IgnoreCase = ignoreCase; + } + + /// Initializes a new instance of for deserialization. + internal KeywordMarkerTokenFilter() + { + } + + /// A list of words to mark as keywords. + public IList Keywords { get; } + /// + /// A value indicating whether to ignore case. If true, all words are converted to + /// lower case first. Default is false. + /// + public bool? IgnoreCase { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeywordTokenizerV2.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeywordTokenizerV2.Serialization.cs new file mode 100644 index 000000000000..35a7fa098e18 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeywordTokenizerV2.Serialization.cs @@ -0,0 +1,147 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class KeywordTokenizerV2 : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(KeywordTokenizerV2)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(MaxTokenLength)) + { + writer.WritePropertyName("maxTokenLength"u8); + writer.WriteNumberValue(MaxTokenLength.Value); + } + } + + KeywordTokenizerV2 IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(KeywordTokenizerV2)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeKeywordTokenizerV2(document.RootElement, options); + } + + internal static KeywordTokenizerV2 DeserializeKeywordTokenizerV2(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? maxTokenLength = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("maxTokenLength"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxTokenLength = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new KeywordTokenizerV2(odataType, name, serializedAdditionalRawData, maxTokenLength); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(KeywordTokenizerV2)} does not support writing '{options.Format}' format."); + } + } + + KeywordTokenizerV2 IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeKeywordTokenizerV2(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(KeywordTokenizerV2)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new KeywordTokenizerV2 FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeKeywordTokenizerV2(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeywordTokenizerV2.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeywordTokenizerV2.cs new file mode 100644 index 000000000000..64dd757e3b9c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/KeywordTokenizerV2.cs @@ -0,0 +1,61 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Emits the entire input as a single token. This tokenizer is implemented using + /// Apache Lucene. + /// + public partial class KeywordTokenizerV2 : LexicalTokenizer + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public KeywordTokenizerV2(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.KeywordTokenizerV2"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// The maximum token length. Default is 256. Tokens longer than the maximum length + /// are split. The maximum token length that can be used is 300 characters. + /// + internal KeywordTokenizerV2(string odataType, string name, IDictionary serializedAdditionalRawData, int? maxTokenLength) : base(odataType, name, serializedAdditionalRawData) + { + MaxTokenLength = maxTokenLength; + } + + /// Initializes a new instance of for deserialization. + internal KeywordTokenizerV2() + { + } + + /// + /// The maximum token length. Default is 256. Tokens longer than the maximum length + /// are split. The maximum token length that can be used is 300 characters. + /// + public int? MaxTokenLength { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LanguageDetectionSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LanguageDetectionSkill.Serialization.cs new file mode 100644 index 000000000000..e8ae1e5986ea --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LanguageDetectionSkill.Serialization.cs @@ -0,0 +1,197 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class LanguageDetectionSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LanguageDetectionSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(DefaultCountryHint)) + { + writer.WritePropertyName("defaultCountryHint"u8); + writer.WriteStringValue(DefaultCountryHint); + } + if (Optional.IsDefined(ModelVersion)) + { + writer.WritePropertyName("modelVersion"u8); + writer.WriteStringValue(ModelVersion); + } + } + + LanguageDetectionSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LanguageDetectionSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeLanguageDetectionSkill(document.RootElement, options); + } + + internal static LanguageDetectionSkill DeserializeLanguageDetectionSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string defaultCountryHint = default; + string modelVersion = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("defaultCountryHint"u8)) + { + defaultCountryHint = property.Value.GetString(); + continue; + } + if (property.NameEquals("modelVersion"u8)) + { + modelVersion = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new LanguageDetectionSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + defaultCountryHint, + modelVersion); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(LanguageDetectionSkill)} does not support writing '{options.Format}' format."); + } + } + + LanguageDetectionSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLanguageDetectionSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(LanguageDetectionSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new LanguageDetectionSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLanguageDetectionSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LanguageDetectionSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LanguageDetectionSkill.cs new file mode 100644 index 000000000000..c3183b4a03e5 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LanguageDetectionSkill.cs @@ -0,0 +1,95 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A skill that detects the language of input text and reports a single language + /// code for every document submitted on the request. The language code is paired + /// with a score indicating the confidence of the analysis. + /// + public partial class LanguageDetectionSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public LanguageDetectionSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Text.LanguageDetectionSkill"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// A country code to use as a hint to the language detection model if it cannot + /// disambiguate the language. + /// + /// + /// 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 LanguageDetectionSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData, string defaultCountryHint, string modelVersion) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + DefaultCountryHint = defaultCountryHint; + ModelVersion = modelVersion; + } + + /// Initializes a new instance of for deserialization. + internal LanguageDetectionSkill() + { + } + + /// + /// A country code to use as a hint to the language detection model if it cannot + /// disambiguate the language. + /// + public string DefaultCountryHint { 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. + /// + public string ModelVersion { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LengthTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LengthTokenFilter.Serialization.cs new file mode 100644 index 000000000000..0b213ae1d3c5 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LengthTokenFilter.Serialization.cs @@ -0,0 +1,162 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class LengthTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LengthTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(Min)) + { + writer.WritePropertyName("min"u8); + writer.WriteNumberValue(Min.Value); + } + if (Optional.IsDefined(Max)) + { + writer.WritePropertyName("max"u8); + writer.WriteNumberValue(Max.Value); + } + } + + LengthTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LengthTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeLengthTokenFilter(document.RootElement, options); + } + + internal static LengthTokenFilter DeserializeLengthTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? min = default; + int? max = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("min"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + min = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("max"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + max = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new LengthTokenFilter(odataType, name, serializedAdditionalRawData, min, max); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(LengthTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + LengthTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLengthTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(LengthTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new LengthTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLengthTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LengthTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LengthTokenFilter.cs new file mode 100644 index 000000000000..578831bbbf6a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LengthTokenFilter.cs @@ -0,0 +1,65 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Removes words that are too long or too short. This token filter is implemented + /// using Apache Lucene. + /// + public partial class LengthTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public LengthTokenFilter(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.LengthTokenFilter"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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. + internal LengthTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, int? min, int? max) : base(odataType, name, serializedAdditionalRawData) + { + Min = min; + Max = max; + } + + /// Initializes a new instance of for deserialization. + internal LengthTokenFilter() + { + } + + /// + /// The minimum length in characters. Default is 0. Maximum is 300. Must be less + /// than the value of max. + /// + public int? Min { get; set; } + /// The maximum length in characters. Default and maximum is 300. + public int? Max { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalAnalyzer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalAnalyzer.Serialization.cs new file mode 100644 index 000000000000..56eac03c66a6 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalAnalyzer.Serialization.cs @@ -0,0 +1,138 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + [PersistableModelProxy(typeof(UnknownLexicalAnalyzer))] + public partial class LexicalAnalyzer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LexicalAnalyzer)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("@odata.type"u8); + writer.WriteStringValue(OdataType); + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + LexicalAnalyzer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LexicalAnalyzer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeLexicalAnalyzer(document.RootElement, options); + } + + internal static LexicalAnalyzer DeserializeLexicalAnalyzer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("@odata.type", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "#Microsoft.Azure.Search.CustomAnalyzer": return CustomAnalyzer.DeserializeCustomAnalyzer(element, options); + case "#Microsoft.Azure.Search.PatternAnalyzer": return PatternAnalyzer.DeserializePatternAnalyzer(element, options); + case "#Microsoft.Azure.Search.StandardAnalyzer": return LuceneStandardAnalyzer.DeserializeLuceneStandardAnalyzer(element, options); + case "#Microsoft.Azure.Search.StopAnalyzer": return StopAnalyzer.DeserializeStopAnalyzer(element, options); + } + } + return UnknownLexicalAnalyzer.DeserializeUnknownLexicalAnalyzer(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(LexicalAnalyzer)} does not support writing '{options.Format}' format."); + } + } + + LexicalAnalyzer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLexicalAnalyzer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(LexicalAnalyzer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static LexicalAnalyzer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLexicalAnalyzer(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalAnalyzer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalAnalyzer.cs new file mode 100644 index 000000000000..730e51ddc6de --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalAnalyzer.cs @@ -0,0 +1,95 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Base type for analyzers. + /// 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 abstract partial class LexicalAnalyzer + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + protected LexicalAnalyzer(string name) + { + Argument.AssertNotNull(name, nameof(name)); + + Name = name; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal LexicalAnalyzer(string odataType, string name, IDictionary serializedAdditionalRawData) + { + OdataType = odataType; + Name = name; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal LexicalAnalyzer() + { + } + + /// The discriminator for derived types. + 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.Indexes/src/Generated/LexicalAnalyzerName.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalAnalyzerName.cs new file mode 100644 index 000000000000..cef07bdb8f81 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalAnalyzerName.cs @@ -0,0 +1,344 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Defines the names of all text analyzers supported by the search engine. + public readonly partial struct LexicalAnalyzerName : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public LexicalAnalyzerName(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string ArMicrosoftValue = "ar.microsoft"; + private const string ArLuceneValue = "ar.lucene"; + private const string HyLuceneValue = "hy.lucene"; + private const string BnMicrosoftValue = "bn.microsoft"; + private const string EuLuceneValue = "eu.lucene"; + private const string BgMicrosoftValue = "bg.microsoft"; + private const string BgLuceneValue = "bg.lucene"; + private const string CaMicrosoftValue = "ca.microsoft"; + private const string CaLuceneValue = "ca.lucene"; + private const string ZhHansMicrosoftValue = "zh-Hans.microsoft"; + private const string ZhHansLuceneValue = "zh-Hans.lucene"; + private const string ZhHantMicrosoftValue = "zh-Hant.microsoft"; + private const string ZhHantLuceneValue = "zh-Hant.lucene"; + private const string HrMicrosoftValue = "hr.microsoft"; + private const string CsMicrosoftValue = "cs.microsoft"; + private const string CsLuceneValue = "cs.lucene"; + private const string DaMicrosoftValue = "da.microsoft"; + private const string DaLuceneValue = "da.lucene"; + private const string NlMicrosoftValue = "nl.microsoft"; + private const string NlLuceneValue = "nl.lucene"; + private const string EnMicrosoftValue = "en.microsoft"; + private const string EnLuceneValue = "en.lucene"; + private const string EtMicrosoftValue = "et.microsoft"; + private const string FiMicrosoftValue = "fi.microsoft"; + private const string FiLuceneValue = "fi.lucene"; + private const string FrMicrosoftValue = "fr.microsoft"; + private const string FrLuceneValue = "fr.lucene"; + private const string GlLuceneValue = "gl.lucene"; + private const string DeMicrosoftValue = "de.microsoft"; + private const string DeLuceneValue = "de.lucene"; + private const string ElMicrosoftValue = "el.microsoft"; + private const string ElLuceneValue = "el.lucene"; + private const string GuMicrosoftValue = "gu.microsoft"; + private const string HeMicrosoftValue = "he.microsoft"; + private const string HiMicrosoftValue = "hi.microsoft"; + private const string HiLuceneValue = "hi.lucene"; + private const string HuMicrosoftValue = "hu.microsoft"; + private const string HuLuceneValue = "hu.lucene"; + private const string IsMicrosoftValue = "is.microsoft"; + private const string IdMicrosoftValue = "id.microsoft"; + private const string IdLuceneValue = "id.lucene"; + private const string GaLuceneValue = "ga.lucene"; + private const string ItMicrosoftValue = "it.microsoft"; + private const string ItLuceneValue = "it.lucene"; + private const string JaMicrosoftValue = "ja.microsoft"; + private const string JaLuceneValue = "ja.lucene"; + private const string KnMicrosoftValue = "kn.microsoft"; + private const string KoMicrosoftValue = "ko.microsoft"; + private const string KoLuceneValue = "ko.lucene"; + private const string LvMicrosoftValue = "lv.microsoft"; + private const string LvLuceneValue = "lv.lucene"; + private const string LtMicrosoftValue = "lt.microsoft"; + private const string MlMicrosoftValue = "ml.microsoft"; + private const string MsMicrosoftValue = "ms.microsoft"; + private const string MrMicrosoftValue = "mr.microsoft"; + private const string NbMicrosoftValue = "nb.microsoft"; + private const string NoLuceneValue = "no.lucene"; + private const string FaLuceneValue = "fa.lucene"; + private const string PlMicrosoftValue = "pl.microsoft"; + private const string PlLuceneValue = "pl.lucene"; + private const string PtBrMicrosoftValue = "pt-BR.microsoft"; + private const string PtBrLuceneValue = "pt-BR.lucene"; + private const string PtPtMicrosoftValue = "pt-PT.microsoft"; + private const string PtPtLuceneValue = "pt-PT.lucene"; + private const string PaMicrosoftValue = "pa.microsoft"; + private const string RoMicrosoftValue = "ro.microsoft"; + private const string RoLuceneValue = "ro.lucene"; + private const string RuMicrosoftValue = "ru.microsoft"; + private const string RuLuceneValue = "ru.lucene"; + private const string SrCyrillicMicrosoftValue = "sr-cyrillic.microsoft"; + private const string SrLatinMicrosoftValue = "sr-latin.microsoft"; + private const string SkMicrosoftValue = "sk.microsoft"; + private const string SlMicrosoftValue = "sl.microsoft"; + private const string EsMicrosoftValue = "es.microsoft"; + private const string EsLuceneValue = "es.lucene"; + private const string SvMicrosoftValue = "sv.microsoft"; + private const string SvLuceneValue = "sv.lucene"; + private const string TaMicrosoftValue = "ta.microsoft"; + private const string TeMicrosoftValue = "te.microsoft"; + private const string ThMicrosoftValue = "th.microsoft"; + private const string ThLuceneValue = "th.lucene"; + private const string TrMicrosoftValue = "tr.microsoft"; + private const string TrLuceneValue = "tr.lucene"; + private const string UkMicrosoftValue = "uk.microsoft"; + private const string UrMicrosoftValue = "ur.microsoft"; + private const string ViMicrosoftValue = "vi.microsoft"; + private const string StandardLuceneValue = "standard.lucene"; + private const string StandardAsciiFoldingLuceneValue = "standardasciifolding.lucene"; + private const string KeywordValue = "keyword"; + private const string PatternValue = "pattern"; + private const string SimpleValue = "simple"; + private const string StopValue = "stop"; + private const string WhitespaceValue = "whitespace"; + + /// Microsoft analyzer for Arabic. + public static LexicalAnalyzerName ArMicrosoft { get; } = new LexicalAnalyzerName(ArMicrosoftValue); + /// Lucene analyzer for Arabic. + public static LexicalAnalyzerName ArLucene { get; } = new LexicalAnalyzerName(ArLuceneValue); + /// Lucene analyzer for Armenian. + public static LexicalAnalyzerName HyLucene { get; } = new LexicalAnalyzerName(HyLuceneValue); + /// Microsoft analyzer for Bangla. + public static LexicalAnalyzerName BnMicrosoft { get; } = new LexicalAnalyzerName(BnMicrosoftValue); + /// Lucene analyzer for Basque. + public static LexicalAnalyzerName EuLucene { get; } = new LexicalAnalyzerName(EuLuceneValue); + /// Microsoft analyzer for Bulgarian. + public static LexicalAnalyzerName BgMicrosoft { get; } = new LexicalAnalyzerName(BgMicrosoftValue); + /// Lucene analyzer for Bulgarian. + public static LexicalAnalyzerName BgLucene { get; } = new LexicalAnalyzerName(BgLuceneValue); + /// Microsoft analyzer for Catalan. + public static LexicalAnalyzerName CaMicrosoft { get; } = new LexicalAnalyzerName(CaMicrosoftValue); + /// Lucene analyzer for Catalan. + public static LexicalAnalyzerName CaLucene { get; } = new LexicalAnalyzerName(CaLuceneValue); + /// Microsoft analyzer for Chinese (Simplified). + public static LexicalAnalyzerName ZhHansMicrosoft { get; } = new LexicalAnalyzerName(ZhHansMicrosoftValue); + /// Lucene analyzer for Chinese (Simplified). + public static LexicalAnalyzerName ZhHansLucene { get; } = new LexicalAnalyzerName(ZhHansLuceneValue); + /// Microsoft analyzer for Chinese (Traditional). + public static LexicalAnalyzerName ZhHantMicrosoft { get; } = new LexicalAnalyzerName(ZhHantMicrosoftValue); + /// Lucene analyzer for Chinese (Traditional). + public static LexicalAnalyzerName ZhHantLucene { get; } = new LexicalAnalyzerName(ZhHantLuceneValue); + /// Microsoft analyzer for Croatian. + public static LexicalAnalyzerName HrMicrosoft { get; } = new LexicalAnalyzerName(HrMicrosoftValue); + /// Microsoft analyzer for Czech. + public static LexicalAnalyzerName CsMicrosoft { get; } = new LexicalAnalyzerName(CsMicrosoftValue); + /// Lucene analyzer for Czech. + public static LexicalAnalyzerName CsLucene { get; } = new LexicalAnalyzerName(CsLuceneValue); + /// Microsoft analyzer for Danish. + public static LexicalAnalyzerName DaMicrosoft { get; } = new LexicalAnalyzerName(DaMicrosoftValue); + /// Lucene analyzer for Danish. + public static LexicalAnalyzerName DaLucene { get; } = new LexicalAnalyzerName(DaLuceneValue); + /// Microsoft analyzer for Dutch. + public static LexicalAnalyzerName NlMicrosoft { get; } = new LexicalAnalyzerName(NlMicrosoftValue); + /// Lucene analyzer for Dutch. + public static LexicalAnalyzerName NlLucene { get; } = new LexicalAnalyzerName(NlLuceneValue); + /// Microsoft analyzer for English. + public static LexicalAnalyzerName EnMicrosoft { get; } = new LexicalAnalyzerName(EnMicrosoftValue); + /// Lucene analyzer for English. + public static LexicalAnalyzerName EnLucene { get; } = new LexicalAnalyzerName(EnLuceneValue); + /// Microsoft analyzer for Estonian. + public static LexicalAnalyzerName EtMicrosoft { get; } = new LexicalAnalyzerName(EtMicrosoftValue); + /// Microsoft analyzer for Finnish. + public static LexicalAnalyzerName FiMicrosoft { get; } = new LexicalAnalyzerName(FiMicrosoftValue); + /// Lucene analyzer for Finnish. + public static LexicalAnalyzerName FiLucene { get; } = new LexicalAnalyzerName(FiLuceneValue); + /// Microsoft analyzer for French. + public static LexicalAnalyzerName FrMicrosoft { get; } = new LexicalAnalyzerName(FrMicrosoftValue); + /// Lucene analyzer for French. + public static LexicalAnalyzerName FrLucene { get; } = new LexicalAnalyzerName(FrLuceneValue); + /// Lucene analyzer for Galician. + public static LexicalAnalyzerName GlLucene { get; } = new LexicalAnalyzerName(GlLuceneValue); + /// Microsoft analyzer for German. + public static LexicalAnalyzerName DeMicrosoft { get; } = new LexicalAnalyzerName(DeMicrosoftValue); + /// Lucene analyzer for German. + public static LexicalAnalyzerName DeLucene { get; } = new LexicalAnalyzerName(DeLuceneValue); + /// Microsoft analyzer for Greek. + public static LexicalAnalyzerName ElMicrosoft { get; } = new LexicalAnalyzerName(ElMicrosoftValue); + /// Lucene analyzer for Greek. + public static LexicalAnalyzerName ElLucene { get; } = new LexicalAnalyzerName(ElLuceneValue); + /// Microsoft analyzer for Gujarati. + public static LexicalAnalyzerName GuMicrosoft { get; } = new LexicalAnalyzerName(GuMicrosoftValue); + /// Microsoft analyzer for Hebrew. + public static LexicalAnalyzerName HeMicrosoft { get; } = new LexicalAnalyzerName(HeMicrosoftValue); + /// Microsoft analyzer for Hindi. + public static LexicalAnalyzerName HiMicrosoft { get; } = new LexicalAnalyzerName(HiMicrosoftValue); + /// Lucene analyzer for Hindi. + public static LexicalAnalyzerName HiLucene { get; } = new LexicalAnalyzerName(HiLuceneValue); + /// Microsoft analyzer for Hungarian. + public static LexicalAnalyzerName HuMicrosoft { get; } = new LexicalAnalyzerName(HuMicrosoftValue); + /// Lucene analyzer for Hungarian. + public static LexicalAnalyzerName HuLucene { get; } = new LexicalAnalyzerName(HuLuceneValue); + /// Microsoft analyzer for Icelandic. + public static LexicalAnalyzerName IsMicrosoft { get; } = new LexicalAnalyzerName(IsMicrosoftValue); + /// Microsoft analyzer for Indonesian (Bahasa). + public static LexicalAnalyzerName IdMicrosoft { get; } = new LexicalAnalyzerName(IdMicrosoftValue); + /// Lucene analyzer for Indonesian. + public static LexicalAnalyzerName IdLucene { get; } = new LexicalAnalyzerName(IdLuceneValue); + /// Lucene analyzer for Irish. + public static LexicalAnalyzerName GaLucene { get; } = new LexicalAnalyzerName(GaLuceneValue); + /// Microsoft analyzer for Italian. + public static LexicalAnalyzerName ItMicrosoft { get; } = new LexicalAnalyzerName(ItMicrosoftValue); + /// Lucene analyzer for Italian. + public static LexicalAnalyzerName ItLucene { get; } = new LexicalAnalyzerName(ItLuceneValue); + /// Microsoft analyzer for Japanese. + public static LexicalAnalyzerName JaMicrosoft { get; } = new LexicalAnalyzerName(JaMicrosoftValue); + /// Lucene analyzer for Japanese. + public static LexicalAnalyzerName JaLucene { get; } = new LexicalAnalyzerName(JaLuceneValue); + /// Microsoft analyzer for Kannada. + public static LexicalAnalyzerName KnMicrosoft { get; } = new LexicalAnalyzerName(KnMicrosoftValue); + /// Microsoft analyzer for Korean. + public static LexicalAnalyzerName KoMicrosoft { get; } = new LexicalAnalyzerName(KoMicrosoftValue); + /// Lucene analyzer for Korean. + public static LexicalAnalyzerName KoLucene { get; } = new LexicalAnalyzerName(KoLuceneValue); + /// Microsoft analyzer for Latvian. + public static LexicalAnalyzerName LvMicrosoft { get; } = new LexicalAnalyzerName(LvMicrosoftValue); + /// Lucene analyzer for Latvian. + public static LexicalAnalyzerName LvLucene { get; } = new LexicalAnalyzerName(LvLuceneValue); + /// Microsoft analyzer for Lithuanian. + public static LexicalAnalyzerName LtMicrosoft { get; } = new LexicalAnalyzerName(LtMicrosoftValue); + /// Microsoft analyzer for Malayalam. + public static LexicalAnalyzerName MlMicrosoft { get; } = new LexicalAnalyzerName(MlMicrosoftValue); + /// Microsoft analyzer for Malay (Latin). + public static LexicalAnalyzerName MsMicrosoft { get; } = new LexicalAnalyzerName(MsMicrosoftValue); + /// Microsoft analyzer for Marathi. + public static LexicalAnalyzerName MrMicrosoft { get; } = new LexicalAnalyzerName(MrMicrosoftValue); + /// Microsoft analyzer for Norwegian (Bokmål). + public static LexicalAnalyzerName NbMicrosoft { get; } = new LexicalAnalyzerName(NbMicrosoftValue); + /// Lucene analyzer for Norwegian. + public static LexicalAnalyzerName NoLucene { get; } = new LexicalAnalyzerName(NoLuceneValue); + /// Lucene analyzer for Persian. + public static LexicalAnalyzerName FaLucene { get; } = new LexicalAnalyzerName(FaLuceneValue); + /// Microsoft analyzer for Polish. + public static LexicalAnalyzerName PlMicrosoft { get; } = new LexicalAnalyzerName(PlMicrosoftValue); + /// Lucene analyzer for Polish. + public static LexicalAnalyzerName PlLucene { get; } = new LexicalAnalyzerName(PlLuceneValue); + /// Microsoft analyzer for Portuguese (Brazil). + public static LexicalAnalyzerName PtBrMicrosoft { get; } = new LexicalAnalyzerName(PtBrMicrosoftValue); + /// Lucene analyzer for Portuguese (Brazil). + public static LexicalAnalyzerName PtBrLucene { get; } = new LexicalAnalyzerName(PtBrLuceneValue); + /// Microsoft analyzer for Portuguese (Portugal). + public static LexicalAnalyzerName PtPtMicrosoft { get; } = new LexicalAnalyzerName(PtPtMicrosoftValue); + /// Lucene analyzer for Portuguese (Portugal). + public static LexicalAnalyzerName PtPtLucene { get; } = new LexicalAnalyzerName(PtPtLuceneValue); + /// Microsoft analyzer for Punjabi. + public static LexicalAnalyzerName PaMicrosoft { get; } = new LexicalAnalyzerName(PaMicrosoftValue); + /// Microsoft analyzer for Romanian. + public static LexicalAnalyzerName RoMicrosoft { get; } = new LexicalAnalyzerName(RoMicrosoftValue); + /// Lucene analyzer for Romanian. + public static LexicalAnalyzerName RoLucene { get; } = new LexicalAnalyzerName(RoLuceneValue); + /// Microsoft analyzer for Russian. + public static LexicalAnalyzerName RuMicrosoft { get; } = new LexicalAnalyzerName(RuMicrosoftValue); + /// Lucene analyzer for Russian. + public static LexicalAnalyzerName RuLucene { get; } = new LexicalAnalyzerName(RuLuceneValue); + /// Microsoft analyzer for Serbian (Cyrillic). + public static LexicalAnalyzerName SrCyrillicMicrosoft { get; } = new LexicalAnalyzerName(SrCyrillicMicrosoftValue); + /// Microsoft analyzer for Serbian (Latin). + public static LexicalAnalyzerName SrLatinMicrosoft { get; } = new LexicalAnalyzerName(SrLatinMicrosoftValue); + /// Microsoft analyzer for Slovak. + public static LexicalAnalyzerName SkMicrosoft { get; } = new LexicalAnalyzerName(SkMicrosoftValue); + /// Microsoft analyzer for Slovenian. + public static LexicalAnalyzerName SlMicrosoft { get; } = new LexicalAnalyzerName(SlMicrosoftValue); + /// Microsoft analyzer for Spanish. + public static LexicalAnalyzerName EsMicrosoft { get; } = new LexicalAnalyzerName(EsMicrosoftValue); + /// Lucene analyzer for Spanish. + public static LexicalAnalyzerName EsLucene { get; } = new LexicalAnalyzerName(EsLuceneValue); + /// Microsoft analyzer for Swedish. + public static LexicalAnalyzerName SvMicrosoft { get; } = new LexicalAnalyzerName(SvMicrosoftValue); + /// Lucene analyzer for Swedish. + public static LexicalAnalyzerName SvLucene { get; } = new LexicalAnalyzerName(SvLuceneValue); + /// Microsoft analyzer for Tamil. + public static LexicalAnalyzerName TaMicrosoft { get; } = new LexicalAnalyzerName(TaMicrosoftValue); + /// Microsoft analyzer for Telugu. + public static LexicalAnalyzerName TeMicrosoft { get; } = new LexicalAnalyzerName(TeMicrosoftValue); + /// Microsoft analyzer for Thai. + public static LexicalAnalyzerName ThMicrosoft { get; } = new LexicalAnalyzerName(ThMicrosoftValue); + /// Lucene analyzer for Thai. + public static LexicalAnalyzerName ThLucene { get; } = new LexicalAnalyzerName(ThLuceneValue); + /// Microsoft analyzer for Turkish. + public static LexicalAnalyzerName TrMicrosoft { get; } = new LexicalAnalyzerName(TrMicrosoftValue); + /// Lucene analyzer for Turkish. + public static LexicalAnalyzerName TrLucene { get; } = new LexicalAnalyzerName(TrLuceneValue); + /// Microsoft analyzer for Ukrainian. + public static LexicalAnalyzerName UkMicrosoft { get; } = new LexicalAnalyzerName(UkMicrosoftValue); + /// Microsoft analyzer for Urdu. + public static LexicalAnalyzerName UrMicrosoft { get; } = new LexicalAnalyzerName(UrMicrosoftValue); + /// Microsoft analyzer for Vietnamese. + public static LexicalAnalyzerName ViMicrosoft { get; } = new LexicalAnalyzerName(ViMicrosoftValue); + /// Standard Lucene analyzer. + public static LexicalAnalyzerName StandardLucene { get; } = new LexicalAnalyzerName(StandardLuceneValue); + /// + /// Standard ASCII Folding Lucene analyzer. See + /// https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers + /// + public static LexicalAnalyzerName StandardAsciiFoldingLucene { get; } = new LexicalAnalyzerName(StandardAsciiFoldingLuceneValue); + /// + /// Treats the entire content of a field as a single token. This is useful for data + /// like zip codes, ids, and some product names. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html + /// + public static LexicalAnalyzerName Keyword { get; } = new LexicalAnalyzerName(KeywordValue); + /// + /// Flexibly separates text into terms via a regular expression pattern. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html + /// + public static LexicalAnalyzerName Pattern { get; } = new LexicalAnalyzerName(PatternValue); + /// + /// Divides text at non-letters and converts them to lower case. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html + /// + public static LexicalAnalyzerName Simple { get; } = new LexicalAnalyzerName(SimpleValue); + /// + /// Divides text at non-letters; Applies the lowercase and stopword token filters. + /// See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html + /// + public static LexicalAnalyzerName Stop { get; } = new LexicalAnalyzerName(StopValue); + /// + /// An analyzer that uses the whitespace tokenizer. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html + /// + public static LexicalAnalyzerName Whitespace { get; } = new LexicalAnalyzerName(WhitespaceValue); + /// Determines if two values are the same. + public static bool operator ==(LexicalAnalyzerName left, LexicalAnalyzerName right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(LexicalAnalyzerName left, LexicalAnalyzerName right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator LexicalAnalyzerName(string value) => new LexicalAnalyzerName(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is LexicalAnalyzerName other && Equals(other); + /// + public bool Equals(LexicalAnalyzerName other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalNormalizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalNormalizer.Serialization.cs new file mode 100644 index 000000000000..90bd88bf743e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalNormalizer.Serialization.cs @@ -0,0 +1,135 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + [PersistableModelProxy(typeof(UnknownLexicalNormalizer))] + public partial class LexicalNormalizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LexicalNormalizer)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("@odata.type"u8); + writer.WriteStringValue(OdataType); + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + LexicalNormalizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LexicalNormalizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeLexicalNormalizer(document.RootElement, options); + } + + internal static LexicalNormalizer DeserializeLexicalNormalizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("@odata.type", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "#Microsoft.Azure.Search.CustomNormalizer": return CustomNormalizer.DeserializeCustomNormalizer(element, options); + } + } + return UnknownLexicalNormalizer.DeserializeUnknownLexicalNormalizer(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(LexicalNormalizer)} does not support writing '{options.Format}' format."); + } + } + + LexicalNormalizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLexicalNormalizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(LexicalNormalizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static LexicalNormalizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLexicalNormalizer(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalNormalizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalNormalizer.cs new file mode 100644 index 000000000000..83e8fc3d3f4f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalNormalizer.cs @@ -0,0 +1,95 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Base type for normalizers. + /// 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 . + /// + public abstract partial class LexicalNormalizer + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + protected LexicalNormalizer(string name) + { + Argument.AssertNotNull(name, nameof(name)); + + Name = name; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal LexicalNormalizer(string odataType, string name, IDictionary serializedAdditionalRawData) + { + OdataType = odataType; + Name = name; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal LexicalNormalizer() + { + } + + /// The discriminator for derived types. + 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.Indexes/src/Generated/LexicalNormalizerName.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalNormalizerName.cs new file mode 100644 index 000000000000..3022881090bf --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalNormalizerName.cs @@ -0,0 +1,78 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Defines the names of all text normalizers supported by the search engine. + public readonly partial struct LexicalNormalizerName : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public LexicalNormalizerName(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string AsciiFoldingValue = "asciifolding"; + private const string ElisionValue = "elision"; + private const string LowercaseValue = "lowercase"; + private const string StandardValue = "standard"; + private const string UppercaseValue = "uppercase"; + + /// + /// Converts alphabetic, numeric, and symbolic Unicode characters which are not in + /// the first 127 ASCII characters (the "Basic Latin" Unicode block) into their + /// ASCII equivalents, if such equivalents exist. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html + /// + public static LexicalNormalizerName AsciiFolding { get; } = new LexicalNormalizerName(AsciiFoldingValue); + /// + /// Removes elisions. For example, "l'avion" (the plane) will be converted to + /// "avion" (plane). See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html + /// + public static LexicalNormalizerName Elision { get; } = new LexicalNormalizerName(ElisionValue); + /// + /// Normalizes token text to lowercase. See + /// https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html + /// + public static LexicalNormalizerName Lowercase { get; } = new LexicalNormalizerName(LowercaseValue); + /// + /// Standard normalizer, which consists of lowercase and asciifolding. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html + /// + public static LexicalNormalizerName Standard { get; } = new LexicalNormalizerName(StandardValue); + /// + /// Normalizes token text to uppercase. See + /// https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html + /// + public static LexicalNormalizerName Uppercase { get; } = new LexicalNormalizerName(UppercaseValue); + /// Determines if two values are the same. + public static bool operator ==(LexicalNormalizerName left, LexicalNormalizerName right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(LexicalNormalizerName left, LexicalNormalizerName right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator LexicalNormalizerName(string value) => new LexicalNormalizerName(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is LexicalNormalizerName other && Equals(other); + /// + public bool Equals(LexicalNormalizerName other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalTokenizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalTokenizer.Serialization.cs new file mode 100644 index 000000000000..0b447ee2fea1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalTokenizer.Serialization.cs @@ -0,0 +1,144 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + [PersistableModelProxy(typeof(UnknownLexicalTokenizer))] + public partial class LexicalTokenizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LexicalTokenizer)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("@odata.type"u8); + writer.WriteStringValue(OdataType); + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + LexicalTokenizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LexicalTokenizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeLexicalTokenizer(document.RootElement, options); + } + + internal static LexicalTokenizer DeserializeLexicalTokenizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("@odata.type", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "#Microsoft.Azure.Search.ClassicTokenizer": return ClassicTokenizer.DeserializeClassicTokenizer(element, options); + case "#Microsoft.Azure.Search.EdgeNGramTokenizer": return EdgeNGramTokenizer.DeserializeEdgeNGramTokenizer(element, options); + case "#Microsoft.Azure.Search.KeywordTokenizerV2": return KeywordTokenizerV2.DeserializeKeywordTokenizerV2(element, options); + case "#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer": return MicrosoftLanguageStemmingTokenizer.DeserializeMicrosoftLanguageStemmingTokenizer(element, options); + case "#Microsoft.Azure.Search.MicrosoftLanguageTokenizer": return MicrosoftLanguageTokenizer.DeserializeMicrosoftLanguageTokenizer(element, options); + case "#Microsoft.Azure.Search.NGramTokenizer": return NGramTokenizer.DeserializeNGramTokenizer(element, options); + case "#Microsoft.Azure.Search.PathHierarchyTokenizerV2": return PathHierarchyTokenizerV2.DeserializePathHierarchyTokenizerV2(element, options); + case "#Microsoft.Azure.Search.PatternTokenizer": return PatternTokenizer.DeserializePatternTokenizer(element, options); + case "#Microsoft.Azure.Search.StandardTokenizerV2": return LuceneStandardTokenizerV2.DeserializeLuceneStandardTokenizerV2(element, options); + case "#Microsoft.Azure.Search.UaxUrlEmailTokenizer": return UaxUrlEmailTokenizer.DeserializeUaxUrlEmailTokenizer(element, options); + } + } + return UnknownLexicalTokenizer.DeserializeUnknownLexicalTokenizer(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(LexicalTokenizer)} does not support writing '{options.Format}' format."); + } + } + + LexicalTokenizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLexicalTokenizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(LexicalTokenizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static LexicalTokenizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLexicalTokenizer(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalTokenizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalTokenizer.cs new file mode 100644 index 000000000000..9247edcc6e29 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalTokenizer.cs @@ -0,0 +1,95 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Base type for tokenizers. + /// 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 abstract partial class LexicalTokenizer + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + protected LexicalTokenizer(string name) + { + Argument.AssertNotNull(name, nameof(name)); + + Name = name; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal LexicalTokenizer(string odataType, string name, IDictionary serializedAdditionalRawData) + { + OdataType = odataType; + Name = name; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal LexicalTokenizer() + { + } + + /// The discriminator for derived types. + 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.Indexes/src/Generated/LexicalTokenizerName.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalTokenizerName.cs new file mode 100644 index 000000000000..ae71580add96 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LexicalTokenizerName.cs @@ -0,0 +1,122 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Defines the names of all tokenizers supported by the search engine. + public readonly partial struct LexicalTokenizerName : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public LexicalTokenizerName(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string ClassicValue = "classic"; + private const string EdgeNGramValue = "edgeNGram"; + private const string KeywordValue = "keyword_v2"; + private const string LetterValue = "letter"; + private const string LowercaseValue = "lowercase"; + private const string MicrosoftLanguageTokenizerValue = "microsoft_language_tokenizer"; + private const string MicrosoftLanguageStemmingTokenizerValue = "microsoft_language_stemming_tokenizer"; + private const string NGramValue = "nGram"; + private const string PathHierarchyValue = "path_hierarchy_v2"; + private const string PatternValue = "pattern"; + private const string StandardValue = "standard_v2"; + private const string UaxUrlEmailValue = "uax_url_email"; + private const string WhitespaceValue = "whitespace"; + + /// + /// Grammar-based tokenizer that is suitable for processing most European-language + /// documents. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html + /// + public static LexicalTokenizerName Classic { get; } = new LexicalTokenizerName(ClassicValue); + /// + /// Tokenizes the input from an edge into n-grams of the given size(s). See + /// https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html + /// + public static LexicalTokenizerName EdgeNGram { get; } = new LexicalTokenizerName(EdgeNGramValue); + /// + /// Emits the entire input as a single token. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html + /// + public static LexicalTokenizerName Keyword { get; } = new LexicalTokenizerName(KeywordValue); + /// + /// Divides text at non-letters. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LetterTokenizer.html + /// + public static LexicalTokenizerName Letter { get; } = new LexicalTokenizerName(LetterValue); + /// + /// Divides text at non-letters and converts them to lower case. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseTokenizer.html + /// + public static LexicalTokenizerName Lowercase { get; } = new LexicalTokenizerName(LowercaseValue); + /// Divides text using language-specific rules. + public static LexicalTokenizerName MicrosoftLanguageTokenizer { get; } = new LexicalTokenizerName(MicrosoftLanguageTokenizerValue); + /// + /// Divides text using language-specific rules and reduces words to their base + /// forms. + /// + public static LexicalTokenizerName MicrosoftLanguageStemmingTokenizer { get; } = new LexicalTokenizerName(MicrosoftLanguageStemmingTokenizerValue); + /// + /// Tokenizes the input into n-grams of the given size(s). See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html + /// + public static LexicalTokenizerName NGram { get; } = new LexicalTokenizerName(NGramValue); + /// + /// Tokenizer for path-like hierarchies. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html + /// + public static LexicalTokenizerName PathHierarchy { get; } = new LexicalTokenizerName(PathHierarchyValue); + /// + /// Tokenizer that uses regex pattern matching to construct distinct tokens. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html + /// + public static LexicalTokenizerName Pattern { get; } = new LexicalTokenizerName(PatternValue); + /// + /// Standard Lucene analyzer; Composed of the standard tokenizer, lowercase filter + /// and stop filter. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html + /// + public static LexicalTokenizerName Standard { get; } = new LexicalTokenizerName(StandardValue); + /// + /// Tokenizes urls and emails as one token. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html + /// + public static LexicalTokenizerName UaxUrlEmail { get; } = new LexicalTokenizerName(UaxUrlEmailValue); + /// + /// Divides text at whitespace. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceTokenizer.html + /// + public static LexicalTokenizerName Whitespace { get; } = new LexicalTokenizerName(WhitespaceValue); + /// Determines if two values are the same. + public static bool operator ==(LexicalTokenizerName left, LexicalTokenizerName right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(LexicalTokenizerName left, LexicalTokenizerName right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator LexicalTokenizerName(string value) => new LexicalTokenizerName(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is LexicalTokenizerName other && Equals(other); + /// + public bool Equals(LexicalTokenizerName other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LimitTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LimitTokenFilter.Serialization.cs new file mode 100644 index 000000000000..4c8d13dce1f7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LimitTokenFilter.Serialization.cs @@ -0,0 +1,162 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class LimitTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LimitTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(MaxTokenCount)) + { + writer.WritePropertyName("maxTokenCount"u8); + writer.WriteNumberValue(MaxTokenCount.Value); + } + if (Optional.IsDefined(ConsumeAllTokens)) + { + writer.WritePropertyName("consumeAllTokens"u8); + writer.WriteBooleanValue(ConsumeAllTokens.Value); + } + } + + LimitTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LimitTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeLimitTokenFilter(document.RootElement, options); + } + + internal static LimitTokenFilter DeserializeLimitTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? maxTokenCount = default; + bool? consumeAllTokens = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("maxTokenCount"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxTokenCount = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("consumeAllTokens"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + consumeAllTokens = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new LimitTokenFilter(odataType, name, serializedAdditionalRawData, maxTokenCount, consumeAllTokens); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(LimitTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + LimitTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLimitTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(LimitTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new LimitTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLimitTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LimitTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LimitTokenFilter.cs new file mode 100644 index 000000000000..ec8fb3e5bb05 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LimitTokenFilter.cs @@ -0,0 +1,65 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Limits the number of tokens while indexing. This token filter is implemented + /// using Apache Lucene. + /// + public partial class LimitTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public LimitTokenFilter(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.LimitTokenFilter"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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. + /// + internal LimitTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, int? maxTokenCount, bool? consumeAllTokens) : base(odataType, name, serializedAdditionalRawData) + { + MaxTokenCount = maxTokenCount; + ConsumeAllTokens = consumeAllTokens; + } + + /// Initializes a new instance of for deserialization. + internal LimitTokenFilter() + { + } + + /// The maximum number of tokens to produce. Default is 1. + public int? MaxTokenCount { get; set; } + /// + /// A value indicating whether all tokens from the input must be consumed even if + /// maxTokenCount is reached. Default is false. + /// + public bool? ConsumeAllTokens { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListDataSourcesResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListDataSourcesResult.Serialization.cs new file mode 100644 index 000000000000..a6bc06e0c990 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListDataSourcesResult.Serialization.cs @@ -0,0 +1,152 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ListDataSourcesResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ListDataSourcesResult)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("value"u8); + writer.WriteStartArray(); + foreach (var item in Value) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + ListDataSourcesResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ListDataSourcesResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeListDataSourcesResult(document.RootElement, options); + } + + internal static ListDataSourcesResult DeserializeListDataSourcesResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IReadOnlyList value = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("value"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SearchIndexerDataSource.DeserializeSearchIndexerDataSource(item, options)); + } + value = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ListDataSourcesResult(value, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ListDataSourcesResult)} does not support writing '{options.Format}' format."); + } + } + + ListDataSourcesResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeListDataSourcesResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ListDataSourcesResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static ListDataSourcesResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeListDataSourcesResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListDataSourcesResult.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListDataSourcesResult.cs new file mode 100644 index 000000000000..c0e35d73cf4a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListDataSourcesResult.cs @@ -0,0 +1,79 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Response from a List Datasources request. If successful, it includes the full + /// definitions of all datasources. + /// + public partial class ListDataSourcesResult + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The datasources in the Search service. + /// is null. + internal ListDataSourcesResult(IEnumerable value) + { + Argument.AssertNotNull(value, nameof(value)); + + Value = value.ToList(); + } + + /// Initializes a new instance of . + /// The datasources in the Search service. + /// Keeps track of any properties unknown to the library. + internal ListDataSourcesResult(IReadOnlyList value, IDictionary serializedAdditionalRawData) + { + Value = value; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal ListDataSourcesResult() + { + } + + /// The datasources in the Search service. + public IReadOnlyList Value { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListIndexersResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListIndexersResult.Serialization.cs new file mode 100644 index 000000000000..8bb4b72d7502 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListIndexersResult.Serialization.cs @@ -0,0 +1,152 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ListIndexersResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ListIndexersResult)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("value"u8); + writer.WriteStartArray(); + foreach (var item in Value) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + ListIndexersResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ListIndexersResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeListIndexersResult(document.RootElement, options); + } + + internal static ListIndexersResult DeserializeListIndexersResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IReadOnlyList value = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("value"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SearchIndexer.DeserializeSearchIndexer(item, options)); + } + value = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ListIndexersResult(value, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ListIndexersResult)} does not support writing '{options.Format}' format."); + } + } + + ListIndexersResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeListIndexersResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ListIndexersResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static ListIndexersResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeListIndexersResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListIndexersResult.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListIndexersResult.cs new file mode 100644 index 000000000000..61f81bf251fa --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListIndexersResult.cs @@ -0,0 +1,79 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Response from a List Indexers request. If successful, it includes the full + /// definitions of all indexers. + /// + public partial class ListIndexersResult + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The indexers in the Search service. + /// is null. + internal ListIndexersResult(IEnumerable value) + { + Argument.AssertNotNull(value, nameof(value)); + + Value = value.ToList(); + } + + /// Initializes a new instance of . + /// The indexers in the Search service. + /// Keeps track of any properties unknown to the library. + internal ListIndexersResult(IReadOnlyList value, IDictionary serializedAdditionalRawData) + { + Value = value; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal ListIndexersResult() + { + } + + /// The indexers in the Search service. + public IReadOnlyList Value { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListSkillsetsResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListSkillsetsResult.Serialization.cs new file mode 100644 index 000000000000..8b296e2f940b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListSkillsetsResult.Serialization.cs @@ -0,0 +1,152 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ListSkillsetsResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ListSkillsetsResult)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("value"u8); + writer.WriteStartArray(); + foreach (var item in Value) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + ListSkillsetsResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ListSkillsetsResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeListSkillsetsResult(document.RootElement, options); + } + + internal static ListSkillsetsResult DeserializeListSkillsetsResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IReadOnlyList value = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("value"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SearchIndexerSkillset.DeserializeSearchIndexerSkillset(item, options)); + } + value = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ListSkillsetsResult(value, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ListSkillsetsResult)} does not support writing '{options.Format}' format."); + } + } + + ListSkillsetsResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeListSkillsetsResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ListSkillsetsResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static ListSkillsetsResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeListSkillsetsResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListSkillsetsResult.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListSkillsetsResult.cs new file mode 100644 index 000000000000..251eaaaa4c53 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListSkillsetsResult.cs @@ -0,0 +1,79 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Response from a list skillset request. If successful, it includes the full + /// definitions of all skillsets. + /// + public partial class ListSkillsetsResult + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The skillsets defined in the Search service. + /// is null. + internal ListSkillsetsResult(IEnumerable value) + { + Argument.AssertNotNull(value, nameof(value)); + + Value = value.ToList(); + } + + /// Initializes a new instance of . + /// The skillsets defined in the Search service. + /// Keeps track of any properties unknown to the library. + internal ListSkillsetsResult(IReadOnlyList value, IDictionary serializedAdditionalRawData) + { + Value = value; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal ListSkillsetsResult() + { + } + + /// The skillsets defined in the Search service. + public IReadOnlyList Value { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListSynonymMapsResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListSynonymMapsResult.Serialization.cs new file mode 100644 index 000000000000..e19f7f30e962 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListSynonymMapsResult.Serialization.cs @@ -0,0 +1,152 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ListSynonymMapsResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ListSynonymMapsResult)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("value"u8); + writer.WriteStartArray(); + foreach (var item in Value) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + ListSynonymMapsResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ListSynonymMapsResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeListSynonymMapsResult(document.RootElement, options); + } + + internal static ListSynonymMapsResult DeserializeListSynonymMapsResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IReadOnlyList value = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("value"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SynonymMap.DeserializeSynonymMap(item, options)); + } + value = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ListSynonymMapsResult(value, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ListSynonymMapsResult)} does not support writing '{options.Format}' format."); + } + } + + ListSynonymMapsResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeListSynonymMapsResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ListSynonymMapsResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static ListSynonymMapsResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeListSynonymMapsResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListSynonymMapsResult.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListSynonymMapsResult.cs new file mode 100644 index 000000000000..7357b35caf6e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ListSynonymMapsResult.cs @@ -0,0 +1,79 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Response from a List SynonymMaps request. If successful, it includes the full + /// definitions of all synonym maps. + /// + public partial class ListSynonymMapsResult + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The synonym maps in the Search service. + /// is null. + internal ListSynonymMapsResult(IEnumerable value) + { + Argument.AssertNotNull(value, nameof(value)); + + Value = value.ToList(); + } + + /// Initializes a new instance of . + /// The synonym maps in the Search service. + /// Keeps track of any properties unknown to the library. + internal ListSynonymMapsResult(IReadOnlyList value, IDictionary serializedAdditionalRawData) + { + Value = value; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal ListSynonymMapsResult() + { + } + + /// The synonym maps in the Search service. + public IReadOnlyList Value { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LuceneStandardAnalyzer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LuceneStandardAnalyzer.Serialization.cs new file mode 100644 index 000000000000..aa4d707c0007 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LuceneStandardAnalyzer.Serialization.cs @@ -0,0 +1,172 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class LuceneStandardAnalyzer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LuceneStandardAnalyzer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(MaxTokenLength)) + { + writer.WritePropertyName("maxTokenLength"u8); + writer.WriteNumberValue(MaxTokenLength.Value); + } + if (Optional.IsCollectionDefined(Stopwords)) + { + writer.WritePropertyName("stopwords"u8); + writer.WriteStartArray(); + foreach (var item in Stopwords) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + } + + LuceneStandardAnalyzer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LuceneStandardAnalyzer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeLuceneStandardAnalyzer(document.RootElement, options); + } + + internal static LuceneStandardAnalyzer DeserializeLuceneStandardAnalyzer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? maxTokenLength = default; + IList stopwords = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("maxTokenLength"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxTokenLength = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("stopwords"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + stopwords = array; + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new LuceneStandardAnalyzer(odataType, name, serializedAdditionalRawData, maxTokenLength, stopwords ?? new ChangeTrackingList()); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(LuceneStandardAnalyzer)} does not support writing '{options.Format}' format."); + } + } + + LuceneStandardAnalyzer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLuceneStandardAnalyzer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(LuceneStandardAnalyzer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new LuceneStandardAnalyzer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLuceneStandardAnalyzer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LuceneStandardAnalyzer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LuceneStandardAnalyzer.cs new file mode 100644 index 000000000000..ec234e327145 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LuceneStandardAnalyzer.cs @@ -0,0 +1,66 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase + /// filter and stop filter. + /// + public partial class LuceneStandardAnalyzer : LexicalAnalyzer + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public LuceneStandardAnalyzer(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.StandardAnalyzer"; + Stopwords = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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. + internal LuceneStandardAnalyzer(string odataType, string name, IDictionary serializedAdditionalRawData, int? maxTokenLength, IList stopwords) : base(odataType, name, serializedAdditionalRawData) + { + MaxTokenLength = maxTokenLength; + Stopwords = stopwords; + } + + /// Initializes a new instance of for deserialization. + internal LuceneStandardAnalyzer() + { + } + + /// + /// 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. + /// + public int? MaxTokenLength { get; set; } + /// A list of stopwords. + public IList Stopwords { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LuceneStandardTokenizerV2.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LuceneStandardTokenizerV2.Serialization.cs new file mode 100644 index 000000000000..9227ded4f040 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LuceneStandardTokenizerV2.Serialization.cs @@ -0,0 +1,147 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class LuceneStandardTokenizerV2 : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LuceneStandardTokenizerV2)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(MaxTokenLength)) + { + writer.WritePropertyName("maxTokenLength"u8); + writer.WriteNumberValue(MaxTokenLength.Value); + } + } + + LuceneStandardTokenizerV2 IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LuceneStandardTokenizerV2)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeLuceneStandardTokenizerV2(document.RootElement, options); + } + + internal static LuceneStandardTokenizerV2 DeserializeLuceneStandardTokenizerV2(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? maxTokenLength = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("maxTokenLength"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxTokenLength = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new LuceneStandardTokenizerV2(odataType, name, serializedAdditionalRawData, maxTokenLength); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(LuceneStandardTokenizerV2)} does not support writing '{options.Format}' format."); + } + } + + LuceneStandardTokenizerV2 IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLuceneStandardTokenizerV2(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(LuceneStandardTokenizerV2)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new LuceneStandardTokenizerV2 FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLuceneStandardTokenizerV2(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LuceneStandardTokenizerV2.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LuceneStandardTokenizerV2.cs new file mode 100644 index 000000000000..4e2e44dada2f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/LuceneStandardTokenizerV2.cs @@ -0,0 +1,61 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Breaks text following the Unicode Text Segmentation rules. This tokenizer is + /// implemented using Apache Lucene. + /// + public partial class LuceneStandardTokenizerV2 : LexicalTokenizer + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public LuceneStandardTokenizerV2(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.StandardTokenizerV2"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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 LuceneStandardTokenizerV2(string odataType, string name, IDictionary serializedAdditionalRawData, int? maxTokenLength) : base(odataType, name, serializedAdditionalRawData) + { + MaxTokenLength = maxTokenLength; + } + + /// Initializes a new instance of for deserialization. + internal LuceneStandardTokenizerV2() + { + } + + /// + /// 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. + /// + public int? MaxTokenLength { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MagnitudeScoringFunction.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MagnitudeScoringFunction.Serialization.cs new file mode 100644 index 000000000000..9bce23cf5481 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MagnitudeScoringFunction.Serialization.cs @@ -0,0 +1,162 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class MagnitudeScoringFunction : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(MagnitudeScoringFunction)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("magnitude"u8); + writer.WriteObjectValue(Magnitude, options); + } + + MagnitudeScoringFunction IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(MagnitudeScoringFunction)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeMagnitudeScoringFunction(document.RootElement, options); + } + + internal static MagnitudeScoringFunction DeserializeMagnitudeScoringFunction(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + MagnitudeScoringParameters magnitude = default; + string fieldName = default; + double boost = default; + ScoringFunctionInterpolation? interpolation = default; + string type = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("magnitude"u8)) + { + magnitude = MagnitudeScoringParameters.DeserializeMagnitudeScoringParameters(property.Value, options); + continue; + } + if (property.NameEquals("fieldName"u8)) + { + fieldName = property.Value.GetString(); + continue; + } + if (property.NameEquals("boost"u8)) + { + boost = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("interpolation"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + interpolation = new ScoringFunctionInterpolation(property.Value.GetString()); + continue; + } + if (property.NameEquals("type"u8)) + { + type = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new MagnitudeScoringFunction( + fieldName, + boost, + interpolation, + type, + serializedAdditionalRawData, + magnitude); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(MagnitudeScoringFunction)} does not support writing '{options.Format}' format."); + } + } + + MagnitudeScoringFunction IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeMagnitudeScoringFunction(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(MagnitudeScoringFunction)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new MagnitudeScoringFunction FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeMagnitudeScoringFunction(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MagnitudeScoringFunction.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MagnitudeScoringFunction.cs new file mode 100644 index 000000000000..aba69c09dae2 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MagnitudeScoringFunction.cs @@ -0,0 +1,53 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Defines a function that boosts scores based on the magnitude of a numeric field. + public partial class MagnitudeScoringFunction : ScoringFunction + { + /// Initializes a new instance of . + /// The name of the field used as input to the scoring function. + /// A multiplier for the raw score. Must be a positive number not equal to 1.0. + /// Parameter values for the magnitude scoring function. + /// or is null. + public MagnitudeScoringFunction(string fieldName, double boost, MagnitudeScoringParameters magnitude) : base(fieldName, boost) + { + Argument.AssertNotNull(fieldName, nameof(fieldName)); + Argument.AssertNotNull(magnitude, nameof(magnitude)); + + Type = "magnitude"; + Magnitude = magnitude; + } + + /// Initializes a new instance of . + /// The name of the field used as input to the scoring function. + /// A multiplier for the raw score. Must be a positive number not equal to 1.0. + /// + /// A value indicating how boosting will be interpolated across document scores; + /// defaults to "Linear". + /// + /// Type of ScoringFunction. + /// Keeps track of any properties unknown to the library. + /// Parameter values for the magnitude scoring function. + internal MagnitudeScoringFunction(string fieldName, double boost, ScoringFunctionInterpolation? interpolation, string type, IDictionary serializedAdditionalRawData, MagnitudeScoringParameters magnitude) : base(fieldName, boost, interpolation, type, serializedAdditionalRawData) + { + Magnitude = magnitude; + } + + /// Initializes a new instance of for deserialization. + internal MagnitudeScoringFunction() + { + } + + /// Parameter values for the magnitude scoring function. + public MagnitudeScoringParameters Magnitude { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MagnitudeScoringParameters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MagnitudeScoringParameters.Serialization.cs new file mode 100644 index 000000000000..b463b3c86953 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MagnitudeScoringParameters.Serialization.cs @@ -0,0 +1,165 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class MagnitudeScoringParameters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(MagnitudeScoringParameters)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("boostingRangeStart"u8); + writer.WriteNumberValue(BoostingRangeStart); + writer.WritePropertyName("boostingRangeEnd"u8); + writer.WriteNumberValue(BoostingRangeEnd); + if (Optional.IsDefined(ConstantBoostBeyondRange)) + { + writer.WritePropertyName("constantBoostBeyondRange"u8); + writer.WriteBooleanValue(ConstantBoostBeyondRange.Value); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + MagnitudeScoringParameters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(MagnitudeScoringParameters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeMagnitudeScoringParameters(document.RootElement, options); + } + + internal static MagnitudeScoringParameters DeserializeMagnitudeScoringParameters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + double boostingRangeStart = default; + double boostingRangeEnd = default; + bool? constantBoostBeyondRange = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("boostingRangeStart"u8)) + { + boostingRangeStart = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("boostingRangeEnd"u8)) + { + boostingRangeEnd = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("constantBoostBeyondRange"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + constantBoostBeyondRange = property.Value.GetBoolean(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new MagnitudeScoringParameters(boostingRangeStart, boostingRangeEnd, constantBoostBeyondRange, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(MagnitudeScoringParameters)} does not support writing '{options.Format}' format."); + } + } + + MagnitudeScoringParameters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeMagnitudeScoringParameters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(MagnitudeScoringParameters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static MagnitudeScoringParameters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeMagnitudeScoringParameters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MagnitudeScoringParameters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MagnitudeScoringParameters.cs new file mode 100644 index 000000000000..e4e5641e5d36 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MagnitudeScoringParameters.cs @@ -0,0 +1,88 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Provides parameter values to a magnitude scoring function. + public partial class MagnitudeScoringParameters + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The field value at which boosting starts. + /// The field value at which boosting ends. + public MagnitudeScoringParameters(double boostingRangeStart, double boostingRangeEnd) + { + BoostingRangeStart = boostingRangeStart; + BoostingRangeEnd = boostingRangeEnd; + } + + /// Initializes a new instance of . + /// The field value at which boosting starts. + /// The field value at which boosting ends. + /// + /// A value indicating whether to apply a constant boost for field values beyond + /// the range end value; default is false. + /// + /// Keeps track of any properties unknown to the library. + internal MagnitudeScoringParameters(double boostingRangeStart, double boostingRangeEnd, bool? constantBoostBeyondRange, IDictionary serializedAdditionalRawData) + { + BoostingRangeStart = boostingRangeStart; + BoostingRangeEnd = boostingRangeEnd; + ConstantBoostBeyondRange = constantBoostBeyondRange; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal MagnitudeScoringParameters() + { + } + + /// The field value at which boosting starts. + public double BoostingRangeStart { get; set; } + /// The field value at which boosting ends. + public double BoostingRangeEnd { get; set; } + /// + /// A value indicating whether to apply a constant boost for field values beyond + /// the range end value; default is false. + /// + public bool? ConstantBoostBeyondRange { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MappingCharFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MappingCharFilter.Serialization.cs new file mode 100644 index 000000000000..7ff0160af880 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MappingCharFilter.Serialization.cs @@ -0,0 +1,150 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class MappingCharFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(MappingCharFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("mappings"u8); + writer.WriteStartArray(); + foreach (var item in Mappings) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + + MappingCharFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(MappingCharFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeMappingCharFilter(document.RootElement, options); + } + + internal static MappingCharFilter DeserializeMappingCharFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList mappings = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("mappings"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + mappings = array; + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new MappingCharFilter(odataType, name, serializedAdditionalRawData, mappings); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(MappingCharFilter)} does not support writing '{options.Format}' format."); + } + } + + MappingCharFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeMappingCharFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(MappingCharFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new MappingCharFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeMappingCharFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MappingCharFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MappingCharFilter.cs new file mode 100644 index 000000000000..e7344e8d6c00 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MappingCharFilter.cs @@ -0,0 +1,70 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A character filter that applies mappings defined with the mappings option. + /// Matching is greedy (longest pattern matching at a given point wins). + /// Replacement is allowed to be the empty string. This character filter is + /// implemented using Apache Lucene. + /// + public partial class MappingCharFilter : CharFilter + { + /// Initializes a new instance of . + /// + /// 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"). + /// + /// or is null. + public MappingCharFilter(string name, IEnumerable mappings) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(mappings, nameof(mappings)); + + OdataType = "#Microsoft.Azure.Search.MappingCharFilter"; + Mappings = mappings.ToList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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, IDictionary serializedAdditionalRawData, IList mappings) : base(odataType, name, serializedAdditionalRawData) + { + Mappings = mappings; + } + + /// Initializes a new instance of for deserialization. + internal MappingCharFilter() + { + } + + /// + /// A list of mappings of the following format: "a=>b" (all occurrences of the + /// character "a" will be replaced with character "b"). + /// + public IList Mappings { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MarkdownHeaderDepth.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MarkdownHeaderDepth.cs new file mode 100644 index 000000000000..ff40e1500a64 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MarkdownHeaderDepth.cs @@ -0,0 +1,84 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Specifies the max header depth that will be considered while grouping markdown + /// content. Default is `h6`. + /// + public readonly partial struct MarkdownHeaderDepth : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public MarkdownHeaderDepth(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string H1Value = "h1"; + private const string H2Value = "h2"; + private const string H3Value = "h3"; + private const string H4Value = "h4"; + private const string H5Value = "h5"; + private const string H6Value = "h6"; + + /// + /// Indicates that headers up to a level of h1 will be considered while grouping + /// markdown content. + /// + public static MarkdownHeaderDepth H1 { get; } = new MarkdownHeaderDepth(H1Value); + /// + /// Indicates that headers up to a level of h2 will be considered while grouping + /// markdown content. + /// + public static MarkdownHeaderDepth H2 { get; } = new MarkdownHeaderDepth(H2Value); + /// + /// Indicates that headers up to a level of h3 will be considered while grouping + /// markdown content. + /// + public static MarkdownHeaderDepth H3 { get; } = new MarkdownHeaderDepth(H3Value); + /// + /// Indicates that headers up to a level of h4 will be considered while grouping + /// markdown content. + /// + public static MarkdownHeaderDepth H4 { get; } = new MarkdownHeaderDepth(H4Value); + /// + /// Indicates that headers up to a level of h5 will be considered while grouping + /// markdown content. + /// + public static MarkdownHeaderDepth H5 { get; } = new MarkdownHeaderDepth(H5Value); + /// + /// Indicates that headers up to a level of h6 will be considered while grouping + /// markdown content. This is the default. + /// + public static MarkdownHeaderDepth H6 { get; } = new MarkdownHeaderDepth(H6Value); + /// Determines if two values are the same. + public static bool operator ==(MarkdownHeaderDepth left, MarkdownHeaderDepth right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(MarkdownHeaderDepth left, MarkdownHeaderDepth right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator MarkdownHeaderDepth(string value) => new MarkdownHeaderDepth(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is MarkdownHeaderDepth other && Equals(other); + /// + public bool Equals(MarkdownHeaderDepth other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MarkdownParsingSubmode.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MarkdownParsingSubmode.cs new file mode 100644 index 000000000000..98c03c410dc4 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MarkdownParsingSubmode.cs @@ -0,0 +1,60 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Specifies the submode that will determine whether a markdown file will be + /// parsed into exactly one search document or multiple search documents. Default + /// is `oneToMany`. + /// + public readonly partial struct MarkdownParsingSubmode : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public MarkdownParsingSubmode(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string OneToManyValue = "oneToMany"; + private const string OneToOneValue = "oneToOne"; + + /// + /// Indicates that each section of the markdown file (up to a specified depth) will + /// be parsed into individual search documents. This can result in a single + /// markdown file producing multiple search documents. This is the default + /// sub-mode. + /// + public static MarkdownParsingSubmode OneToMany { get; } = new MarkdownParsingSubmode(OneToManyValue); + /// Indicates that each markdown file will be parsed into a single search document. + public static MarkdownParsingSubmode OneToOne { get; } = new MarkdownParsingSubmode(OneToOneValue); + /// Determines if two values are the same. + public static bool operator ==(MarkdownParsingSubmode left, MarkdownParsingSubmode right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(MarkdownParsingSubmode left, MarkdownParsingSubmode right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator MarkdownParsingSubmode(string value) => new MarkdownParsingSubmode(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is MarkdownParsingSubmode other && Equals(other); + /// + public bool Equals(MarkdownParsingSubmode other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MergeSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MergeSkill.Serialization.cs new file mode 100644 index 000000000000..561968385f05 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MergeSkill.Serialization.cs @@ -0,0 +1,197 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class MergeSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(MergeSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(InsertPreTag)) + { + writer.WritePropertyName("insertPreTag"u8); + writer.WriteStringValue(InsertPreTag); + } + if (Optional.IsDefined(InsertPostTag)) + { + writer.WritePropertyName("insertPostTag"u8); + writer.WriteStringValue(InsertPostTag); + } + } + + MergeSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(MergeSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeMergeSkill(document.RootElement, options); + } + + internal static MergeSkill DeserializeMergeSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string insertPreTag = default; + string insertPostTag = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("insertPreTag"u8)) + { + insertPreTag = property.Value.GetString(); + continue; + } + if (property.NameEquals("insertPostTag"u8)) + { + insertPostTag = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new MergeSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + insertPreTag, + insertPostTag); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(MergeSkill)} does not support writing '{options.Format}' format."); + } + } + + MergeSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeMergeSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(MergeSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new MergeSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeMergeSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MergeSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MergeSkill.cs new file mode 100644 index 000000000000..a27866856bbc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MergeSkill.cs @@ -0,0 +1,92 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A skill for merging two or more strings into a single unified string, with an + /// optional user-defined delimiter separating each component part. + /// + public partial class MergeSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public MergeSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Text.MergeSkill"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// The tag indicates the start of the merged text. By default, the tag is an empty + /// space. + /// + /// + /// The tag indicates the end of the merged text. By default, the tag is an empty + /// space. + /// + internal MergeSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData, string insertPreTag, string insertPostTag) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + InsertPreTag = insertPreTag; + InsertPostTag = insertPostTag; + } + + /// Initializes a new instance of for deserialization. + internal MergeSkill() + { + } + + /// + /// The tag indicates the start of the merged text. By default, the tag is an empty + /// space. + /// + public string InsertPreTag { get; set; } + /// + /// The tag indicates the end of the merged text. By default, the tag is an empty + /// space. + /// + public string InsertPostTag { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftLanguageStemmingTokenizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftLanguageStemmingTokenizer.Serialization.cs new file mode 100644 index 000000000000..5b8d7b504b5b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftLanguageStemmingTokenizer.Serialization.cs @@ -0,0 +1,183 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class MicrosoftLanguageStemmingTokenizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(MicrosoftLanguageStemmingTokenizer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(MaxTokenLength)) + { + writer.WritePropertyName("maxTokenLength"u8); + writer.WriteNumberValue(MaxTokenLength.Value); + } + if (Optional.IsDefined(IsSearchTokenizer)) + { + writer.WritePropertyName("isSearchTokenizer"u8); + writer.WriteBooleanValue(IsSearchTokenizer.Value); + } + if (Optional.IsDefined(Language)) + { + writer.WritePropertyName("language"u8); + writer.WriteStringValue(Language.Value.ToString()); + } + } + + MicrosoftLanguageStemmingTokenizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(MicrosoftLanguageStemmingTokenizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeMicrosoftLanguageStemmingTokenizer(document.RootElement, options); + } + + internal static MicrosoftLanguageStemmingTokenizer DeserializeMicrosoftLanguageStemmingTokenizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? maxTokenLength = default; + bool? isSearchTokenizer = default; + MicrosoftStemmingTokenizerLanguage? language = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("maxTokenLength"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxTokenLength = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("isSearchTokenizer"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + isSearchTokenizer = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("language"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + language = new MicrosoftStemmingTokenizerLanguage(property.Value.GetString()); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new MicrosoftLanguageStemmingTokenizer( + odataType, + name, + serializedAdditionalRawData, + maxTokenLength, + isSearchTokenizer, + language); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(MicrosoftLanguageStemmingTokenizer)} does not support writing '{options.Format}' format."); + } + } + + MicrosoftLanguageStemmingTokenizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeMicrosoftLanguageStemmingTokenizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(MicrosoftLanguageStemmingTokenizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new MicrosoftLanguageStemmingTokenizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeMicrosoftLanguageStemmingTokenizer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftLanguageStemmingTokenizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftLanguageStemmingTokenizer.cs new file mode 100644 index 000000000000..10e420b3a724 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftLanguageStemmingTokenizer.cs @@ -0,0 +1,79 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Divides text using language-specific rules and reduces words to their base + /// forms. + /// + public partial class MicrosoftLanguageStemmingTokenizer : LexicalTokenizer + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public MicrosoftLanguageStemmingTokenizer(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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. + /// + /// The language to use. The default is English. + internal MicrosoftLanguageStemmingTokenizer(string odataType, string name, IDictionary serializedAdditionalRawData, int? maxTokenLength, bool? isSearchTokenizer, MicrosoftStemmingTokenizerLanguage? language) : base(odataType, name, serializedAdditionalRawData) + { + MaxTokenLength = maxTokenLength; + IsSearchTokenizer = isSearchTokenizer; + Language = language; + } + + /// Initializes a new instance of for deserialization. + internal MicrosoftLanguageStemmingTokenizer() + { + } + + /// + /// 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. + /// + public int? MaxTokenLength { get; set; } + /// + /// 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. + /// + public bool? IsSearchTokenizer { get; set; } + /// The language to use. The default is English. + public MicrosoftStemmingTokenizerLanguage? Language { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftLanguageTokenizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftLanguageTokenizer.Serialization.cs new file mode 100644 index 000000000000..dd003254ccd8 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftLanguageTokenizer.Serialization.cs @@ -0,0 +1,183 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class MicrosoftLanguageTokenizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(MicrosoftLanguageTokenizer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(MaxTokenLength)) + { + writer.WritePropertyName("maxTokenLength"u8); + writer.WriteNumberValue(MaxTokenLength.Value); + } + if (Optional.IsDefined(IsSearchTokenizer)) + { + writer.WritePropertyName("isSearchTokenizer"u8); + writer.WriteBooleanValue(IsSearchTokenizer.Value); + } + if (Optional.IsDefined(Language)) + { + writer.WritePropertyName("language"u8); + writer.WriteStringValue(Language.Value.ToString()); + } + } + + MicrosoftLanguageTokenizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(MicrosoftLanguageTokenizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeMicrosoftLanguageTokenizer(document.RootElement, options); + } + + internal static MicrosoftLanguageTokenizer DeserializeMicrosoftLanguageTokenizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? maxTokenLength = default; + bool? isSearchTokenizer = default; + MicrosoftTokenizerLanguage? language = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("maxTokenLength"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxTokenLength = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("isSearchTokenizer"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + isSearchTokenizer = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("language"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + language = new MicrosoftTokenizerLanguage(property.Value.GetString()); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new MicrosoftLanguageTokenizer( + odataType, + name, + serializedAdditionalRawData, + maxTokenLength, + isSearchTokenizer, + language); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(MicrosoftLanguageTokenizer)} does not support writing '{options.Format}' format."); + } + } + + MicrosoftLanguageTokenizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeMicrosoftLanguageTokenizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(MicrosoftLanguageTokenizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new MicrosoftLanguageTokenizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeMicrosoftLanguageTokenizer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftLanguageTokenizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftLanguageTokenizer.cs new file mode 100644 index 000000000000..10ac134335c5 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftLanguageTokenizer.cs @@ -0,0 +1,76 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Divides text using language-specific rules. + public partial class MicrosoftLanguageTokenizer : LexicalTokenizer + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public MicrosoftLanguageTokenizer(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.MicrosoftLanguageTokenizer"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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. + /// + /// The language to use. The default is English. + internal MicrosoftLanguageTokenizer(string odataType, string name, IDictionary serializedAdditionalRawData, int? maxTokenLength, bool? isSearchTokenizer, MicrosoftTokenizerLanguage? language) : base(odataType, name, serializedAdditionalRawData) + { + MaxTokenLength = maxTokenLength; + IsSearchTokenizer = isSearchTokenizer; + Language = language; + } + + /// Initializes a new instance of for deserialization. + internal MicrosoftLanguageTokenizer() + { + } + + /// + /// 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. + /// + public int? MaxTokenLength { get; set; } + /// + /// 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. + /// + public bool? IsSearchTokenizer { get; set; } + /// The language to use. The default is English. + public MicrosoftTokenizerLanguage? Language { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftStemmingTokenizerLanguage.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftStemmingTokenizerLanguage.cs new file mode 100644 index 000000000000..8f0f3731606e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftStemmingTokenizerLanguage.cs @@ -0,0 +1,180 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Lists the languages supported by the Microsoft language stemming tokenizer. + public readonly partial struct MicrosoftStemmingTokenizerLanguage : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public MicrosoftStemmingTokenizerLanguage(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string ArabicValue = "arabic"; + private const string BanglaValue = "bangla"; + private const string BulgarianValue = "bulgarian"; + private const string CatalanValue = "catalan"; + private const string CroatianValue = "croatian"; + private const string CzechValue = "czech"; + private const string DanishValue = "danish"; + private const string DutchValue = "dutch"; + private const string EnglishValue = "english"; + private const string EstonianValue = "estonian"; + private const string FinnishValue = "finnish"; + private const string FrenchValue = "french"; + private const string GermanValue = "german"; + private const string GreekValue = "greek"; + private const string GujaratiValue = "gujarati"; + private const string HebrewValue = "hebrew"; + private const string HindiValue = "hindi"; + private const string HungarianValue = "hungarian"; + private const string IcelandicValue = "icelandic"; + private const string IndonesianValue = "indonesian"; + private const string ItalianValue = "italian"; + private const string KannadaValue = "kannada"; + private const string LatvianValue = "latvian"; + private const string LithuanianValue = "lithuanian"; + private const string MalayValue = "malay"; + private const string MalayalamValue = "malayalam"; + private const string MarathiValue = "marathi"; + private const string NorwegianBokmaalValue = "norwegianBokmaal"; + private const string PolishValue = "polish"; + private const string PortugueseValue = "portuguese"; + private const string PortugueseBrazilianValue = "portugueseBrazilian"; + private const string PunjabiValue = "punjabi"; + private const string RomanianValue = "romanian"; + private const string RussianValue = "russian"; + private const string SerbianCyrillicValue = "serbianCyrillic"; + private const string SerbianLatinValue = "serbianLatin"; + private const string SlovakValue = "slovak"; + private const string SlovenianValue = "slovenian"; + private const string SpanishValue = "spanish"; + private const string SwedishValue = "swedish"; + private const string TamilValue = "tamil"; + private const string TeluguValue = "telugu"; + private const string TurkishValue = "turkish"; + private const string UkrainianValue = "ukrainian"; + private const string UrduValue = "urdu"; + + /// Selects the Microsoft stemming tokenizer for Arabic. + public static MicrosoftStemmingTokenizerLanguage Arabic { get; } = new MicrosoftStemmingTokenizerLanguage(ArabicValue); + /// Selects the Microsoft stemming tokenizer for Bangla. + public static MicrosoftStemmingTokenizerLanguage Bangla { get; } = new MicrosoftStemmingTokenizerLanguage(BanglaValue); + /// Selects the Microsoft stemming tokenizer for Bulgarian. + public static MicrosoftStemmingTokenizerLanguage Bulgarian { get; } = new MicrosoftStemmingTokenizerLanguage(BulgarianValue); + /// Selects the Microsoft stemming tokenizer for Catalan. + public static MicrosoftStemmingTokenizerLanguage Catalan { get; } = new MicrosoftStemmingTokenizerLanguage(CatalanValue); + /// Selects the Microsoft stemming tokenizer for Croatian. + public static MicrosoftStemmingTokenizerLanguage Croatian { get; } = new MicrosoftStemmingTokenizerLanguage(CroatianValue); + /// Selects the Microsoft stemming tokenizer for Czech. + public static MicrosoftStemmingTokenizerLanguage Czech { get; } = new MicrosoftStemmingTokenizerLanguage(CzechValue); + /// Selects the Microsoft stemming tokenizer for Danish. + public static MicrosoftStemmingTokenizerLanguage Danish { get; } = new MicrosoftStemmingTokenizerLanguage(DanishValue); + /// Selects the Microsoft stemming tokenizer for Dutch. + public static MicrosoftStemmingTokenizerLanguage Dutch { get; } = new MicrosoftStemmingTokenizerLanguage(DutchValue); + /// Selects the Microsoft stemming tokenizer for English. + public static MicrosoftStemmingTokenizerLanguage English { get; } = new MicrosoftStemmingTokenizerLanguage(EnglishValue); + /// Selects the Microsoft stemming tokenizer for Estonian. + public static MicrosoftStemmingTokenizerLanguage Estonian { get; } = new MicrosoftStemmingTokenizerLanguage(EstonianValue); + /// Selects the Microsoft stemming tokenizer for Finnish. + public static MicrosoftStemmingTokenizerLanguage Finnish { get; } = new MicrosoftStemmingTokenizerLanguage(FinnishValue); + /// Selects the Microsoft stemming tokenizer for French. + public static MicrosoftStemmingTokenizerLanguage French { get; } = new MicrosoftStemmingTokenizerLanguage(FrenchValue); + /// Selects the Microsoft stemming tokenizer for German. + public static MicrosoftStemmingTokenizerLanguage German { get; } = new MicrosoftStemmingTokenizerLanguage(GermanValue); + /// Selects the Microsoft stemming tokenizer for Greek. + public static MicrosoftStemmingTokenizerLanguage Greek { get; } = new MicrosoftStemmingTokenizerLanguage(GreekValue); + /// Selects the Microsoft stemming tokenizer for Gujarati. + public static MicrosoftStemmingTokenizerLanguage Gujarati { get; } = new MicrosoftStemmingTokenizerLanguage(GujaratiValue); + /// Selects the Microsoft stemming tokenizer for Hebrew. + public static MicrosoftStemmingTokenizerLanguage Hebrew { get; } = new MicrosoftStemmingTokenizerLanguage(HebrewValue); + /// Selects the Microsoft stemming tokenizer for Hindi. + public static MicrosoftStemmingTokenizerLanguage Hindi { get; } = new MicrosoftStemmingTokenizerLanguage(HindiValue); + /// Selects the Microsoft stemming tokenizer for Hungarian. + public static MicrosoftStemmingTokenizerLanguage Hungarian { get; } = new MicrosoftStemmingTokenizerLanguage(HungarianValue); + /// Selects the Microsoft stemming tokenizer for Icelandic. + public static MicrosoftStemmingTokenizerLanguage Icelandic { get; } = new MicrosoftStemmingTokenizerLanguage(IcelandicValue); + /// Selects the Microsoft stemming tokenizer for Indonesian. + public static MicrosoftStemmingTokenizerLanguage Indonesian { get; } = new MicrosoftStemmingTokenizerLanguage(IndonesianValue); + /// Selects the Microsoft stemming tokenizer for Italian. + public static MicrosoftStemmingTokenizerLanguage Italian { get; } = new MicrosoftStemmingTokenizerLanguage(ItalianValue); + /// Selects the Microsoft stemming tokenizer for Kannada. + public static MicrosoftStemmingTokenizerLanguage Kannada { get; } = new MicrosoftStemmingTokenizerLanguage(KannadaValue); + /// Selects the Microsoft stemming tokenizer for Latvian. + public static MicrosoftStemmingTokenizerLanguage Latvian { get; } = new MicrosoftStemmingTokenizerLanguage(LatvianValue); + /// Selects the Microsoft stemming tokenizer for Lithuanian. + public static MicrosoftStemmingTokenizerLanguage Lithuanian { get; } = new MicrosoftStemmingTokenizerLanguage(LithuanianValue); + /// Selects the Microsoft stemming tokenizer for Malay. + public static MicrosoftStemmingTokenizerLanguage Malay { get; } = new MicrosoftStemmingTokenizerLanguage(MalayValue); + /// Selects the Microsoft stemming tokenizer for Malayalam. + public static MicrosoftStemmingTokenizerLanguage Malayalam { get; } = new MicrosoftStemmingTokenizerLanguage(MalayalamValue); + /// Selects the Microsoft stemming tokenizer for Marathi. + public static MicrosoftStemmingTokenizerLanguage Marathi { get; } = new MicrosoftStemmingTokenizerLanguage(MarathiValue); + /// Selects the Microsoft stemming tokenizer for Norwegian (Bokmål). + public static MicrosoftStemmingTokenizerLanguage NorwegianBokmaal { get; } = new MicrosoftStemmingTokenizerLanguage(NorwegianBokmaalValue); + /// Selects the Microsoft stemming tokenizer for Polish. + public static MicrosoftStemmingTokenizerLanguage Polish { get; } = new MicrosoftStemmingTokenizerLanguage(PolishValue); + /// Selects the Microsoft stemming tokenizer for Portuguese. + public static MicrosoftStemmingTokenizerLanguage Portuguese { get; } = new MicrosoftStemmingTokenizerLanguage(PortugueseValue); + /// Selects the Microsoft stemming tokenizer for Portuguese (Brazil). + public static MicrosoftStemmingTokenizerLanguage PortugueseBrazilian { get; } = new MicrosoftStemmingTokenizerLanguage(PortugueseBrazilianValue); + /// Selects the Microsoft stemming tokenizer for Punjabi. + public static MicrosoftStemmingTokenizerLanguage Punjabi { get; } = new MicrosoftStemmingTokenizerLanguage(PunjabiValue); + /// Selects the Microsoft stemming tokenizer for Romanian. + public static MicrosoftStemmingTokenizerLanguage Romanian { get; } = new MicrosoftStemmingTokenizerLanguage(RomanianValue); + /// Selects the Microsoft stemming tokenizer for Russian. + public static MicrosoftStemmingTokenizerLanguage Russian { get; } = new MicrosoftStemmingTokenizerLanguage(RussianValue); + /// Selects the Microsoft stemming tokenizer for Serbian (Cyrillic). + public static MicrosoftStemmingTokenizerLanguage SerbianCyrillic { get; } = new MicrosoftStemmingTokenizerLanguage(SerbianCyrillicValue); + /// Selects the Microsoft stemming tokenizer for Serbian (Latin). + public static MicrosoftStemmingTokenizerLanguage SerbianLatin { get; } = new MicrosoftStemmingTokenizerLanguage(SerbianLatinValue); + /// Selects the Microsoft stemming tokenizer for Slovak. + public static MicrosoftStemmingTokenizerLanguage Slovak { get; } = new MicrosoftStemmingTokenizerLanguage(SlovakValue); + /// Selects the Microsoft stemming tokenizer for Slovenian. + public static MicrosoftStemmingTokenizerLanguage Slovenian { get; } = new MicrosoftStemmingTokenizerLanguage(SlovenianValue); + /// Selects the Microsoft stemming tokenizer for Spanish. + public static MicrosoftStemmingTokenizerLanguage Spanish { get; } = new MicrosoftStemmingTokenizerLanguage(SpanishValue); + /// Selects the Microsoft stemming tokenizer for Swedish. + public static MicrosoftStemmingTokenizerLanguage Swedish { get; } = new MicrosoftStemmingTokenizerLanguage(SwedishValue); + /// Selects the Microsoft stemming tokenizer for Tamil. + public static MicrosoftStemmingTokenizerLanguage Tamil { get; } = new MicrosoftStemmingTokenizerLanguage(TamilValue); + /// Selects the Microsoft stemming tokenizer for Telugu. + public static MicrosoftStemmingTokenizerLanguage Telugu { get; } = new MicrosoftStemmingTokenizerLanguage(TeluguValue); + /// Selects the Microsoft stemming tokenizer for Turkish. + public static MicrosoftStemmingTokenizerLanguage Turkish { get; } = new MicrosoftStemmingTokenizerLanguage(TurkishValue); + /// Selects the Microsoft stemming tokenizer for Ukrainian. + public static MicrosoftStemmingTokenizerLanguage Ukrainian { get; } = new MicrosoftStemmingTokenizerLanguage(UkrainianValue); + /// Selects the Microsoft stemming tokenizer for Urdu. + public static MicrosoftStemmingTokenizerLanguage Urdu { get; } = new MicrosoftStemmingTokenizerLanguage(UrduValue); + /// Determines if two values are the same. + public static bool operator ==(MicrosoftStemmingTokenizerLanguage left, MicrosoftStemmingTokenizerLanguage right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(MicrosoftStemmingTokenizerLanguage left, MicrosoftStemmingTokenizerLanguage right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator MicrosoftStemmingTokenizerLanguage(string value) => new MicrosoftStemmingTokenizerLanguage(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is MicrosoftStemmingTokenizerLanguage other && Equals(other); + /// + public bool Equals(MicrosoftStemmingTokenizerLanguage other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftTokenizerLanguage.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftTokenizerLanguage.cs new file mode 100644 index 000000000000..c37df799e35a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/MicrosoftTokenizerLanguage.cs @@ -0,0 +1,171 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Lists the languages supported by the Microsoft language tokenizer. + public readonly partial struct MicrosoftTokenizerLanguage : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public MicrosoftTokenizerLanguage(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string BanglaValue = "bangla"; + private const string BulgarianValue = "bulgarian"; + private const string CatalanValue = "catalan"; + private const string ChineseSimplifiedValue = "chineseSimplified"; + private const string ChineseTraditionalValue = "chineseTraditional"; + private const string CroatianValue = "croatian"; + private const string CzechValue = "czech"; + private const string DanishValue = "danish"; + private const string DutchValue = "dutch"; + private const string EnglishValue = "english"; + private const string FrenchValue = "french"; + private const string GermanValue = "german"; + private const string GreekValue = "greek"; + private const string GujaratiValue = "gujarati"; + private const string HindiValue = "hindi"; + private const string IcelandicValue = "icelandic"; + private const string IndonesianValue = "indonesian"; + private const string ItalianValue = "italian"; + private const string JapaneseValue = "japanese"; + private const string KannadaValue = "kannada"; + private const string KoreanValue = "korean"; + private const string MalayValue = "malay"; + private const string MalayalamValue = "malayalam"; + private const string MarathiValue = "marathi"; + private const string NorwegianBokmaalValue = "norwegianBokmaal"; + private const string PolishValue = "polish"; + private const string PortugueseValue = "portuguese"; + private const string PortugueseBrazilianValue = "portugueseBrazilian"; + private const string PunjabiValue = "punjabi"; + private const string RomanianValue = "romanian"; + private const string RussianValue = "russian"; + private const string SerbianCyrillicValue = "serbianCyrillic"; + private const string SerbianLatinValue = "serbianLatin"; + private const string SlovenianValue = "slovenian"; + private const string SpanishValue = "spanish"; + private const string SwedishValue = "swedish"; + private const string TamilValue = "tamil"; + private const string TeluguValue = "telugu"; + private const string ThaiValue = "thai"; + private const string UkrainianValue = "ukrainian"; + private const string UrduValue = "urdu"; + private const string VietnameseValue = "vietnamese"; + + /// Selects the Microsoft tokenizer for Bangla. + public static MicrosoftTokenizerLanguage Bangla { get; } = new MicrosoftTokenizerLanguage(BanglaValue); + /// Selects the Microsoft tokenizer for Bulgarian. + public static MicrosoftTokenizerLanguage Bulgarian { get; } = new MicrosoftTokenizerLanguage(BulgarianValue); + /// Selects the Microsoft tokenizer for Catalan. + public static MicrosoftTokenizerLanguage Catalan { get; } = new MicrosoftTokenizerLanguage(CatalanValue); + /// Selects the Microsoft tokenizer for Chinese (Simplified). + public static MicrosoftTokenizerLanguage ChineseSimplified { get; } = new MicrosoftTokenizerLanguage(ChineseSimplifiedValue); + /// Selects the Microsoft tokenizer for Chinese (Traditional). + public static MicrosoftTokenizerLanguage ChineseTraditional { get; } = new MicrosoftTokenizerLanguage(ChineseTraditionalValue); + /// Selects the Microsoft tokenizer for Croatian. + public static MicrosoftTokenizerLanguage Croatian { get; } = new MicrosoftTokenizerLanguage(CroatianValue); + /// Selects the Microsoft tokenizer for Czech. + public static MicrosoftTokenizerLanguage Czech { get; } = new MicrosoftTokenizerLanguage(CzechValue); + /// Selects the Microsoft tokenizer for Danish. + public static MicrosoftTokenizerLanguage Danish { get; } = new MicrosoftTokenizerLanguage(DanishValue); + /// Selects the Microsoft tokenizer for Dutch. + public static MicrosoftTokenizerLanguage Dutch { get; } = new MicrosoftTokenizerLanguage(DutchValue); + /// Selects the Microsoft tokenizer for English. + public static MicrosoftTokenizerLanguage English { get; } = new MicrosoftTokenizerLanguage(EnglishValue); + /// Selects the Microsoft tokenizer for French. + public static MicrosoftTokenizerLanguage French { get; } = new MicrosoftTokenizerLanguage(FrenchValue); + /// Selects the Microsoft tokenizer for German. + public static MicrosoftTokenizerLanguage German { get; } = new MicrosoftTokenizerLanguage(GermanValue); + /// Selects the Microsoft tokenizer for Greek. + public static MicrosoftTokenizerLanguage Greek { get; } = new MicrosoftTokenizerLanguage(GreekValue); + /// Selects the Microsoft tokenizer for Gujarati. + public static MicrosoftTokenizerLanguage Gujarati { get; } = new MicrosoftTokenizerLanguage(GujaratiValue); + /// Selects the Microsoft tokenizer for Hindi. + public static MicrosoftTokenizerLanguage Hindi { get; } = new MicrosoftTokenizerLanguage(HindiValue); + /// Selects the Microsoft tokenizer for Icelandic. + public static MicrosoftTokenizerLanguage Icelandic { get; } = new MicrosoftTokenizerLanguage(IcelandicValue); + /// Selects the Microsoft tokenizer for Indonesian. + public static MicrosoftTokenizerLanguage Indonesian { get; } = new MicrosoftTokenizerLanguage(IndonesianValue); + /// Selects the Microsoft tokenizer for Italian. + public static MicrosoftTokenizerLanguage Italian { get; } = new MicrosoftTokenizerLanguage(ItalianValue); + /// Selects the Microsoft tokenizer for Japanese. + public static MicrosoftTokenizerLanguage Japanese { get; } = new MicrosoftTokenizerLanguage(JapaneseValue); + /// Selects the Microsoft tokenizer for Kannada. + public static MicrosoftTokenizerLanguage Kannada { get; } = new MicrosoftTokenizerLanguage(KannadaValue); + /// Selects the Microsoft tokenizer for Korean. + public static MicrosoftTokenizerLanguage Korean { get; } = new MicrosoftTokenizerLanguage(KoreanValue); + /// Selects the Microsoft tokenizer for Malay. + public static MicrosoftTokenizerLanguage Malay { get; } = new MicrosoftTokenizerLanguage(MalayValue); + /// Selects the Microsoft tokenizer for Malayalam. + public static MicrosoftTokenizerLanguage Malayalam { get; } = new MicrosoftTokenizerLanguage(MalayalamValue); + /// Selects the Microsoft tokenizer for Marathi. + public static MicrosoftTokenizerLanguage Marathi { get; } = new MicrosoftTokenizerLanguage(MarathiValue); + /// Selects the Microsoft tokenizer for Norwegian (Bokmål). + public static MicrosoftTokenizerLanguage NorwegianBokmaal { get; } = new MicrosoftTokenizerLanguage(NorwegianBokmaalValue); + /// Selects the Microsoft tokenizer for Polish. + public static MicrosoftTokenizerLanguage Polish { get; } = new MicrosoftTokenizerLanguage(PolishValue); + /// Selects the Microsoft tokenizer for Portuguese. + public static MicrosoftTokenizerLanguage Portuguese { get; } = new MicrosoftTokenizerLanguage(PortugueseValue); + /// Selects the Microsoft tokenizer for Portuguese (Brazil). + public static MicrosoftTokenizerLanguage PortugueseBrazilian { get; } = new MicrosoftTokenizerLanguage(PortugueseBrazilianValue); + /// Selects the Microsoft tokenizer for Punjabi. + public static MicrosoftTokenizerLanguage Punjabi { get; } = new MicrosoftTokenizerLanguage(PunjabiValue); + /// Selects the Microsoft tokenizer for Romanian. + public static MicrosoftTokenizerLanguage Romanian { get; } = new MicrosoftTokenizerLanguage(RomanianValue); + /// Selects the Microsoft tokenizer for Russian. + public static MicrosoftTokenizerLanguage Russian { get; } = new MicrosoftTokenizerLanguage(RussianValue); + /// Selects the Microsoft tokenizer for Serbian (Cyrillic). + public static MicrosoftTokenizerLanguage SerbianCyrillic { get; } = new MicrosoftTokenizerLanguage(SerbianCyrillicValue); + /// Selects the Microsoft tokenizer for Serbian (Latin). + public static MicrosoftTokenizerLanguage SerbianLatin { get; } = new MicrosoftTokenizerLanguage(SerbianLatinValue); + /// Selects the Microsoft tokenizer for Slovenian. + public static MicrosoftTokenizerLanguage Slovenian { get; } = new MicrosoftTokenizerLanguage(SlovenianValue); + /// Selects the Microsoft tokenizer for Spanish. + public static MicrosoftTokenizerLanguage Spanish { get; } = new MicrosoftTokenizerLanguage(SpanishValue); + /// Selects the Microsoft tokenizer for Swedish. + public static MicrosoftTokenizerLanguage Swedish { get; } = new MicrosoftTokenizerLanguage(SwedishValue); + /// Selects the Microsoft tokenizer for Tamil. + public static MicrosoftTokenizerLanguage Tamil { get; } = new MicrosoftTokenizerLanguage(TamilValue); + /// Selects the Microsoft tokenizer for Telugu. + public static MicrosoftTokenizerLanguage Telugu { get; } = new MicrosoftTokenizerLanguage(TeluguValue); + /// Selects the Microsoft tokenizer for Thai. + public static MicrosoftTokenizerLanguage Thai { get; } = new MicrosoftTokenizerLanguage(ThaiValue); + /// Selects the Microsoft tokenizer for Ukrainian. + public static MicrosoftTokenizerLanguage Ukrainian { get; } = new MicrosoftTokenizerLanguage(UkrainianValue); + /// Selects the Microsoft tokenizer for Urdu. + public static MicrosoftTokenizerLanguage Urdu { get; } = new MicrosoftTokenizerLanguage(UrduValue); + /// Selects the Microsoft tokenizer for Vietnamese. + public static MicrosoftTokenizerLanguage Vietnamese { get; } = new MicrosoftTokenizerLanguage(VietnameseValue); + /// Determines if two values are the same. + public static bool operator ==(MicrosoftTokenizerLanguage left, MicrosoftTokenizerLanguage right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(MicrosoftTokenizerLanguage left, MicrosoftTokenizerLanguage right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator MicrosoftTokenizerLanguage(string value) => new MicrosoftTokenizerLanguage(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is MicrosoftTokenizerLanguage other && Equals(other); + /// + public bool Equals(MicrosoftTokenizerLanguage other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NGramTokenFilterV2.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NGramTokenFilterV2.Serialization.cs new file mode 100644 index 000000000000..712ced72007e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NGramTokenFilterV2.Serialization.cs @@ -0,0 +1,162 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class NGramTokenFilterV2 : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(NGramTokenFilterV2)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(MinGram)) + { + writer.WritePropertyName("minGram"u8); + writer.WriteNumberValue(MinGram.Value); + } + if (Optional.IsDefined(MaxGram)) + { + writer.WritePropertyName("maxGram"u8); + writer.WriteNumberValue(MaxGram.Value); + } + } + + NGramTokenFilterV2 IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(NGramTokenFilterV2)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeNGramTokenFilterV2(document.RootElement, options); + } + + internal static NGramTokenFilterV2 DeserializeNGramTokenFilterV2(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? minGram = default; + int? maxGram = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("minGram"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + minGram = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("maxGram"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxGram = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new NGramTokenFilterV2(odataType, name, serializedAdditionalRawData, minGram, maxGram); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(NGramTokenFilterV2)} does not support writing '{options.Format}' format."); + } + } + + NGramTokenFilterV2 IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeNGramTokenFilterV2(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(NGramTokenFilterV2)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new NGramTokenFilterV2 FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeNGramTokenFilterV2(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NGramTokenFilterV2.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NGramTokenFilterV2.cs new file mode 100644 index 000000000000..8f564968932e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NGramTokenFilterV2.cs @@ -0,0 +1,65 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Generates n-grams of the given size(s). This token filter is implemented using + /// Apache Lucene. + /// + public partial class NGramTokenFilterV2 : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public NGramTokenFilterV2(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.NGramTokenFilterV2"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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. + internal NGramTokenFilterV2(string odataType, string name, IDictionary serializedAdditionalRawData, int? minGram, int? maxGram) : base(odataType, name, serializedAdditionalRawData) + { + MinGram = minGram; + MaxGram = maxGram; + } + + /// Initializes a new instance of for deserialization. + internal NGramTokenFilterV2() + { + } + + /// + /// The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the + /// value of maxGram. + /// + public int? MinGram { get; set; } + /// The maximum n-gram length. Default is 2. Maximum is 300. + public int? MaxGram { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NGramTokenizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NGramTokenizer.Serialization.cs new file mode 100644 index 000000000000..1809ce77c8ee --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NGramTokenizer.Serialization.cs @@ -0,0 +1,193 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class NGramTokenizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(NGramTokenizer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(MinGram)) + { + writer.WritePropertyName("minGram"u8); + writer.WriteNumberValue(MinGram.Value); + } + if (Optional.IsDefined(MaxGram)) + { + writer.WritePropertyName("maxGram"u8); + writer.WriteNumberValue(MaxGram.Value); + } + if (Optional.IsCollectionDefined(TokenChars)) + { + writer.WritePropertyName("tokenChars"u8); + writer.WriteStartArray(); + foreach (var item in TokenChars) + { + writer.WriteStringValue(item.ToString()); + } + writer.WriteEndArray(); + } + } + + NGramTokenizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(NGramTokenizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeNGramTokenizer(document.RootElement, options); + } + + internal static NGramTokenizer DeserializeNGramTokenizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? minGram = default; + int? maxGram = default; + IList tokenChars = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("minGram"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + minGram = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("maxGram"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxGram = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("tokenChars"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(new TokenCharacterKind(item.GetString())); + } + tokenChars = array; + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new NGramTokenizer( + odataType, + name, + serializedAdditionalRawData, + minGram, + maxGram, + tokenChars ?? new ChangeTrackingList()); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(NGramTokenizer)} does not support writing '{options.Format}' format."); + } + } + + NGramTokenizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeNGramTokenizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(NGramTokenizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new NGramTokenizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeNGramTokenizer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NGramTokenizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NGramTokenizer.cs new file mode 100644 index 000000000000..01ea970db4b5 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NGramTokenizer.cs @@ -0,0 +1,70 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Tokenizes the input into n-grams of the given size(s). This tokenizer is + /// implemented using Apache Lucene. + /// + public partial class NGramTokenizer : LexicalTokenizer + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public NGramTokenizer(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.NGramTokenizer"; + TokenChars = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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. + /// Character classes to keep in the tokens. + internal NGramTokenizer(string odataType, string name, IDictionary serializedAdditionalRawData, int? minGram, int? maxGram, IList tokenChars) : base(odataType, name, serializedAdditionalRawData) + { + MinGram = minGram; + MaxGram = maxGram; + TokenChars = tokenChars; + } + + /// Initializes a new instance of for deserialization. + internal NGramTokenizer() + { + } + + /// + /// The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the + /// value of maxGram. + /// + public int? MinGram { get; set; } + /// The maximum n-gram length. Default is 2. Maximum is 300. + public int? MaxGram { get; set; } + /// Character classes to keep in the tokens. + public IList TokenChars { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NativeBlobSoftDeleteDeletionDetectionPolicy.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NativeBlobSoftDeleteDeletionDetectionPolicy.Serialization.cs new file mode 100644 index 000000000000..f27165a7ab23 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NativeBlobSoftDeleteDeletionDetectionPolicy.Serialization.cs @@ -0,0 +1,126 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class NativeBlobSoftDeleteDeletionDetectionPolicy : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(NativeBlobSoftDeleteDeletionDetectionPolicy)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + NativeBlobSoftDeleteDeletionDetectionPolicy IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(NativeBlobSoftDeleteDeletionDetectionPolicy)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeNativeBlobSoftDeleteDeletionDetectionPolicy(document.RootElement, options); + } + + internal static NativeBlobSoftDeleteDeletionDetectionPolicy DeserializeNativeBlobSoftDeleteDeletionDetectionPolicy(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new NativeBlobSoftDeleteDeletionDetectionPolicy(odataType, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(NativeBlobSoftDeleteDeletionDetectionPolicy)} does not support writing '{options.Format}' format."); + } + } + + NativeBlobSoftDeleteDeletionDetectionPolicy IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeNativeBlobSoftDeleteDeletionDetectionPolicy(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(NativeBlobSoftDeleteDeletionDetectionPolicy)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new NativeBlobSoftDeleteDeletionDetectionPolicy FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeNativeBlobSoftDeleteDeletionDetectionPolicy(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NativeBlobSoftDeleteDeletionDetectionPolicy.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NativeBlobSoftDeleteDeletionDetectionPolicy.cs new file mode 100644 index 000000000000..24f8799d2672 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/NativeBlobSoftDeleteDeletionDetectionPolicy.cs @@ -0,0 +1,32 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Defines a data deletion detection policy utilizing Azure Blob Storage's native + /// soft delete feature for deletion detection. + /// + public partial class NativeBlobSoftDeleteDeletionDetectionPolicy : DataDeletionDetectionPolicy + { + /// Initializes a new instance of . + public NativeBlobSoftDeleteDeletionDetectionPolicy() + { + OdataType = "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Keeps track of any properties unknown to the library. + internal NativeBlobSoftDeleteDeletionDetectionPolicy(string odataType, IDictionary serializedAdditionalRawData) : base(odataType, serializedAdditionalRawData) + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OcrLineEnding.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OcrLineEnding.cs new file mode 100644 index 000000000000..631759da01ee --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OcrLineEnding.cs @@ -0,0 +1,60 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Defines the sequence of characters to use between the lines of text recognized + /// by the OCR skill. The default value is "space". + /// + public readonly partial struct OcrLineEnding : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public OcrLineEnding(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string SpaceValue = "space"; + private const string CarriageReturnValue = "carriageReturn"; + private const string LineFeedValue = "lineFeed"; + private const string CarriageReturnLineFeedValue = "carriageReturnLineFeed"; + + /// Lines are separated by a single space character. + public static OcrLineEnding Space { get; } = new OcrLineEnding(SpaceValue); + /// Lines are separated by a carriage return ('\r') character. + public static OcrLineEnding CarriageReturn { get; } = new OcrLineEnding(CarriageReturnValue); + /// Lines are separated by a single line feed ('\n') character. + public static OcrLineEnding LineFeed { get; } = new OcrLineEnding(LineFeedValue); + /// Lines are separated by a carriage return and a line feed ('\r\n') character. + public static OcrLineEnding CarriageReturnLineFeed { get; } = new OcrLineEnding(CarriageReturnLineFeedValue); + /// Determines if two values are the same. + public static bool operator ==(OcrLineEnding left, OcrLineEnding right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(OcrLineEnding left, OcrLineEnding right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator OcrLineEnding(string value) => new OcrLineEnding(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is OcrLineEnding other && Equals(other); + /// + public bool Equals(OcrLineEnding other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OcrSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OcrSkill.Serialization.cs new file mode 100644 index 000000000000..8b19139c5ce8 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OcrSkill.Serialization.cs @@ -0,0 +1,221 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class OcrSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(OcrSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(DefaultLanguageCode)) + { + writer.WritePropertyName("defaultLanguageCode"u8); + writer.WriteStringValue(DefaultLanguageCode.Value.ToString()); + } + if (Optional.IsDefined(DetectOrientation)) + { + writer.WritePropertyName("detectOrientation"u8); + writer.WriteBooleanValue(DetectOrientation.Value); + } + if (Optional.IsDefined(LineEnding)) + { + writer.WritePropertyName("lineEnding"u8); + writer.WriteStringValue(LineEnding.Value.ToString()); + } + } + + OcrSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(OcrSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeOcrSkill(document.RootElement, options); + } + + internal static OcrSkill DeserializeOcrSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + OcrSkillLanguage? defaultLanguageCode = default; + bool? detectOrientation = default; + OcrLineEnding? lineEnding = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("defaultLanguageCode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + defaultLanguageCode = new OcrSkillLanguage(property.Value.GetString()); + continue; + } + if (property.NameEquals("detectOrientation"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + detectOrientation = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("lineEnding"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + lineEnding = new OcrLineEnding(property.Value.GetString()); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new OcrSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + defaultLanguageCode, + detectOrientation, + lineEnding); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(OcrSkill)} does not support writing '{options.Format}' format."); + } + } + + OcrSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeOcrSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(OcrSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new OcrSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeOcrSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OcrSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OcrSkill.cs new file mode 100644 index 000000000000..542c3a35099d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OcrSkill.cs @@ -0,0 +1,87 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// A skill that extracts text from image files. + public partial class OcrSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public OcrSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Vision.OcrSkill"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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, IDictionary serializedAdditionalRawData, OcrSkillLanguage? defaultLanguageCode, bool? detectOrientation, OcrLineEnding? lineEnding) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + DefaultLanguageCode = defaultLanguageCode; + DetectOrientation = detectOrientation; + LineEnding = lineEnding; + } + + /// Initializes a new instance of for deserialization. + internal OcrSkill() + { + } + + /// A value indicating which language code to use. Default is `en`. + public OcrSkillLanguage? DefaultLanguageCode { get; set; } + /// A value indicating to turn orientation detection on or not. Default is false. + public bool? DetectOrientation { get; set; } + /// + /// Defines the sequence of characters to use between the lines of text recognized + /// by the OCR skill. The default value is "space". + /// + public OcrLineEnding? LineEnding { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OcrSkillLanguage.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OcrSkillLanguage.cs new file mode 100644 index 000000000000..5a7558dea2a6 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OcrSkillLanguage.cs @@ -0,0 +1,555 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The language codes supported for input by OcrSkill. + public readonly partial struct OcrSkillLanguage : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public OcrSkillLanguage(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string AfValue = "af"; + private const string SqValue = "sq"; + private const string AnpValue = "anp"; + private const string ArValue = "ar"; + private const string AstValue = "ast"; + private const string AwaValue = "awa"; + private const string AzValue = "az"; + private const string BfyValue = "bfy"; + private const string EuValue = "eu"; + private const string BeValue = "be"; + private const string BeCyrlValue = "be-cyrl"; + private const string BeLatnValue = "be-latn"; + private const string BhoValue = "bho"; + private const string BiValue = "bi"; + private const string BrxValue = "brx"; + private const string BsValue = "bs"; + private const string BraValue = "bra"; + private const string BrValue = "br"; + private const string BgValue = "bg"; + private const string BnsValue = "bns"; + private const string BuaValue = "bua"; + private const string CaValue = "ca"; + private const string CebValue = "ceb"; + private const string RabValue = "rab"; + private const string ChValue = "ch"; + private const string HneValue = "hne"; + private const string ZhHansValue = "zh-Hans"; + private const string ZhHantValue = "zh-Hant"; + private const string KwValue = "kw"; + private const string CoValue = "co"; + private const string CrhValue = "crh"; + private const string HrValue = "hr"; + private const string CsValue = "cs"; + private const string DaValue = "da"; + private const string PrsValue = "prs"; + private const string DhiValue = "dhi"; + private const string DoiValue = "doi"; + private const string NlValue = "nl"; + private const string EnValue = "en"; + private const string MyvValue = "myv"; + private const string EtValue = "et"; + private const string FoValue = "fo"; + private const string FjValue = "fj"; + private const string FilValue = "fil"; + private const string FiValue = "fi"; + private const string FrValue = "fr"; + private const string FurValue = "fur"; + private const string GagValue = "gag"; + private const string GlValue = "gl"; + private const string DeValue = "de"; + private const string GilValue = "gil"; + private const string GonValue = "gon"; + private const string ElValue = "el"; + private const string KlValue = "kl"; + private const string GvrValue = "gvr"; + private const string HtValue = "ht"; + private const string HlbValue = "hlb"; + private const string HniValue = "hni"; + private const string BgcValue = "bgc"; + private const string HawValue = "haw"; + private const string HiValue = "hi"; + private const string MwwValue = "mww"; + private const string HocValue = "hoc"; + private const string HuValue = "hu"; + private const string IsValue = "is"; + private const string SmnValue = "smn"; + private const string IdValue = "id"; + private const string IaValue = "ia"; + private const string IuValue = "iu"; + private const string GaValue = "ga"; + private const string ItValue = "it"; + private const string JaValue = "ja"; + private const string JnsValue = "Jns"; + private const string JvValue = "jv"; + private const string KeaValue = "kea"; + private const string KacValue = "kac"; + private const string XnrValue = "xnr"; + private const string KrcValue = "krc"; + private const string KaaCyrlValue = "kaa-cyrl"; + private const string KaaValue = "kaa"; + private const string CsbValue = "csb"; + private const string KkCyrlValue = "kk-cyrl"; + private const string KkLatnValue = "kk-latn"; + private const string KlrValue = "klr"; + private const string KhaValue = "kha"; + private const string QucValue = "quc"; + private const string KoValue = "ko"; + private const string KfqValue = "kfq"; + private const string KpyValue = "kpy"; + private const string KosValue = "kos"; + private const string KumValue = "kum"; + private const string KuArabValue = "ku-arab"; + private const string KuLatnValue = "ku-latn"; + private const string KruValue = "kru"; + private const string KyValue = "ky"; + private const string LktValue = "lkt"; + private const string LaValue = "la"; + private const string LtValue = "lt"; + private const string DsbValue = "dsb"; + private const string SmjValue = "smj"; + private const string LbValue = "lb"; + private const string BfzValue = "bfz"; + private const string MsValue = "ms"; + private const string MtValue = "mt"; + private const string KmjValue = "kmj"; + private const string GvValue = "gv"; + private const string MiValue = "mi"; + private const string MrValue = "mr"; + private const string MnValue = "mn"; + private const string CnrCyrlValue = "cnr-cyrl"; + private const string CnrLatnValue = "cnr-latn"; + private const string NapValue = "nap"; + private const string NeValue = "ne"; + private const string NiuValue = "niu"; + private const string NogValue = "nog"; + private const string SmeValue = "sme"; + private const string NbValue = "nb"; + private const string NoValue = "no"; + private const string OcValue = "oc"; + private const string OsValue = "os"; + private const string PsValue = "ps"; + private const string FaValue = "fa"; + private const string PlValue = "pl"; + private const string PtValue = "pt"; + private const string PaValue = "pa"; + private const string KshValue = "ksh"; + private const string RoValue = "ro"; + private const string RmValue = "rm"; + private const string RuValue = "ru"; + private const string SckValue = "sck"; + private const string SmValue = "sm"; + private const string SaValue = "sa"; + private const string SatValue = "sat"; + private const string ScoValue = "sco"; + private const string GdValue = "gd"; + private const string SrValue = "sr"; + private const string SrCyrlValue = "sr-Cyrl"; + private const string SrLatnValue = "sr-Latn"; + private const string XsrValue = "xsr"; + private const string SrxValue = "srx"; + private const string SmsValue = "sms"; + private const string SkValue = "sk"; + private const string SlValue = "sl"; + private const string SoValue = "so"; + private const string SmaValue = "sma"; + private const string EsValue = "es"; + private const string SwValue = "sw"; + private const string SvValue = "sv"; + private const string TgValue = "tg"; + private const string TtValue = "tt"; + private const string TetValue = "tet"; + private const string ThfValue = "thf"; + private const string ToValue = "to"; + private const string TrValue = "tr"; + private const string TkValue = "tk"; + private const string TyvValue = "tyv"; + private const string HsbValue = "hsb"; + private const string UrValue = "ur"; + private const string UgValue = "ug"; + private const string UzArabValue = "uz-arab"; + private const string UzCyrlValue = "uz-cyrl"; + private const string UzValue = "uz"; + private const string VoValue = "vo"; + private const string WaeValue = "wae"; + private const string CyValue = "cy"; + private const string FyValue = "fy"; + private const string YuaValue = "yua"; + private const string ZaValue = "za"; + private const string ZuValue = "zu"; + private const string UnkValue = "unk"; + + /// Afrikaans. + public static OcrSkillLanguage Af { get; } = new OcrSkillLanguage(AfValue); + /// Albanian. + public static OcrSkillLanguage Sq { get; } = new OcrSkillLanguage(SqValue); + /// Angika (Devanagiri). + public static OcrSkillLanguage Anp { get; } = new OcrSkillLanguage(AnpValue); + /// Arabic. + public static OcrSkillLanguage Ar { get; } = new OcrSkillLanguage(ArValue); + /// Asturian. + public static OcrSkillLanguage Ast { get; } = new OcrSkillLanguage(AstValue); + /// Awadhi-Hindi (Devanagiri). + public static OcrSkillLanguage Awa { get; } = new OcrSkillLanguage(AwaValue); + /// Azerbaijani (Latin). + public static OcrSkillLanguage Az { get; } = new OcrSkillLanguage(AzValue); + /// Bagheli. + public static OcrSkillLanguage Bfy { get; } = new OcrSkillLanguage(BfyValue); + /// Basque. + public static OcrSkillLanguage Eu { get; } = new OcrSkillLanguage(EuValue); + /// Belarusian (Cyrillic and Latin). + public static OcrSkillLanguage Be { get; } = new OcrSkillLanguage(BeValue); + /// Belarusian (Cyrillic). + public static OcrSkillLanguage BeCyrl { get; } = new OcrSkillLanguage(BeCyrlValue); + /// Belarusian (Latin). + public static OcrSkillLanguage BeLatn { get; } = new OcrSkillLanguage(BeLatnValue); + /// Bhojpuri-Hindi (Devanagiri). + public static OcrSkillLanguage Bho { get; } = new OcrSkillLanguage(BhoValue); + /// Bislama. + public static OcrSkillLanguage Bi { get; } = new OcrSkillLanguage(BiValue); + /// Bodo (Devanagiri). + public static OcrSkillLanguage Brx { get; } = new OcrSkillLanguage(BrxValue); + /// Bosnian Latin. + public static OcrSkillLanguage Bs { get; } = new OcrSkillLanguage(BsValue); + /// Brajbha. + public static OcrSkillLanguage Bra { get; } = new OcrSkillLanguage(BraValue); + /// Breton. + public static OcrSkillLanguage Br { get; } = new OcrSkillLanguage(BrValue); + /// Bulgarian. + public static OcrSkillLanguage Bg { get; } = new OcrSkillLanguage(BgValue); + /// Bundeli. + public static OcrSkillLanguage Bns { get; } = new OcrSkillLanguage(BnsValue); + /// Buryat (Cyrillic). + public static OcrSkillLanguage Bua { get; } = new OcrSkillLanguage(BuaValue); + /// Catalan. + public static OcrSkillLanguage Ca { get; } = new OcrSkillLanguage(CaValue); + /// Cebuano. + public static OcrSkillLanguage Ceb { get; } = new OcrSkillLanguage(CebValue); + /// Chamling. + public static OcrSkillLanguage Rab { get; } = new OcrSkillLanguage(RabValue); + /// Chamorro. + public static OcrSkillLanguage Ch { get; } = new OcrSkillLanguage(ChValue); + /// Chhattisgarhi (Devanagiri). + public static OcrSkillLanguage Hne { get; } = new OcrSkillLanguage(HneValue); + /// Chinese Simplified. + public static OcrSkillLanguage ZhHans { get; } = new OcrSkillLanguage(ZhHansValue); + /// Chinese Traditional. + public static OcrSkillLanguage ZhHant { get; } = new OcrSkillLanguage(ZhHantValue); + /// Cornish. + public static OcrSkillLanguage Kw { get; } = new OcrSkillLanguage(KwValue); + /// Corsican. + public static OcrSkillLanguage Co { get; } = new OcrSkillLanguage(CoValue); + /// Crimean Tatar (Latin). + public static OcrSkillLanguage Crh { get; } = new OcrSkillLanguage(CrhValue); + /// Croatian. + public static OcrSkillLanguage Hr { get; } = new OcrSkillLanguage(HrValue); + /// Czech. + public static OcrSkillLanguage Cs { get; } = new OcrSkillLanguage(CsValue); + /// Danish. + public static OcrSkillLanguage Da { get; } = new OcrSkillLanguage(DaValue); + /// Dari. + public static OcrSkillLanguage Prs { get; } = new OcrSkillLanguage(PrsValue); + /// Dhimal (Devanagiri). + public static OcrSkillLanguage Dhi { get; } = new OcrSkillLanguage(DhiValue); + /// Dogri (Devanagiri). + public static OcrSkillLanguage Doi { get; } = new OcrSkillLanguage(DoiValue); + /// Dutch. + public static OcrSkillLanguage Nl { get; } = new OcrSkillLanguage(NlValue); + /// English. + public static OcrSkillLanguage En { get; } = new OcrSkillLanguage(EnValue); + /// Erzya (Cyrillic). + public static OcrSkillLanguage Myv { get; } = new OcrSkillLanguage(MyvValue); + /// Estonian. + public static OcrSkillLanguage Et { get; } = new OcrSkillLanguage(EtValue); + /// Faroese. + public static OcrSkillLanguage Fo { get; } = new OcrSkillLanguage(FoValue); + /// Fijian. + public static OcrSkillLanguage Fj { get; } = new OcrSkillLanguage(FjValue); + /// Filipino. + public static OcrSkillLanguage Fil { get; } = new OcrSkillLanguage(FilValue); + /// Finnish. + public static OcrSkillLanguage Fi { get; } = new OcrSkillLanguage(FiValue); + /// French. + public static OcrSkillLanguage Fr { get; } = new OcrSkillLanguage(FrValue); + /// Frulian. + public static OcrSkillLanguage Fur { get; } = new OcrSkillLanguage(FurValue); + /// Gagauz (Latin). + public static OcrSkillLanguage Gag { get; } = new OcrSkillLanguage(GagValue); + /// Galician. + public static OcrSkillLanguage Gl { get; } = new OcrSkillLanguage(GlValue); + /// German. + public static OcrSkillLanguage De { get; } = new OcrSkillLanguage(DeValue); + /// Gilbertese. + public static OcrSkillLanguage Gil { get; } = new OcrSkillLanguage(GilValue); + /// Gondi (Devanagiri). + public static OcrSkillLanguage Gon { get; } = new OcrSkillLanguage(GonValue); + /// Greek. + public static OcrSkillLanguage El { get; } = new OcrSkillLanguage(ElValue); + /// Greenlandic. + public static OcrSkillLanguage Kl { get; } = new OcrSkillLanguage(KlValue); + /// Gurung (Devanagiri). + public static OcrSkillLanguage Gvr { get; } = new OcrSkillLanguage(GvrValue); + /// Haitian Creole. + public static OcrSkillLanguage Ht { get; } = new OcrSkillLanguage(HtValue); + /// Halbi (Devanagiri). + public static OcrSkillLanguage Hlb { get; } = new OcrSkillLanguage(HlbValue); + /// Hani. + public static OcrSkillLanguage Hni { get; } = new OcrSkillLanguage(HniValue); + /// Haryanvi. + public static OcrSkillLanguage Bgc { get; } = new OcrSkillLanguage(BgcValue); + /// Hawaiian. + public static OcrSkillLanguage Haw { get; } = new OcrSkillLanguage(HawValue); + /// Hindi. + public static OcrSkillLanguage Hi { get; } = new OcrSkillLanguage(HiValue); + /// Hmong Daw (Latin). + public static OcrSkillLanguage Mww { get; } = new OcrSkillLanguage(MwwValue); + /// Ho (Devanagiri). + public static OcrSkillLanguage Hoc { get; } = new OcrSkillLanguage(HocValue); + /// Hungarian. + public static OcrSkillLanguage Hu { get; } = new OcrSkillLanguage(HuValue); + /// Icelandic. + public static OcrSkillLanguage Is { get; } = new OcrSkillLanguage(IsValue); + /// Inari Sami. + public static OcrSkillLanguage Smn { get; } = new OcrSkillLanguage(SmnValue); + /// Indonesian. + public static OcrSkillLanguage Id { get; } = new OcrSkillLanguage(IdValue); + /// Interlingua. + public static OcrSkillLanguage Ia { get; } = new OcrSkillLanguage(IaValue); + /// Inuktitut (Latin). + public static OcrSkillLanguage Iu { get; } = new OcrSkillLanguage(IuValue); + /// Irish. + public static OcrSkillLanguage Ga { get; } = new OcrSkillLanguage(GaValue); + /// Italian. + public static OcrSkillLanguage It { get; } = new OcrSkillLanguage(ItValue); + /// Japanese. + public static OcrSkillLanguage Ja { get; } = new OcrSkillLanguage(JaValue); + /// Jaunsari (Devanagiri). + public static OcrSkillLanguage Jns { get; } = new OcrSkillLanguage(JnsValue); + /// Javanese. + public static OcrSkillLanguage Jv { get; } = new OcrSkillLanguage(JvValue); + /// Kabuverdianu. + public static OcrSkillLanguage Kea { get; } = new OcrSkillLanguage(KeaValue); + /// Kachin (Latin). + public static OcrSkillLanguage Kac { get; } = new OcrSkillLanguage(KacValue); + /// Kangri (Devanagiri). + public static OcrSkillLanguage Xnr { get; } = new OcrSkillLanguage(XnrValue); + /// Karachay-Balkar. + public static OcrSkillLanguage Krc { get; } = new OcrSkillLanguage(KrcValue); + /// Kara-Kalpak (Cyrillic). + public static OcrSkillLanguage KaaCyrl { get; } = new OcrSkillLanguage(KaaCyrlValue); + /// Kara-Kalpak (Latin). + public static OcrSkillLanguage Kaa { get; } = new OcrSkillLanguage(KaaValue); + /// Kashubian. + public static OcrSkillLanguage Csb { get; } = new OcrSkillLanguage(CsbValue); + /// Kazakh (Cyrillic). + public static OcrSkillLanguage KkCyrl { get; } = new OcrSkillLanguage(KkCyrlValue); + /// Kazakh (Latin). + public static OcrSkillLanguage KkLatn { get; } = new OcrSkillLanguage(KkLatnValue); + /// Khaling. + public static OcrSkillLanguage Klr { get; } = new OcrSkillLanguage(KlrValue); + /// Khasi. + public static OcrSkillLanguage Kha { get; } = new OcrSkillLanguage(KhaValue); + /// K'iche'. + public static OcrSkillLanguage Quc { get; } = new OcrSkillLanguage(QucValue); + /// Korean. + public static OcrSkillLanguage Ko { get; } = new OcrSkillLanguage(KoValue); + /// Korku. + public static OcrSkillLanguage Kfq { get; } = new OcrSkillLanguage(KfqValue); + /// Koryak. + public static OcrSkillLanguage Kpy { get; } = new OcrSkillLanguage(KpyValue); + /// Kosraean. + public static OcrSkillLanguage Kos { get; } = new OcrSkillLanguage(KosValue); + /// Kumyk (Cyrillic). + public static OcrSkillLanguage Kum { get; } = new OcrSkillLanguage(KumValue); + /// Kurdish (Arabic). + public static OcrSkillLanguage KuArab { get; } = new OcrSkillLanguage(KuArabValue); + /// Kurdish (Latin). + public static OcrSkillLanguage KuLatn { get; } = new OcrSkillLanguage(KuLatnValue); + /// Kurukh (Devanagiri). + public static OcrSkillLanguage Kru { get; } = new OcrSkillLanguage(KruValue); + /// Kyrgyz (Cyrillic). + public static OcrSkillLanguage Ky { get; } = new OcrSkillLanguage(KyValue); + /// Lakota. + public static OcrSkillLanguage Lkt { get; } = new OcrSkillLanguage(LktValue); + /// Latin. + public static OcrSkillLanguage La { get; } = new OcrSkillLanguage(LaValue); + /// Lithuanian. + public static OcrSkillLanguage Lt { get; } = new OcrSkillLanguage(LtValue); + /// Lower Sorbian. + public static OcrSkillLanguage Dsb { get; } = new OcrSkillLanguage(DsbValue); + /// Lule Sami. + public static OcrSkillLanguage Smj { get; } = new OcrSkillLanguage(SmjValue); + /// Luxembourgish. + public static OcrSkillLanguage Lb { get; } = new OcrSkillLanguage(LbValue); + /// Mahasu Pahari (Devanagiri). + public static OcrSkillLanguage Bfz { get; } = new OcrSkillLanguage(BfzValue); + /// Malay (Latin). + public static OcrSkillLanguage Ms { get; } = new OcrSkillLanguage(MsValue); + /// Maltese. + public static OcrSkillLanguage Mt { get; } = new OcrSkillLanguage(MtValue); + /// Malto (Devanagiri). + public static OcrSkillLanguage Kmj { get; } = new OcrSkillLanguage(KmjValue); + /// Manx. + public static OcrSkillLanguage Gv { get; } = new OcrSkillLanguage(GvValue); + /// Maori. + public static OcrSkillLanguage Mi { get; } = new OcrSkillLanguage(MiValue); + /// Marathi. + public static OcrSkillLanguage Mr { get; } = new OcrSkillLanguage(MrValue); + /// Mongolian (Cyrillic). + public static OcrSkillLanguage Mn { get; } = new OcrSkillLanguage(MnValue); + /// Montenegrin (Cyrillic). + public static OcrSkillLanguage CnrCyrl { get; } = new OcrSkillLanguage(CnrCyrlValue); + /// Montenegrin (Latin). + public static OcrSkillLanguage CnrLatn { get; } = new OcrSkillLanguage(CnrLatnValue); + /// Neapolitan. + public static OcrSkillLanguage Nap { get; } = new OcrSkillLanguage(NapValue); + /// Nepali. + public static OcrSkillLanguage Ne { get; } = new OcrSkillLanguage(NeValue); + /// Niuean. + public static OcrSkillLanguage Niu { get; } = new OcrSkillLanguage(NiuValue); + /// Nogay. + public static OcrSkillLanguage Nog { get; } = new OcrSkillLanguage(NogValue); + /// Northern Sami (Latin). + public static OcrSkillLanguage Sme { get; } = new OcrSkillLanguage(SmeValue); + /// Norwegian. + public static OcrSkillLanguage Nb { get; } = new OcrSkillLanguage(NbValue); + /// Norwegian. + public static OcrSkillLanguage No { get; } = new OcrSkillLanguage(NoValue); + /// Occitan. + public static OcrSkillLanguage Oc { get; } = new OcrSkillLanguage(OcValue); + /// Ossetic. + public static OcrSkillLanguage Os { get; } = new OcrSkillLanguage(OsValue); + /// Pashto. + public static OcrSkillLanguage Ps { get; } = new OcrSkillLanguage(PsValue); + /// Persian. + public static OcrSkillLanguage Fa { get; } = new OcrSkillLanguage(FaValue); + /// Polish. + public static OcrSkillLanguage Pl { get; } = new OcrSkillLanguage(PlValue); + /// Portuguese. + public static OcrSkillLanguage Pt { get; } = new OcrSkillLanguage(PtValue); + /// Punjabi (Arabic). + public static OcrSkillLanguage Pa { get; } = new OcrSkillLanguage(PaValue); + /// Ripuarian. + public static OcrSkillLanguage Ksh { get; } = new OcrSkillLanguage(KshValue); + /// Romanian. + public static OcrSkillLanguage Ro { get; } = new OcrSkillLanguage(RoValue); + /// Romansh. + public static OcrSkillLanguage Rm { get; } = new OcrSkillLanguage(RmValue); + /// Russian. + public static OcrSkillLanguage Ru { get; } = new OcrSkillLanguage(RuValue); + /// Sadri (Devanagiri). + public static OcrSkillLanguage Sck { get; } = new OcrSkillLanguage(SckValue); + /// Samoan (Latin). + public static OcrSkillLanguage Sm { get; } = new OcrSkillLanguage(SmValue); + /// Sanskrit (Devanagiri). + public static OcrSkillLanguage Sa { get; } = new OcrSkillLanguage(SaValue); + /// Santali (Devanagiri). + public static OcrSkillLanguage Sat { get; } = new OcrSkillLanguage(SatValue); + /// Scots. + public static OcrSkillLanguage Sco { get; } = new OcrSkillLanguage(ScoValue); + /// Scottish Gaelic. + public static OcrSkillLanguage Gd { get; } = new OcrSkillLanguage(GdValue); + /// Serbian (Latin). + public static OcrSkillLanguage Sr { get; } = new OcrSkillLanguage(SrValue); + /// Serbian (Cyrillic). + public static OcrSkillLanguage SrCyrl { get; } = new OcrSkillLanguage(SrCyrlValue); + /// Serbian (Latin). + public static OcrSkillLanguage SrLatn { get; } = new OcrSkillLanguage(SrLatnValue); + /// Sherpa (Devanagiri). + public static OcrSkillLanguage Xsr { get; } = new OcrSkillLanguage(XsrValue); + /// Sirmauri (Devanagiri). + public static OcrSkillLanguage Srx { get; } = new OcrSkillLanguage(SrxValue); + /// Skolt Sami. + public static OcrSkillLanguage Sms { get; } = new OcrSkillLanguage(SmsValue); + /// Slovak. + public static OcrSkillLanguage Sk { get; } = new OcrSkillLanguage(SkValue); + /// Slovenian. + public static OcrSkillLanguage Sl { get; } = new OcrSkillLanguage(SlValue); + /// Somali (Arabic). + public static OcrSkillLanguage So { get; } = new OcrSkillLanguage(SoValue); + /// Southern Sami. + public static OcrSkillLanguage Sma { get; } = new OcrSkillLanguage(SmaValue); + /// Spanish. + public static OcrSkillLanguage Es { get; } = new OcrSkillLanguage(EsValue); + /// Swahili (Latin). + public static OcrSkillLanguage Sw { get; } = new OcrSkillLanguage(SwValue); + /// Swedish. + public static OcrSkillLanguage Sv { get; } = new OcrSkillLanguage(SvValue); + /// Tajik (Cyrillic). + public static OcrSkillLanguage Tg { get; } = new OcrSkillLanguage(TgValue); + /// Tatar (Latin). + public static OcrSkillLanguage Tt { get; } = new OcrSkillLanguage(TtValue); + /// Tetum. + public static OcrSkillLanguage Tet { get; } = new OcrSkillLanguage(TetValue); + /// Thangmi. + public static OcrSkillLanguage Thf { get; } = new OcrSkillLanguage(ThfValue); + /// Tongan. + public static OcrSkillLanguage To { get; } = new OcrSkillLanguage(ToValue); + /// Turkish. + public static OcrSkillLanguage Tr { get; } = new OcrSkillLanguage(TrValue); + /// Turkmen (Latin). + public static OcrSkillLanguage Tk { get; } = new OcrSkillLanguage(TkValue); + /// Tuvan. + public static OcrSkillLanguage Tyv { get; } = new OcrSkillLanguage(TyvValue); + /// Upper Sorbian. + public static OcrSkillLanguage Hsb { get; } = new OcrSkillLanguage(HsbValue); + /// Urdu. + public static OcrSkillLanguage Ur { get; } = new OcrSkillLanguage(UrValue); + /// Uyghur (Arabic). + public static OcrSkillLanguage Ug { get; } = new OcrSkillLanguage(UgValue); + /// Uzbek (Arabic). + public static OcrSkillLanguage UzArab { get; } = new OcrSkillLanguage(UzArabValue); + /// Uzbek (Cyrillic). + public static OcrSkillLanguage UzCyrl { get; } = new OcrSkillLanguage(UzCyrlValue); + /// Uzbek (Latin). + public static OcrSkillLanguage Uz { get; } = new OcrSkillLanguage(UzValue); + /// Volapük. + public static OcrSkillLanguage Vo { get; } = new OcrSkillLanguage(VoValue); + /// Walser. + public static OcrSkillLanguage Wae { get; } = new OcrSkillLanguage(WaeValue); + /// Welsh. + public static OcrSkillLanguage Cy { get; } = new OcrSkillLanguage(CyValue); + /// Western Frisian. + public static OcrSkillLanguage Fy { get; } = new OcrSkillLanguage(FyValue); + /// Yucatec Maya. + public static OcrSkillLanguage Yua { get; } = new OcrSkillLanguage(YuaValue); + /// Zhuang. + public static OcrSkillLanguage Za { get; } = new OcrSkillLanguage(ZaValue); + /// Zulu. + public static OcrSkillLanguage Zu { get; } = new OcrSkillLanguage(ZuValue); + /// Unknown (All). + public static OcrSkillLanguage Unk { get; } = new OcrSkillLanguage(UnkValue); + /// Determines if two values are the same. + public static bool operator ==(OcrSkillLanguage left, OcrSkillLanguage right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(OcrSkillLanguage left, OcrSkillLanguage right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator OcrSkillLanguage(string value) => new OcrSkillLanguage(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is OcrSkillLanguage other && Equals(other); + /// + public bool Equals(OcrSkillLanguage other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OutputFieldMappingEntry.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OutputFieldMappingEntry.Serialization.cs new file mode 100644 index 000000000000..b20162f8b85e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OutputFieldMappingEntry.Serialization.cs @@ -0,0 +1,153 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class OutputFieldMappingEntry : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(OutputFieldMappingEntry)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + if (Optional.IsDefined(TargetName)) + { + writer.WritePropertyName("targetName"u8); + writer.WriteStringValue(TargetName); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + OutputFieldMappingEntry IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(OutputFieldMappingEntry)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeOutputFieldMappingEntry(document.RootElement, options); + } + + internal static OutputFieldMappingEntry DeserializeOutputFieldMappingEntry(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + string targetName = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("targetName"u8)) + { + targetName = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new OutputFieldMappingEntry(name, targetName, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(OutputFieldMappingEntry)} does not support writing '{options.Format}' format."); + } + } + + OutputFieldMappingEntry IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeOutputFieldMappingEntry(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(OutputFieldMappingEntry)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static OutputFieldMappingEntry FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeOutputFieldMappingEntry(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OutputFieldMappingEntry.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OutputFieldMappingEntry.cs new file mode 100644 index 000000000000..9f63f77249d8 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/OutputFieldMappingEntry.cs @@ -0,0 +1,79 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Output field mapping for a skill. + public partial class OutputFieldMappingEntry + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name of the output defined by the skill. + /// is null. + public OutputFieldMappingEntry(string name) + { + Argument.AssertNotNull(name, nameof(name)); + + Name = name; + } + + /// Initializes a new instance of . + /// The name of the output defined by the skill. + /// The target name of the output. It is optional and default to name. + /// Keeps track of any properties unknown to the library. + internal OutputFieldMappingEntry(string name, string targetName, IDictionary serializedAdditionalRawData) + { + Name = name; + TargetName = targetName; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal OutputFieldMappingEntry() + { + } + + /// The name of the output defined by the skill. + public string Name { get; set; } + /// The target name of the output. It is optional and default to name. + public string TargetName { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PIIDetectionSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PIIDetectionSkill.Serialization.cs new file mode 100644 index 000000000000..8c7f71712614 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PIIDetectionSkill.Serialization.cs @@ -0,0 +1,279 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class PIIDetectionSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PIIDetectionSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(DefaultLanguageCode)) + { + writer.WritePropertyName("defaultLanguageCode"u8); + writer.WriteStringValue(DefaultLanguageCode); + } + if (Optional.IsDefined(MinimumPrecision)) + { + writer.WritePropertyName("minimumPrecision"u8); + writer.WriteNumberValue(MinimumPrecision.Value); + } + if (Optional.IsDefined(MaskingMode)) + { + writer.WritePropertyName("maskingMode"u8); + writer.WriteStringValue(MaskingMode.Value.ToString()); + } + if (Optional.IsDefined(MaskingCharacter)) + { + writer.WritePropertyName("maskingCharacter"u8); + writer.WriteStringValue(MaskingCharacter); + } + if (Optional.IsDefined(ModelVersion)) + { + writer.WritePropertyName("modelVersion"u8); + writer.WriteStringValue(ModelVersion); + } + if (Optional.IsCollectionDefined(PiiCategories)) + { + writer.WritePropertyName("piiCategories"u8); + writer.WriteStartArray(); + foreach (var item in PiiCategories) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + if (Optional.IsDefined(Domain)) + { + writer.WritePropertyName("domain"u8); + writer.WriteStringValue(Domain); + } + } + + PIIDetectionSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PIIDetectionSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializePIIDetectionSkill(document.RootElement, options); + } + + internal static PIIDetectionSkill DeserializePIIDetectionSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string defaultLanguageCode = default; + double? minimumPrecision = default; + PIIDetectionSkillMaskingMode? maskingMode = default; + string maskingCharacter = default; + string modelVersion = default; + IList piiCategories = default; + string domain = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("defaultLanguageCode"u8)) + { + defaultLanguageCode = property.Value.GetString(); + continue; + } + if (property.NameEquals("minimumPrecision"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + minimumPrecision = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("maskingMode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maskingMode = new PIIDetectionSkillMaskingMode(property.Value.GetString()); + continue; + } + if (property.NameEquals("maskingCharacter"u8)) + { + maskingCharacter = property.Value.GetString(); + continue; + } + if (property.NameEquals("modelVersion"u8)) + { + modelVersion = property.Value.GetString(); + continue; + } + if (property.NameEquals("piiCategories"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + piiCategories = array; + continue; + } + if (property.NameEquals("domain"u8)) + { + domain = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new PIIDetectionSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + defaultLanguageCode, + minimumPrecision, + maskingMode, + maskingCharacter, + modelVersion, + piiCategories ?? new ChangeTrackingList(), + domain); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(PIIDetectionSkill)} does not support writing '{options.Format}' format."); + } + } + + PIIDetectionSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePIIDetectionSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(PIIDetectionSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new PIIDetectionSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePIIDetectionSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PIIDetectionSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PIIDetectionSkill.cs new file mode 100644 index 000000000000..121ad0ba4f5d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PIIDetectionSkill.cs @@ -0,0 +1,135 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Using the Text Analytics API, extracts personal information from an input text + /// and gives you the option of masking it. + /// + public partial class PIIDetectionSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public PIIDetectionSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Text.PIIDetectionSkill"; + PiiCategories = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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 '*'. + /// + /// + /// 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. + /// + /// A list of PII entity categories that should be extracted and masked. + /// + /// If specified, will set the PII domain to include only a subset of the entity + /// categories. Possible values include: 'phi', 'none'. Default is 'none'. + /// + internal PIIDetectionSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData, string defaultLanguageCode, double? minimumPrecision, PIIDetectionSkillMaskingMode? maskingMode, string maskingCharacter, string modelVersion, IList piiCategories, string domain) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + DefaultLanguageCode = defaultLanguageCode; + MinimumPrecision = minimumPrecision; + MaskingMode = maskingMode; + MaskingCharacter = maskingCharacter; + ModelVersion = modelVersion; + PiiCategories = piiCategories; + Domain = domain; + } + + /// Initializes a new instance of for deserialization. + internal PIIDetectionSkill() + { + } + + /// 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; } + /// + /// A parameter that provides various ways to mask the personal information + /// detected in the input text. Default is 'none'. + /// + public PIIDetectionSkillMaskingMode? MaskingMode { get; set; } + /// + /// The character used to mask the text if the maskingMode parameter is set to + /// replace. Default is '*'. + /// + public string MaskingCharacter { 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. + /// + public string ModelVersion { get; set; } + /// A list of PII entity categories that should be extracted and masked. + public IList PiiCategories { get; } + /// + /// If specified, will set the PII domain to include only a subset of the entity + /// categories. Possible values include: 'phi', 'none'. Default is 'none'. + /// + public string Domain { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PIIDetectionSkillMaskingMode.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PIIDetectionSkillMaskingMode.cs new file mode 100644 index 000000000000..32385b6e80cb --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PIIDetectionSkillMaskingMode.cs @@ -0,0 +1,59 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A string indicating what maskingMode to use to mask the personal information + /// detected in the input text. + /// + public readonly partial struct PIIDetectionSkillMaskingMode : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public PIIDetectionSkillMaskingMode(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string NoneValue = "none"; + private const string ReplaceValue = "replace"; + + /// No masking occurs and the maskedText output will not be returned. + public static PIIDetectionSkillMaskingMode None { get; } = new PIIDetectionSkillMaskingMode(NoneValue); + /// + /// Replaces the detected entities with the character given in the maskingCharacter + /// parameter. The character will be repeated to the length of the detected entity + /// so that the offsets will correctly correspond to both the input text as well as + /// the output maskedText. + /// + public static PIIDetectionSkillMaskingMode Replace { get; } = new PIIDetectionSkillMaskingMode(ReplaceValue); + /// Determines if two values are the same. + public static bool operator ==(PIIDetectionSkillMaskingMode left, PIIDetectionSkillMaskingMode right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(PIIDetectionSkillMaskingMode left, PIIDetectionSkillMaskingMode right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator PIIDetectionSkillMaskingMode(string value) => new PIIDetectionSkillMaskingMode(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is PIIDetectionSkillMaskingMode other && Equals(other); + /// + public bool Equals(PIIDetectionSkillMaskingMode other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PathHierarchyTokenizerV2.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PathHierarchyTokenizerV2.Serialization.cs new file mode 100644 index 000000000000..67ba8b45ccf9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PathHierarchyTokenizerV2.Serialization.cs @@ -0,0 +1,207 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class PathHierarchyTokenizerV2 : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PathHierarchyTokenizerV2)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(Delimiter)) + { + writer.WritePropertyName("delimiter"u8); + writer.WriteStringValue(Delimiter); + } + if (Optional.IsDefined(Replacement)) + { + writer.WritePropertyName("replacement"u8); + writer.WriteStringValue(Replacement); + } + if (Optional.IsDefined(MaxTokenLength)) + { + writer.WritePropertyName("maxTokenLength"u8); + writer.WriteNumberValue(MaxTokenLength.Value); + } + if (Optional.IsDefined(Reverse)) + { + writer.WritePropertyName("reverse"u8); + writer.WriteBooleanValue(Reverse.Value); + } + if (Optional.IsDefined(Skip)) + { + writer.WritePropertyName("skip"u8); + writer.WriteNumberValue(Skip.Value); + } + } + + PathHierarchyTokenizerV2 IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PathHierarchyTokenizerV2)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializePathHierarchyTokenizerV2(document.RootElement, options); + } + + internal static PathHierarchyTokenizerV2 DeserializePathHierarchyTokenizerV2(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string delimiter = default; + string replacement = default; + int? maxTokenLength = default; + bool? reverse = default; + int? skip = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("delimiter"u8)) + { + delimiter = property.Value.GetString(); + continue; + } + if (property.NameEquals("replacement"u8)) + { + replacement = property.Value.GetString(); + continue; + } + if (property.NameEquals("maxTokenLength"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxTokenLength = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("reverse"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + reverse = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("skip"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + skip = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new PathHierarchyTokenizerV2( + odataType, + name, + serializedAdditionalRawData, + delimiter, + replacement, + maxTokenLength, + reverse, + skip); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(PathHierarchyTokenizerV2)} does not support writing '{options.Format}' format."); + } + } + + PathHierarchyTokenizerV2 IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePathHierarchyTokenizerV2(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(PathHierarchyTokenizerV2)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new PathHierarchyTokenizerV2 FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePathHierarchyTokenizerV2(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PathHierarchyTokenizerV2.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PathHierarchyTokenizerV2.cs new file mode 100644 index 000000000000..db1c889e92e3 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PathHierarchyTokenizerV2.cs @@ -0,0 +1,77 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache + /// Lucene. + /// + public partial class PathHierarchyTokenizerV2 : LexicalTokenizer + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public PathHierarchyTokenizerV2(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.PathHierarchyTokenizerV2"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// The delimiter character to use. Default is "/". + /// A value that, if set, replaces the delimiter character. Default is "/". + /// The maximum token length. Default and maximum is 300. + /// + /// A value indicating whether to generate tokens in reverse order. Default is + /// false. + /// + /// The number of initial tokens to skip. Default is 0. + internal PathHierarchyTokenizerV2(string odataType, string name, IDictionary serializedAdditionalRawData, string delimiter, string replacement, int? maxTokenLength, bool? reverse, int? skip) : base(odataType, name, serializedAdditionalRawData) + { + Delimiter = delimiter; + Replacement = replacement; + MaxTokenLength = maxTokenLength; + Reverse = reverse; + Skip = skip; + } + + /// Initializes a new instance of for deserialization. + internal PathHierarchyTokenizerV2() + { + } + + /// The delimiter character to use. Default is "/". + public string Delimiter { get; set; } + /// A value that, if set, replaces the delimiter character. Default is "/". + public string Replacement { get; set; } + /// The maximum token length. Default and maximum is 300. + public int? MaxTokenLength { get; set; } + /// + /// A value indicating whether to generate tokens in reverse order. Default is + /// false. + /// + public bool? Reverse { get; set; } + /// The number of initial tokens to skip. Default is 0. + public int? Skip { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternAnalyzer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternAnalyzer.Serialization.cs new file mode 100644 index 000000000000..9c6ee182ce11 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternAnalyzer.Serialization.cs @@ -0,0 +1,205 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class PatternAnalyzer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PatternAnalyzer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(Lowercase)) + { + writer.WritePropertyName("lowercase"u8); + writer.WriteBooleanValue(Lowercase.Value); + } + if (Optional.IsDefined(Pattern)) + { + writer.WritePropertyName("pattern"u8); + writer.WriteStringValue(Pattern); + } + if (Optional.IsDefined(Flags)) + { + writer.WritePropertyName("flags"u8); + writer.WriteStringValue(Flags.Value.ToString()); + } + if (Optional.IsCollectionDefined(Stopwords)) + { + writer.WritePropertyName("stopwords"u8); + writer.WriteStartArray(); + foreach (var item in Stopwords) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + } + + PatternAnalyzer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PatternAnalyzer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializePatternAnalyzer(document.RootElement, options); + } + + internal static PatternAnalyzer DeserializePatternAnalyzer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + bool? lowercase = default; + string pattern = default; + RegexFlags? flags = default; + IList stopwords = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("lowercase"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + lowercase = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("pattern"u8)) + { + pattern = property.Value.GetString(); + continue; + } + if (property.NameEquals("flags"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + flags = new RegexFlags(property.Value.GetString()); + continue; + } + if (property.NameEquals("stopwords"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + stopwords = array; + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new PatternAnalyzer( + odataType, + name, + serializedAdditionalRawData, + lowercase, + pattern, + flags, + stopwords ?? new ChangeTrackingList()); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(PatternAnalyzer)} does not support writing '{options.Format}' format."); + } + } + + PatternAnalyzer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePatternAnalyzer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(PatternAnalyzer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new PatternAnalyzer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePatternAnalyzer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternAnalyzer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternAnalyzer.cs new file mode 100644 index 000000000000..65deaf628cbf --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternAnalyzer.cs @@ -0,0 +1,74 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Flexibly separates text into terms via a regular expression pattern. This + /// analyzer is implemented using Apache Lucene. + /// + public partial class PatternAnalyzer : LexicalAnalyzer + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public PatternAnalyzer(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.PatternAnalyzer"; + Stopwords = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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. + /// + /// Regular expression flags. + /// A list of stopwords. + internal PatternAnalyzer(string odataType, string name, IDictionary serializedAdditionalRawData, bool? lowercase, string pattern, RegexFlags? flags, IList stopwords) : base(odataType, name, serializedAdditionalRawData) + { + Lowercase = lowercase; + Pattern = pattern; + Flags = flags; + Stopwords = stopwords; + } + + /// Initializes a new instance of for deserialization. + internal PatternAnalyzer() + { + } + + /// A value indicating whether terms should be lower-cased. Default is true. + public bool? Lowercase { get; set; } + /// + /// A regular expression pattern to match token separators. Default is an + /// expression that matches one or more non-word characters. + /// + public string Pattern { get; set; } + /// Regular expression flags. + public RegexFlags? Flags { get; set; } + /// A list of stopwords. + public IList Stopwords { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternCaptureTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternCaptureTokenFilter.Serialization.cs new file mode 100644 index 000000000000..cc2f17c1717e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternCaptureTokenFilter.Serialization.cs @@ -0,0 +1,165 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class PatternCaptureTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PatternCaptureTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("patterns"u8); + writer.WriteStartArray(); + foreach (var item in Patterns) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + if (Optional.IsDefined(PreserveOriginal)) + { + writer.WritePropertyName("preserveOriginal"u8); + writer.WriteBooleanValue(PreserveOriginal.Value); + } + } + + PatternCaptureTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PatternCaptureTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializePatternCaptureTokenFilter(document.RootElement, options); + } + + internal static PatternCaptureTokenFilter DeserializePatternCaptureTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList patterns = default; + bool? preserveOriginal = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("patterns"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + patterns = array; + continue; + } + if (property.NameEquals("preserveOriginal"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + preserveOriginal = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new PatternCaptureTokenFilter(odataType, name, serializedAdditionalRawData, patterns, preserveOriginal); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(PatternCaptureTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + PatternCaptureTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePatternCaptureTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(PatternCaptureTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new PatternCaptureTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePatternCaptureTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternCaptureTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternCaptureTokenFilter.cs new file mode 100644 index 000000000000..4771c91a1332 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternCaptureTokenFilter.cs @@ -0,0 +1,69 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Uses Java regexes to emit multiple tokens - one for each capture group in one + /// or more patterns. This token filter is implemented using Apache Lucene. + /// + public partial class PatternCaptureTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// or is null. + public PatternCaptureTokenFilter(string name, IEnumerable patterns) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(patterns, nameof(patterns)); + + OdataType = "#Microsoft.Azure.Search.PatternCaptureTokenFilter"; + Patterns = patterns.ToList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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. + /// + internal PatternCaptureTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, IList patterns, bool? preserveOriginal) : base(odataType, name, serializedAdditionalRawData) + { + Patterns = patterns; + PreserveOriginal = preserveOriginal; + } + + /// Initializes a new instance of for deserialization. + internal PatternCaptureTokenFilter() + { + } + + /// A list of patterns to match against each token. + public IList Patterns { get; } + /// + /// A value indicating whether to return the original token even if one of the + /// patterns matches. Default is true. + /// + public bool? PreserveOriginal { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternReplaceCharFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternReplaceCharFilter.Serialization.cs new file mode 100644 index 000000000000..a2248698ef48 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternReplaceCharFilter.Serialization.cs @@ -0,0 +1,148 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class PatternReplaceCharFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PatternReplaceCharFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("pattern"u8); + writer.WriteStringValue(Pattern); + writer.WritePropertyName("replacement"u8); + writer.WriteStringValue(Replacement); + } + + PatternReplaceCharFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PatternReplaceCharFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializePatternReplaceCharFilter(document.RootElement, options); + } + + internal static PatternReplaceCharFilter DeserializePatternReplaceCharFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string pattern = default; + string replacement = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("pattern"u8)) + { + pattern = property.Value.GetString(); + continue; + } + if (property.NameEquals("replacement"u8)) + { + replacement = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new PatternReplaceCharFilter(odataType, name, serializedAdditionalRawData, pattern, replacement); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(PatternReplaceCharFilter)} does not support writing '{options.Format}' format."); + } + } + + PatternReplaceCharFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePatternReplaceCharFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(PatternReplaceCharFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new PatternReplaceCharFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePatternReplaceCharFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternReplaceCharFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternReplaceCharFilter.cs new file mode 100644 index 000000000000..96a43da815ad --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternReplaceCharFilter.cs @@ -0,0 +1,69 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A character filter that replaces characters in the input string. It uses a + /// regular expression to identify character sequences to preserve and a + /// replacement pattern to identify characters to replace. For example, given the + /// input text "aa bb aa bb", pattern "(aa)\s+(bb)", and replacement "$1#$2", the + /// result would be "aa#bb aa#bb". This character filter is implemented using + /// Apache Lucene. + /// + public partial class PatternReplaceCharFilter : CharFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// , or is null. + public PatternReplaceCharFilter(string name, string pattern, string replacement) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(pattern, nameof(pattern)); + Argument.AssertNotNull(replacement, nameof(replacement)); + + OdataType = "#Microsoft.Azure.Search.PatternReplaceCharFilter"; + Pattern = pattern; + Replacement = replacement; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// A regular expression pattern. + /// The replacement text. + internal PatternReplaceCharFilter(string odataType, string name, IDictionary serializedAdditionalRawData, string pattern, string replacement) : base(odataType, name, serializedAdditionalRawData) + { + Pattern = pattern; + Replacement = replacement; + } + + /// Initializes a new instance of for deserialization. + internal PatternReplaceCharFilter() + { + } + + /// A regular expression pattern. + public string Pattern { get; set; } + /// The replacement text. + public string Replacement { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternReplaceTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternReplaceTokenFilter.Serialization.cs new file mode 100644 index 000000000000..3a33bb4314fa --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternReplaceTokenFilter.Serialization.cs @@ -0,0 +1,148 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class PatternReplaceTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PatternReplaceTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("pattern"u8); + writer.WriteStringValue(Pattern); + writer.WritePropertyName("replacement"u8); + writer.WriteStringValue(Replacement); + } + + PatternReplaceTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PatternReplaceTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializePatternReplaceTokenFilter(document.RootElement, options); + } + + internal static PatternReplaceTokenFilter DeserializePatternReplaceTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string pattern = default; + string replacement = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("pattern"u8)) + { + pattern = property.Value.GetString(); + continue; + } + if (property.NameEquals("replacement"u8)) + { + replacement = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new PatternReplaceTokenFilter(odataType, name, serializedAdditionalRawData, pattern, replacement); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(PatternReplaceTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + PatternReplaceTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePatternReplaceTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(PatternReplaceTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new PatternReplaceTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePatternReplaceTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternReplaceTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternReplaceTokenFilter.cs new file mode 100644 index 000000000000..d8b1cf932f6b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternReplaceTokenFilter.cs @@ -0,0 +1,69 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A character filter that replaces characters in the input string. It uses a + /// regular expression to identify character sequences to preserve and a + /// replacement pattern to identify characters to replace. For example, given the + /// input text "aa bb aa bb", pattern "(aa)\s+(bb)", and replacement "$1#$2", the + /// result would be "aa#bb aa#bb". This token filter is implemented using Apache + /// Lucene. + /// + public partial class PatternReplaceTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// , or is null. + public PatternReplaceTokenFilter(string name, string pattern, string replacement) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(pattern, nameof(pattern)); + Argument.AssertNotNull(replacement, nameof(replacement)); + + OdataType = "#Microsoft.Azure.Search.PatternReplaceTokenFilter"; + Pattern = pattern; + Replacement = replacement; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// A regular expression pattern. + /// The replacement text. + internal PatternReplaceTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, string pattern, string replacement) : base(odataType, name, serializedAdditionalRawData) + { + Pattern = pattern; + Replacement = replacement; + } + + /// Initializes a new instance of for deserialization. + internal PatternReplaceTokenFilter() + { + } + + /// A regular expression pattern. + public string Pattern { get; set; } + /// The replacement text. + public string Replacement { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternTokenizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternTokenizer.Serialization.cs new file mode 100644 index 000000000000..19d18ea3fe4d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternTokenizer.Serialization.cs @@ -0,0 +1,179 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class PatternTokenizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PatternTokenizer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(Pattern)) + { + writer.WritePropertyName("pattern"u8); + writer.WriteStringValue(Pattern); + } + if (Optional.IsDefined(Flags)) + { + writer.WritePropertyName("flags"u8); + writer.WriteStringValue(Flags.Value.ToString()); + } + if (Optional.IsDefined(Group)) + { + writer.WritePropertyName("group"u8); + writer.WriteNumberValue(Group.Value); + } + } + + PatternTokenizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PatternTokenizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializePatternTokenizer(document.RootElement, options); + } + + internal static PatternTokenizer DeserializePatternTokenizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string pattern = default; + RegexFlags? flags = default; + int? group = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("pattern"u8)) + { + pattern = property.Value.GetString(); + continue; + } + if (property.NameEquals("flags"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + flags = new RegexFlags(property.Value.GetString()); + continue; + } + if (property.NameEquals("group"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + group = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new PatternTokenizer( + odataType, + name, + serializedAdditionalRawData, + pattern, + flags, + group); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(PatternTokenizer)} does not support writing '{options.Format}' format."); + } + } + + PatternTokenizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePatternTokenizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(PatternTokenizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new PatternTokenizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePatternTokenizer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternTokenizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternTokenizer.cs new file mode 100644 index 000000000000..fd883fc409e7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PatternTokenizer.cs @@ -0,0 +1,77 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Tokenizer that uses regex pattern matching to construct distinct tokens. This + /// tokenizer is implemented using Apache Lucene. + /// + public partial class PatternTokenizer : LexicalTokenizer + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public PatternTokenizer(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.PatternTokenizer"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// A regular expression pattern to match token separators. Default is an + /// expression that matches one or more non-word characters. + /// + /// Regular expression flags. + /// + /// The zero-based ordinal of the matching group in the regular expression pattern + /// to extract into tokens. Use -1 if you want to use the entire pattern to split + /// the input into tokens, irrespective of matching groups. Default is -1. + /// + internal PatternTokenizer(string odataType, string name, IDictionary serializedAdditionalRawData, string pattern, RegexFlags? flags, int? group) : base(odataType, name, serializedAdditionalRawData) + { + Pattern = pattern; + Flags = flags; + Group = group; + } + + /// Initializes a new instance of for deserialization. + internal PatternTokenizer() + { + } + + /// + /// A regular expression pattern to match token separators. Default is an + /// expression that matches one or more non-word characters. + /// + public string Pattern { get; set; } + /// Regular expression flags. + public RegexFlags? Flags { get; set; } + /// + /// The zero-based ordinal of the matching group in the regular expression pattern + /// to extract into tokens. Use -1 if you want to use the entire pattern to split + /// the input into tokens, irrespective of matching groups. Default is -1. + /// + public int? Group { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PhoneticEncoder.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PhoneticEncoder.cs new file mode 100644 index 000000000000..6d4ff3d34e05 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PhoneticEncoder.cs @@ -0,0 +1,78 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Identifies the type of phonetic encoder to use with a PhoneticTokenFilter. + public readonly partial struct PhoneticEncoder : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public PhoneticEncoder(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string MetaphoneValue = "metaphone"; + private const string DoubleMetaphoneValue = "doubleMetaphone"; + private const string SoundexValue = "soundex"; + private const string RefinedSoundexValue = "refinedSoundex"; + private const string Caverphone1Value = "caverphone1"; + private const string Caverphone2Value = "caverphone2"; + private const string CologneValue = "cologne"; + private const string NysiisValue = "nysiis"; + private const string KoelnerPhonetikValue = "koelnerPhonetik"; + private const string HaasePhonetikValue = "haasePhonetik"; + private const string BeiderMorseValue = "beiderMorse"; + + /// Encodes a token into a Metaphone value. + public static PhoneticEncoder Metaphone { get; } = new PhoneticEncoder(MetaphoneValue); + /// Encodes a token into a double metaphone value. + public static PhoneticEncoder DoubleMetaphone { get; } = new PhoneticEncoder(DoubleMetaphoneValue); + /// Encodes a token into a Soundex value. + public static PhoneticEncoder Soundex { get; } = new PhoneticEncoder(SoundexValue); + /// Encodes a token into a Refined Soundex value. + public static PhoneticEncoder RefinedSoundex { get; } = new PhoneticEncoder(RefinedSoundexValue); + /// Encodes a token into a Caverphone 1.0 value. + public static PhoneticEncoder Caverphone1 { get; } = new PhoneticEncoder(Caverphone1Value); + /// Encodes a token into a Caverphone 2.0 value. + public static PhoneticEncoder Caverphone2 { get; } = new PhoneticEncoder(Caverphone2Value); + /// Encodes a token into a Cologne Phonetic value. + public static PhoneticEncoder Cologne { get; } = new PhoneticEncoder(CologneValue); + /// Encodes a token into a NYSIIS value. + public static PhoneticEncoder Nysiis { get; } = new PhoneticEncoder(NysiisValue); + /// Encodes a token using the Kölner Phonetik algorithm. + public static PhoneticEncoder KoelnerPhonetik { get; } = new PhoneticEncoder(KoelnerPhonetikValue); + /// Encodes a token using the Haase refinement of the Kölner Phonetik algorithm. + public static PhoneticEncoder HaasePhonetik { get; } = new PhoneticEncoder(HaasePhonetikValue); + /// Encodes a token into a Beider-Morse value. + public static PhoneticEncoder BeiderMorse { get; } = new PhoneticEncoder(BeiderMorseValue); + /// Determines if two values are the same. + public static bool operator ==(PhoneticEncoder left, PhoneticEncoder right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(PhoneticEncoder left, PhoneticEncoder right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator PhoneticEncoder(string value) => new PhoneticEncoder(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is PhoneticEncoder other && Equals(other); + /// + public bool Equals(PhoneticEncoder other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PhoneticTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PhoneticTokenFilter.Serialization.cs new file mode 100644 index 000000000000..8158fb410af1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PhoneticTokenFilter.Serialization.cs @@ -0,0 +1,162 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class PhoneticTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PhoneticTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(Encoder)) + { + writer.WritePropertyName("encoder"u8); + writer.WriteStringValue(Encoder.Value.ToString()); + } + if (Optional.IsDefined(Replace)) + { + writer.WritePropertyName("replace"u8); + writer.WriteBooleanValue(Replace.Value); + } + } + + PhoneticTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(PhoneticTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializePhoneticTokenFilter(document.RootElement, options); + } + + internal static PhoneticTokenFilter DeserializePhoneticTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + PhoneticEncoder? encoder = default; + bool? replace = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("encoder"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + encoder = new PhoneticEncoder(property.Value.GetString()); + continue; + } + if (property.NameEquals("replace"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + replace = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new PhoneticTokenFilter(odataType, name, serializedAdditionalRawData, encoder, replace); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(PhoneticTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + PhoneticTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePhoneticTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(PhoneticTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new PhoneticTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializePhoneticTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PhoneticTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PhoneticTokenFilter.cs new file mode 100644 index 000000000000..72aa20d6b38b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/PhoneticTokenFilter.cs @@ -0,0 +1,65 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Create tokens for phonetic matches. This token filter is implemented using + /// Apache Lucene. + /// + public partial class PhoneticTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public PhoneticTokenFilter(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.PhoneticTokenFilter"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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. + /// + internal PhoneticTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, PhoneticEncoder? encoder, bool? replace) : base(odataType, name, serializedAdditionalRawData) + { + Encoder = encoder; + Replace = replace; + } + + /// Initializes a new instance of for deserialization. + internal PhoneticTokenFilter() + { + } + + /// The phonetic encoder to use. Default is "metaphone". + public PhoneticEncoder? Encoder { get; set; } + /// + /// A value indicating whether encoded tokens should replace original tokens. If + /// false, encoded tokens are added as synonyms. Default is true. + /// + public bool? Replace { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/RegexFlags.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/RegexFlags.cs new file mode 100644 index 000000000000..a79102150fca --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/RegexFlags.cs @@ -0,0 +1,72 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Defines flags that can be combined to control how regular expressions are used + /// in the pattern analyzer and pattern tokenizer. + /// + public readonly partial struct RegexFlags : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public RegexFlags(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string CanonEqValue = "CANON_EQ"; + private const string CaseInsensitiveValue = "CASE_INSENSITIVE"; + private const string CommentsValue = "COMMENTS"; + private const string DotAllValue = "DOTALL"; + private const string LiteralValue = "LITERAL"; + private const string MultilineValue = "MULTILINE"; + private const string UnicodeCaseValue = "UNICODE_CASE"; + private const string UnixLinesValue = "UNIX_LINES"; + + /// Enables canonical equivalence. + public static RegexFlags CanonEq { get; } = new RegexFlags(CanonEqValue); + /// Enables case-insensitive matching. + public static RegexFlags CaseInsensitive { get; } = new RegexFlags(CaseInsensitiveValue); + /// Permits whitespace and comments in the pattern. + public static RegexFlags Comments { get; } = new RegexFlags(CommentsValue); + /// Enables dotall mode. + public static RegexFlags DotAll { get; } = new RegexFlags(DotAllValue); + /// Enables literal parsing of the pattern. + public static RegexFlags Literal { get; } = new RegexFlags(LiteralValue); + /// Enables multiline mode. + public static RegexFlags Multiline { get; } = new RegexFlags(MultilineValue); + /// Enables Unicode-aware case folding. + public static RegexFlags UnicodeCase { get; } = new RegexFlags(UnicodeCaseValue); + /// Enables Unix lines mode. + public static RegexFlags UnixLines { get; } = new RegexFlags(UnixLinesValue); + /// Determines if two values are the same. + public static bool operator ==(RegexFlags left, RegexFlags right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(RegexFlags left, RegexFlags right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator RegexFlags(string value) => new RegexFlags(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is RegexFlags other && Equals(other); + /// + public bool Equals(RegexFlags other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/RescoringOptions.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/RescoringOptions.Serialization.cs new file mode 100644 index 000000000000..d253622a4b29 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/RescoringOptions.Serialization.cs @@ -0,0 +1,179 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class RescoringOptions : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(RescoringOptions)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(EnableRescoring)) + { + writer.WritePropertyName("enableRescoring"u8); + writer.WriteBooleanValue(EnableRescoring.Value); + } + if (Optional.IsDefined(DefaultOversampling)) + { + writer.WritePropertyName("defaultOversampling"u8); + writer.WriteNumberValue(DefaultOversampling.Value); + } + if (Optional.IsDefined(RescoreStorageMethod)) + { + writer.WritePropertyName("rescoreStorageMethod"u8); + writer.WriteStringValue(RescoreStorageMethod.Value.ToString()); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + RescoringOptions IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(RescoringOptions)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeRescoringOptions(document.RootElement, options); + } + + internal static RescoringOptions DeserializeRescoringOptions(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + bool? enableRescoring = default; + double? defaultOversampling = default; + VectorSearchCompressionRescoreStorageMethod? rescoreStorageMethod = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("enableRescoring"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + enableRescoring = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("defaultOversampling"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + defaultOversampling = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("rescoreStorageMethod"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + rescoreStorageMethod = new VectorSearchCompressionRescoreStorageMethod(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new RescoringOptions(enableRescoring, defaultOversampling, rescoreStorageMethod, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(RescoringOptions)} does not support writing '{options.Format}' format."); + } + } + + RescoringOptions IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeRescoringOptions(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(RescoringOptions)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static RescoringOptions FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeRescoringOptions(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/RescoringOptions.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/RescoringOptions.cs new file mode 100644 index 000000000000..1c1b5f465568 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/RescoringOptions.cs @@ -0,0 +1,93 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Contains the options for rescoring. + public partial class RescoringOptions + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public RescoringOptions() + { + } + + /// Initializes a new instance of . + /// + /// If set to true, after the initial search on the compressed vectors, the + /// similarity scores are recalculated using the full-precision vectors. This will + /// improve recall at the expense of latency. + /// + /// + /// Default oversampling factor. Oversampling retrieves a greater set of potential + /// documents to offset the resolution loss due to quantization. This increases the + /// set of results that will be rescored on full-precision vectors. Minimum value + /// is 1, meaning no oversampling (1x). This parameter can only be set when 'enableRescoring' + /// is true. Higher values improve recall at the expense of latency. + /// + /// Controls the storage method for original vectors. This setting is immutable. + /// Keeps track of any properties unknown to the library. + internal RescoringOptions(bool? enableRescoring, double? defaultOversampling, VectorSearchCompressionRescoreStorageMethod? rescoreStorageMethod, IDictionary serializedAdditionalRawData) + { + EnableRescoring = enableRescoring; + DefaultOversampling = defaultOversampling; + RescoreStorageMethod = rescoreStorageMethod; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// + /// If set to true, after the initial search on the compressed vectors, the + /// similarity scores are recalculated using the full-precision vectors. This will + /// improve recall at the expense of latency. + /// + public bool? EnableRescoring { get; set; } + /// + /// Default oversampling factor. Oversampling retrieves a greater set of potential + /// documents to offset the resolution loss due to quantization. This increases the + /// set of results that will be rescored on full-precision vectors. Minimum value + /// is 1, meaning no oversampling (1x). This parameter can only be set when 'enableRescoring' + /// is true. Higher values improve recall at the expense of latency. + /// + public double? DefaultOversampling { get; set; } + /// Controls the storage method for original vectors. This setting is immutable. + public VectorSearchCompressionRescoreStorageMethod? RescoreStorageMethod { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ResourceCounter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ResourceCounter.Serialization.cs new file mode 100644 index 000000000000..b6c52138896c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ResourceCounter.Serialization.cs @@ -0,0 +1,157 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ResourceCounter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ResourceCounter)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("usage"u8); + writer.WriteNumberValue(Usage); + if (Optional.IsDefined(Quota)) + { + writer.WritePropertyName("quota"u8); + writer.WriteNumberValue(Quota.Value); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + ResourceCounter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ResourceCounter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeResourceCounter(document.RootElement, options); + } + + internal static ResourceCounter DeserializeResourceCounter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + long usage = default; + long? quota = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("usage"u8)) + { + usage = property.Value.GetInt64(); + continue; + } + if (property.NameEquals("quota"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + quota = property.Value.GetInt64(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ResourceCounter(usage, quota, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ResourceCounter)} does not support writing '{options.Format}' format."); + } + } + + ResourceCounter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeResourceCounter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ResourceCounter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static ResourceCounter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeResourceCounter(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ResourceCounter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ResourceCounter.cs new file mode 100644 index 000000000000..1a1681e3f5bb --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ResourceCounter.cs @@ -0,0 +1,76 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents a resource's usage and quota. + public partial class ResourceCounter + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The resource usage amount. + internal ResourceCounter(long usage) + { + Usage = usage; + } + + /// Initializes a new instance of . + /// The resource usage amount. + /// The resource amount quota. + /// Keeps track of any properties unknown to the library. + internal ResourceCounter(long usage, long? quota, IDictionary serializedAdditionalRawData) + { + Usage = usage; + Quota = quota; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal ResourceCounter() + { + } + + /// The resource usage amount. + public long Usage { get; } + /// The resource amount quota. + public long? Quota { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScalarQuantizationCompression.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScalarQuantizationCompression.Serialization.cs new file mode 100644 index 000000000000..659f497e72d2 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScalarQuantizationCompression.Serialization.cs @@ -0,0 +1,195 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ScalarQuantizationCompression : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ScalarQuantizationCompression)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(ScalarQuantizationParameters)) + { + writer.WritePropertyName("scalarQuantizationParameters"u8); + writer.WriteObjectValue(ScalarQuantizationParameters, options); + } + } + + ScalarQuantizationCompression IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ScalarQuantizationCompression)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeScalarQuantizationCompression(document.RootElement, options); + } + + internal static ScalarQuantizationCompression DeserializeScalarQuantizationCompression(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + ScalarQuantizationParameters scalarQuantizationParameters = default; + string name = default; + bool? rerankWithOriginalVectors = default; + double? defaultOversampling = default; + RescoringOptions rescoringOptions = default; + int? truncationDimension = default; + VectorSearchCompressionKind kind = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("scalarQuantizationParameters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + scalarQuantizationParameters = ScalarQuantizationParameters.DeserializeScalarQuantizationParameters(property.Value, options); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("rerankWithOriginalVectors"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + rerankWithOriginalVectors = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("defaultOversampling"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + defaultOversampling = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("rescoringOptions"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + rescoringOptions = RescoringOptions.DeserializeRescoringOptions(property.Value, options); + continue; + } + if (property.NameEquals("truncationDimension"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + truncationDimension = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorSearchCompressionKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ScalarQuantizationCompression( + name, + rerankWithOriginalVectors, + defaultOversampling, + rescoringOptions, + truncationDimension, + kind, + serializedAdditionalRawData, + scalarQuantizationParameters); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ScalarQuantizationCompression)} does not support writing '{options.Format}' format."); + } + } + + ScalarQuantizationCompression IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeScalarQuantizationCompression(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ScalarQuantizationCompression)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new ScalarQuantizationCompression FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeScalarQuantizationCompression(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScalarQuantizationCompression.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScalarQuantizationCompression.cs new file mode 100644 index 000000000000..5704d88dddef --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScalarQuantizationCompression.cs @@ -0,0 +1,71 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Contains configuration options specific to the scalar quantization compression + /// method used during indexing and querying. + /// + public partial class ScalarQuantizationCompression : VectorSearchCompression + { + /// Initializes a new instance of . + /// The name to associate with this particular configuration. + /// is null. + public ScalarQuantizationCompression(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + Kind = VectorSearchCompressionKind.ScalarQuantization; + } + + /// Initializes a new instance of . + /// The name to associate with this particular configuration. + /// + /// If set to true, once the ordered set of results calculated using compressed + /// vectors are obtained, they will be reranked again by recalculating the + /// full-precision similarity scores. This will improve recall at the expense of + /// latency. + /// + /// + /// Default oversampling factor. Oversampling will internally request more + /// documents (specified by this multiplier) in the initial search. This increases + /// the set of results that will be reranked using recomputed similarity scores + /// from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). + /// This parameter can only be set when rerankWithOriginalVectors is true. Higher + /// values improve recall at the expense of latency. + /// + /// Contains the options for rescoring. + /// + /// The number of dimensions to truncate the vectors to. Truncating the vectors + /// reduces the size of the vectors and the amount of data that needs to be + /// transferred during search. This can save storage cost and improve search + /// performance at the expense of recall. It should be only used for embeddings + /// trained with Matryoshka Representation Learning (MRL) such as OpenAI + /// text-embedding-3-large (small). The default value is null, which means no + /// truncation. + /// + /// Type of VectorSearchCompression. + /// Keeps track of any properties unknown to the library. + /// Contains the parameters specific to Scalar Quantization. + internal ScalarQuantizationCompression(string name, bool? rerankWithOriginalVectors, double? defaultOversampling, RescoringOptions rescoringOptions, int? truncationDimension, VectorSearchCompressionKind kind, IDictionary serializedAdditionalRawData, ScalarQuantizationParameters scalarQuantizationParameters) : base(name, rerankWithOriginalVectors, defaultOversampling, rescoringOptions, truncationDimension, kind, serializedAdditionalRawData) + { + ScalarQuantizationParameters = scalarQuantizationParameters; + } + + /// Initializes a new instance of for deserialization. + internal ScalarQuantizationCompression() + { + } + + /// Contains the parameters specific to Scalar Quantization. + public ScalarQuantizationParameters ScalarQuantizationParameters { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScalarQuantizationParameters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScalarQuantizationParameters.Serialization.cs new file mode 100644 index 000000000000..631a31893011 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScalarQuantizationParameters.Serialization.cs @@ -0,0 +1,149 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ScalarQuantizationParameters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ScalarQuantizationParameters)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(QuantizedDataType)) + { + writer.WritePropertyName("quantizedDataType"u8); + writer.WriteStringValue(QuantizedDataType.Value.ToString()); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + ScalarQuantizationParameters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ScalarQuantizationParameters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeScalarQuantizationParameters(document.RootElement, options); + } + + internal static ScalarQuantizationParameters DeserializeScalarQuantizationParameters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + VectorSearchCompressionTarget? quantizedDataType = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("quantizedDataType"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + quantizedDataType = new VectorSearchCompressionTarget(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ScalarQuantizationParameters(quantizedDataType, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ScalarQuantizationParameters)} does not support writing '{options.Format}' format."); + } + } + + ScalarQuantizationParameters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeScalarQuantizationParameters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ScalarQuantizationParameters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static ScalarQuantizationParameters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeScalarQuantizationParameters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScalarQuantizationParameters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScalarQuantizationParameters.cs new file mode 100644 index 000000000000..0382c8cff5d8 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScalarQuantizationParameters.cs @@ -0,0 +1,65 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Contains the parameters specific to Scalar Quantization. + public partial class ScalarQuantizationParameters + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public ScalarQuantizationParameters() + { + } + + /// Initializes a new instance of . + /// The quantized data type of compressed vector values. + /// Keeps track of any properties unknown to the library. + internal ScalarQuantizationParameters(VectorSearchCompressionTarget? quantizedDataType, IDictionary serializedAdditionalRawData) + { + QuantizedDataType = quantizedDataType; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The quantized data type of compressed vector values. + public VectorSearchCompressionTarget? QuantizedDataType { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringFunction.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringFunction.Serialization.cs new file mode 100644 index 000000000000..7800a2f789fc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringFunction.Serialization.cs @@ -0,0 +1,145 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + [PersistableModelProxy(typeof(UnknownScoringFunction))] + public partial class ScoringFunction : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ScoringFunction)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("fieldName"u8); + writer.WriteStringValue(FieldName); + writer.WritePropertyName("boost"u8); + writer.WriteNumberValue(Boost); + if (Optional.IsDefined(Interpolation)) + { + writer.WritePropertyName("interpolation"u8); + writer.WriteStringValue(Interpolation.Value.ToString()); + } + writer.WritePropertyName("type"u8); + writer.WriteStringValue(Type); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + ScoringFunction IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ScoringFunction)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeScoringFunction(document.RootElement, options); + } + + internal static ScoringFunction DeserializeScoringFunction(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("type", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "distance": return DistanceScoringFunction.DeserializeDistanceScoringFunction(element, options); + case "freshness": return FreshnessScoringFunction.DeserializeFreshnessScoringFunction(element, options); + case "magnitude": return MagnitudeScoringFunction.DeserializeMagnitudeScoringFunction(element, options); + case "tag": return TagScoringFunction.DeserializeTagScoringFunction(element, options); + } + } + return UnknownScoringFunction.DeserializeUnknownScoringFunction(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ScoringFunction)} does not support writing '{options.Format}' format."); + } + } + + ScoringFunction IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeScoringFunction(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ScoringFunction)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static ScoringFunction FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeScoringFunction(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringFunction.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringFunction.cs new file mode 100644 index 000000000000..1bbf899182e7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringFunction.cs @@ -0,0 +1,99 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Base type for functions that can modify document scores during ranking. + /// 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 abstract partial class ScoringFunction + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name of the field used as input to the scoring function. + /// A multiplier for the raw score. Must be a positive number not equal to 1.0. + /// is null. + protected ScoringFunction(string fieldName, double boost) + { + Argument.AssertNotNull(fieldName, nameof(fieldName)); + + FieldName = fieldName; + Boost = boost; + } + + /// Initializes a new instance of . + /// The name of the field used as input to the scoring function. + /// A multiplier for the raw score. Must be a positive number not equal to 1.0. + /// + /// A value indicating how boosting will be interpolated across document scores; + /// defaults to "Linear". + /// + /// Type of ScoringFunction. + /// Keeps track of any properties unknown to the library. + internal ScoringFunction(string fieldName, double boost, ScoringFunctionInterpolation? interpolation, string type, IDictionary serializedAdditionalRawData) + { + FieldName = fieldName; + Boost = boost; + Interpolation = interpolation; + Type = type; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal ScoringFunction() + { + } + + /// The name of the field used as input to the scoring function. + public string FieldName { get; set; } + /// A multiplier for the raw score. Must be a positive number not equal to 1.0. + public double Boost { get; set; } + /// + /// A value indicating how boosting will be interpolated across document scores; + /// defaults to "Linear". + /// + public ScoringFunctionInterpolation? Interpolation { get; set; } + /// Type of ScoringFunction. + internal string Type { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringFunctionAggregation.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringFunctionAggregation.cs new file mode 100644 index 000000000000..99a133b4dedb --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringFunctionAggregation.cs @@ -0,0 +1,63 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Defines the aggregation function used to combine the results of all the scoring + /// functions in a scoring profile. + /// + public readonly partial struct ScoringFunctionAggregation : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public ScoringFunctionAggregation(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string SumValue = "sum"; + private const string AverageValue = "average"; + private const string MinimumValue = "minimum"; + private const string MaximumValue = "maximum"; + private const string FirstMatchingValue = "firstMatching"; + + /// Boost scores by the sum of all scoring function results. + public static ScoringFunctionAggregation Sum { get; } = new ScoringFunctionAggregation(SumValue); + /// Boost scores by the average of all scoring function results. + public static ScoringFunctionAggregation Average { get; } = new ScoringFunctionAggregation(AverageValue); + /// Boost scores by the minimum of all scoring function results. + public static ScoringFunctionAggregation Minimum { get; } = new ScoringFunctionAggregation(MinimumValue); + /// Boost scores by the maximum of all scoring function results. + public static ScoringFunctionAggregation Maximum { get; } = new ScoringFunctionAggregation(MaximumValue); + /// Boost scores using the first applicable scoring function in the scoring profile. + public static ScoringFunctionAggregation FirstMatching { get; } = new ScoringFunctionAggregation(FirstMatchingValue); + /// Determines if two values are the same. + public static bool operator ==(ScoringFunctionAggregation left, ScoringFunctionAggregation right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(ScoringFunctionAggregation left, ScoringFunctionAggregation right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator ScoringFunctionAggregation(string value) => new ScoringFunctionAggregation(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is ScoringFunctionAggregation other && Equals(other); + /// + public bool Equals(ScoringFunctionAggregation other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringFunctionInterpolation.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringFunctionInterpolation.cs new file mode 100644 index 000000000000..93db53518de9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringFunctionInterpolation.cs @@ -0,0 +1,71 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Defines the function used to interpolate score boosting across a range of + /// documents. + /// + public readonly partial struct ScoringFunctionInterpolation : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public ScoringFunctionInterpolation(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string LinearValue = "linear"; + private const string ConstantValue = "constant"; + private const string QuadraticValue = "quadratic"; + private const string LogarithmicValue = "logarithmic"; + + /// + /// Boosts scores by a linearly decreasing amount. This is the default + /// interpolation for scoring functions. + /// + public static ScoringFunctionInterpolation Linear { get; } = new ScoringFunctionInterpolation(LinearValue); + /// Boosts scores by a constant factor. + public static ScoringFunctionInterpolation Constant { get; } = new ScoringFunctionInterpolation(ConstantValue); + /// + /// Boosts scores by an amount that decreases quadratically. Boosts decrease slowly + /// for higher scores, and more quickly as the scores decrease. This interpolation + /// option is not allowed in tag scoring functions. + /// + public static ScoringFunctionInterpolation Quadratic { get; } = new ScoringFunctionInterpolation(QuadraticValue); + /// + /// Boosts scores by an amount that decreases logarithmically. Boosts decrease + /// quickly for higher scores, and more slowly as the scores decrease. This + /// interpolation option is not allowed in tag scoring functions. + /// + public static ScoringFunctionInterpolation Logarithmic { get; } = new ScoringFunctionInterpolation(LogarithmicValue); + /// Determines if two values are the same. + public static bool operator ==(ScoringFunctionInterpolation left, ScoringFunctionInterpolation right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(ScoringFunctionInterpolation left, ScoringFunctionInterpolation right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator ScoringFunctionInterpolation(string value) => new ScoringFunctionInterpolation(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is ScoringFunctionInterpolation other && Equals(other); + /// + public bool Equals(ScoringFunctionInterpolation other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringProfile.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringProfile.Serialization.cs new file mode 100644 index 000000000000..b41f21894828 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringProfile.Serialization.cs @@ -0,0 +1,197 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ScoringProfile : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ScoringProfile)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + if (Optional.IsDefined(Text)) + { + writer.WritePropertyName("text"u8); + writer.WriteObjectValue(Text, options); + } + if (Optional.IsCollectionDefined(Functions)) + { + writer.WritePropertyName("functions"u8); + writer.WriteStartArray(); + foreach (var item in Functions) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsDefined(FunctionAggregation)) + { + writer.WritePropertyName("functionAggregation"u8); + writer.WriteStringValue(FunctionAggregation.Value.ToString()); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + ScoringProfile IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ScoringProfile)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeScoringProfile(document.RootElement, options); + } + + internal static ScoringProfile DeserializeScoringProfile(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + TextWeights text = default; + IList functions = default; + ScoringFunctionAggregation? functionAggregation = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("text"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + text = TextWeights.DeserializeTextWeights(property.Value, options); + continue; + } + if (property.NameEquals("functions"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(ScoringFunction.DeserializeScoringFunction(item, options)); + } + functions = array; + continue; + } + if (property.NameEquals("functionAggregation"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + functionAggregation = new ScoringFunctionAggregation(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ScoringProfile(name, text, functions ?? new ChangeTrackingList(), functionAggregation, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ScoringProfile)} does not support writing '{options.Format}' format."); + } + } + + ScoringProfile IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeScoringProfile(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ScoringProfile)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static ScoringProfile FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeScoringProfile(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringProfile.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringProfile.cs new file mode 100644 index 000000000000..5e67ce4e177a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ScoringProfile.cs @@ -0,0 +1,102 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Defines parameters for a search index that influence scoring in search queries. + public partial class ScoringProfile + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name of the scoring profile. + /// is null. + public ScoringProfile(string name) + { + Argument.AssertNotNull(name, nameof(name)); + + Name = name; + Functions = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The name of the scoring profile. + /// Parameters that boost scoring based on text matches in certain index fields. + /// + /// The collection of functions that influence the scoring of documents. + /// 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 . + /// + /// + /// A value indicating how the results of individual scoring functions should be + /// combined. Defaults to "Sum". Ignored if there are no scoring functions. + /// + /// Keeps track of any properties unknown to the library. + internal ScoringProfile(string name, TextWeights text, IList functions, ScoringFunctionAggregation? functionAggregation, IDictionary serializedAdditionalRawData) + { + Name = name; + Text = text; + Functions = functions; + FunctionAggregation = functionAggregation; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal ScoringProfile() + { + } + + /// The name of the scoring profile. + public string Name { get; set; } + /// Parameters that boost scoring based on text matches in certain index fields. + public TextWeights Text { get; set; } + /// + /// The collection of functions that influence the scoring of documents. + /// 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 IList Functions { get; } + /// + /// A value indicating how the results of individual scoring functions should be + /// combined. Defaults to "Sum". Ignored if there are no scoring functions. + /// + public ScoringFunctionAggregation? FunctionAggregation { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchAlias.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchAlias.Serialization.cs new file mode 100644 index 000000000000..efbba1bdbd15 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchAlias.Serialization.cs @@ -0,0 +1,171 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchAlias : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchAlias)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + writer.WritePropertyName("indexes"u8); + writer.WriteStartArray(); + foreach (var item in Indexes) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + if (Optional.IsDefined(ETag)) + { + writer.WritePropertyName("@odata.etag"u8); + writer.WriteStringValue(ETag); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchAlias IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchAlias)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchAlias(document.RootElement, options); + } + + internal static SearchAlias DeserializeSearchAlias(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + IList indexes = default; + string odataEtag = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("indexes"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + indexes = array; + continue; + } + if (property.NameEquals("@odata.etag"u8)) + { + odataEtag = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchAlias(name, indexes, odataEtag, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchAlias)} does not support writing '{options.Format}' format."); + } + } + + SearchAlias IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchAlias(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchAlias)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchAlias FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchAlias(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchAlias.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchAlias.cs new file mode 100644 index 000000000000..dd7795cd9c30 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchAlias.cs @@ -0,0 +1,91 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Represents an index alias, which describes a mapping from the alias name to an + /// index. The alias name can be used in place of the index name for supported + /// operations. + /// + public partial class SearchAlias + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name of the alias. + /// The name of the index this alias maps to. Only one index name may be specified. + /// or is null. + public SearchAlias(string name, IEnumerable indexes) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(indexes, nameof(indexes)); + + Name = name; + Indexes = indexes.ToList(); + } + + /// Initializes a new instance of . + /// The name of the alias. + /// The name of the index this alias maps to. Only one index name may be specified. + /// The ETag of the alias. + /// Keeps track of any properties unknown to the library. + internal SearchAlias(string name, IList indexes, string eTag, IDictionary serializedAdditionalRawData) + { + Name = name; + Indexes = indexes; + ETag = eTag; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchAlias() + { + } + + /// The name of the alias. + public string Name { get; set; } + /// The name of the index this alias maps to. Only one index name may be specified. + public IList Indexes { get; } + /// The ETag of the alias. + public string ETag { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchClient.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchClient.cs new file mode 100644 index 000000000000..326ab035f8d2 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchClient.cs @@ -0,0 +1,337 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading; +using System.Threading.Tasks; +using Autorest.CSharp.Core; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Search.Documents.Indexes +{ + // Data plane generated client. + /// Client that can be used to manage and query indexes and documents, as well as manage other resources, on a search service. + public partial class SearchClient + { + private const string AuthorizationHeader = "api-key"; + private readonly AzureKeyCredential _keyCredential; + private static readonly string[] AuthorizationScopes = new string[] { "https://search.azure.com/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + private readonly string _apiVersion; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of SearchClient for mocking. + protected SearchClient() + { + } + + /// Initializes a new instance of SearchClient. + /// Service host. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public SearchClient(Uri endpoint, AzureKeyCredential credential) : this(endpoint, credential, new SearchClientOptions()) + { + } + + /// Initializes a new instance of SearchClient. + /// Service host. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public SearchClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new SearchClientOptions()) + { + } + + /// Initializes a new instance of SearchClient. + /// Service host. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public SearchClient(Uri endpoint, AzureKeyCredential credential, SearchClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new SearchClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _keyCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new AzureKeyCredentialPolicy(_keyCredential, AuthorizationHeader) }, new ResponseClassifier()); + _endpoint = endpoint; + _apiVersion = options.Version; + } + + /// Initializes a new instance of SearchClient. + /// Service host. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public SearchClient(Uri endpoint, TokenCredential credential, SearchClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new SearchClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + _apiVersion = options.Version; + } + + /// Gets service level statistics for a search service. + /// The cancellation token to use. + /// + public virtual async Task> GetServiceStatisticsAsync(CancellationToken cancellationToken = default) + { + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await GetServiceStatisticsAsync(context).ConfigureAwait(false); + return Response.FromValue(SearchServiceStatistics.FromResponse(response), response); + } + + /// Gets service level statistics for a search service. + /// The cancellation token to use. + /// + public virtual Response GetServiceStatistics(CancellationToken cancellationToken = default) + { + RequestContext context = FromCancellationToken(cancellationToken); + Response response = GetServiceStatistics(context); + return Response.FromValue(SearchServiceStatistics.FromResponse(response), response); + } + + /// + /// [Protocol Method] Gets service level statistics for a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task GetServiceStatisticsAsync(RequestContext context) + { + using var scope = ClientDiagnostics.CreateScope("SearchClient.GetServiceStatistics"); + scope.Start(); + try + { + using HttpMessage message = CreateGetServiceStatisticsRequest(context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Gets service level statistics for a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response GetServiceStatistics(RequestContext context) + { + using var scope = ClientDiagnostics.CreateScope("SearchClient.GetServiceStatistics"); + scope.Start(); + try + { + using HttpMessage message = CreateGetServiceStatisticsRequest(context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Retrieves a summary of statistics for all indexes in the search service. + /// The cancellation token to use. + /// + public virtual AsyncPageable GetIndexStatsSummaryAsync(CancellationToken cancellationToken = default) + { + RequestContext context = cancellationToken.CanBeCanceled ? new RequestContext { CancellationToken = cancellationToken } : null; + HttpMessage FirstPageRequest(int? pageSizeHint) => CreateGetIndexStatsSummaryRequest(context); + return GeneratorPageableHelpers.CreateAsyncPageable(FirstPageRequest, null, e => IndexStatisticsSummary.DeserializeIndexStatisticsSummary(e), ClientDiagnostics, _pipeline, "SearchClient.GetIndexStatsSummary", "value", null, context); + } + + /// Retrieves a summary of statistics for all indexes in the search service. + /// The cancellation token to use. + /// + public virtual Pageable GetIndexStatsSummary(CancellationToken cancellationToken = default) + { + RequestContext context = cancellationToken.CanBeCanceled ? new RequestContext { CancellationToken = cancellationToken } : null; + HttpMessage FirstPageRequest(int? pageSizeHint) => CreateGetIndexStatsSummaryRequest(context); + return GeneratorPageableHelpers.CreatePageable(FirstPageRequest, null, e => IndexStatisticsSummary.DeserializeIndexStatisticsSummary(e), ClientDiagnostics, _pipeline, "SearchClient.GetIndexStatsSummary", "value", null, context); + } + + /// + /// [Protocol Method] Retrieves a summary of statistics for all indexes in the search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual AsyncPageable GetIndexStatsSummaryAsync(RequestContext context) + { + HttpMessage FirstPageRequest(int? pageSizeHint) => CreateGetIndexStatsSummaryRequest(context); + return GeneratorPageableHelpers.CreateAsyncPageable(FirstPageRequest, null, e => BinaryData.FromString(e.GetRawText()), ClientDiagnostics, _pipeline, "SearchClient.GetIndexStatsSummary", "value", null, context); + } + + /// + /// [Protocol Method] Retrieves a summary of statistics for all indexes in the search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The from the service containing a list of objects. Details of the body schema for each item in the collection are in the Remarks section below. + /// + public virtual Pageable GetIndexStatsSummary(RequestContext context) + { + HttpMessage FirstPageRequest(int? pageSizeHint) => CreateGetIndexStatsSummaryRequest(context); + return GeneratorPageableHelpers.CreatePageable(FirstPageRequest, null, e => BinaryData.FromString(e.GetRawText()), ClientDiagnostics, _pipeline, "SearchClient.GetIndexStatsSummary", "value", null, context); + } + + private DataSources _cachedDataSources; + private Indexers _cachedIndexers; + private Skillsets _cachedSkillsets; + private SynonymMaps _cachedSynonymMaps; + private Indexes _cachedIndexes; + private Aliases _cachedAliases; + + /// Initializes a new instance of DataSources. + public virtual DataSources GetDataSourcesClient() + { + return Volatile.Read(ref _cachedDataSources) ?? Interlocked.CompareExchange(ref _cachedDataSources, new DataSources(ClientDiagnostics, _pipeline, _keyCredential, _tokenCredential, _endpoint, _apiVersion), null) ?? _cachedDataSources; + } + + /// Initializes a new instance of Indexers. + public virtual Indexers GetIndexersClient() + { + return Volatile.Read(ref _cachedIndexers) ?? Interlocked.CompareExchange(ref _cachedIndexers, new Indexers(ClientDiagnostics, _pipeline, _keyCredential, _tokenCredential, _endpoint, _apiVersion), null) ?? _cachedIndexers; + } + + /// Initializes a new instance of Skillsets. + public virtual Skillsets GetSkillsetsClient() + { + return Volatile.Read(ref _cachedSkillsets) ?? Interlocked.CompareExchange(ref _cachedSkillsets, new Skillsets(ClientDiagnostics, _pipeline, _keyCredential, _tokenCredential, _endpoint, _apiVersion), null) ?? _cachedSkillsets; + } + + /// Initializes a new instance of SynonymMaps. + public virtual SynonymMaps GetSynonymMapsClient() + { + return Volatile.Read(ref _cachedSynonymMaps) ?? Interlocked.CompareExchange(ref _cachedSynonymMaps, new SynonymMaps(ClientDiagnostics, _pipeline, _keyCredential, _tokenCredential, _endpoint, _apiVersion), null) ?? _cachedSynonymMaps; + } + + /// Initializes a new instance of Indexes. + public virtual Indexes GetIndexesClient() + { + return Volatile.Read(ref _cachedIndexes) ?? Interlocked.CompareExchange(ref _cachedIndexes, new Indexes(ClientDiagnostics, _pipeline, _keyCredential, _tokenCredential, _endpoint, _apiVersion), null) ?? _cachedIndexes; + } + + /// Initializes a new instance of Aliases. + public virtual Aliases GetAliasesClient() + { + return Volatile.Read(ref _cachedAliases) ?? Interlocked.CompareExchange(ref _cachedAliases, new Aliases(ClientDiagnostics, _pipeline, _keyCredential, _tokenCredential, _endpoint, _apiVersion), null) ?? _cachedAliases; + } + + internal HttpMessage CreateGetServiceStatisticsRequest(RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/servicestats", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetIndexStatsSummaryRequest(RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexstats", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static RequestContext DefaultRequestContext = new RequestContext(); + internal static RequestContext FromCancellationToken(CancellationToken cancellationToken = default) + { + if (!cancellationToken.CanBeCanceled) + { + return DefaultRequestContext; + } + + return new RequestContext() { CancellationToken = cancellationToken }; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchClientOptions.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchClientOptions.cs new file mode 100644 index 000000000000..13b98d00b2a8 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchClientOptions.cs @@ -0,0 +1,40 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + /// Client options for SearchClient. + public partial class SearchClientOptions : ClientOptions + { + private const ServiceVersion LatestVersion = ServiceVersion.V2025_03_01_Preview; + + /// The version of the service to use. + public enum ServiceVersion + { + /// Service version "2024-07-01". + V2024_07_01 = 1, + /// Service version "2025-03-01-preview". + V2025_03_01_Preview = 2, + } + + internal string Version { get; } + + /// Initializes new instance of SearchClientOptions. + public SearchClientOptions(ServiceVersion version = LatestVersion) + { + Version = version switch + { + ServiceVersion.V2024_07_01 => "2024-07-01", + ServiceVersion.V2025_03_01_Preview => "2025-03-01-preview", + _ => throw new NotSupportedException() + }; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchDocumentsIndexesClientBuilderExtensions.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchDocumentsIndexesClientBuilderExtensions.cs new file mode 100644 index 000000000000..69fad303c45c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchDocumentsIndexesClientBuilderExtensions.cs @@ -0,0 +1,46 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using Azure; +using Azure.Core.Extensions; +using Azure.Search.Documents.Indexes; + +namespace Microsoft.Extensions.Azure +{ + /// Extension methods to add to client builder. + public static partial class SearchDocumentsIndexesClientBuilderExtensions + { + /// Registers a instance. + /// The builder to register with. + /// Service host. + /// A credential used to authenticate to an Azure Service. + public static IAzureClientBuilder AddSearchClient(this TBuilder builder, Uri endpoint, AzureKeyCredential credential) + where TBuilder : IAzureClientFactoryBuilder + { + return builder.RegisterClientFactory((options) => new SearchClient(endpoint, credential, options)); + } + + /// Registers a instance. + /// The builder to register with. + /// Service host. + public static IAzureClientBuilder AddSearchClient(this TBuilder builder, Uri endpoint) + where TBuilder : IAzureClientFactoryBuilderWithCredential + { + return builder.RegisterClientFactory((options, cred) => new SearchClient(endpoint, cred, options)); + } + + /// Registers a instance. + /// The builder to register with. + /// The configuration values. + public static IAzureClientBuilder AddSearchClient(this TBuilder builder, TConfiguration configuration) + where TBuilder : IAzureClientFactoryBuilderWithConfiguration + { + return builder.RegisterClientFactory(configuration); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchDocumentsIndexesModelFactory.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchDocumentsIndexesModelFactory.cs new file mode 100644 index 000000000000..a25fd00df3dc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchDocumentsIndexesModelFactory.cs @@ -0,0 +1,431 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// Model factory for models. + public static partial class SearchDocumentsIndexesModelFactory + { + /// Initializes a new instance of . + /// Service level resource counters. + /// Service level general limits. + /// A new instance for mocking. + public static SearchServiceStatistics SearchServiceStatistics(SearchServiceCounters counters = null, SearchServiceLimits limits = null) + { + return new SearchServiceStatistics(counters, limits, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// Total number of aliases. + /// Total number of documents across all indexes in the service. + /// Total number of indexes. + /// Total number of indexers. + /// Total number of data sources. + /// Total size of used storage in bytes. + /// Total number of synonym maps. + /// Total number of skillsets. + /// Total memory consumption of all vector indexes within the service, in bytes. + /// A new instance for mocking. + public static SearchServiceCounters SearchServiceCounters(ResourceCounter aliasesCount = null, ResourceCounter documentCount = null, ResourceCounter indexesCount = null, ResourceCounter indexersCount = null, ResourceCounter dataSourcesCount = null, ResourceCounter storageSize = null, ResourceCounter synonymMaps = null, ResourceCounter skillsetCount = null, ResourceCounter vectorIndexSize = null) + { + return new SearchServiceCounters( + aliasesCount, + documentCount, + indexesCount, + indexersCount, + dataSourcesCount, + storageSize, + synonymMaps, + skillsetCount, + vectorIndexSize, + serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The resource usage amount. + /// The resource amount quota. + /// A new instance for mocking. + public static ResourceCounter ResourceCounter(long usage = default, long? quota = null) + { + return new ResourceCounter(usage, quota, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The maximum allowed fields per index. + /// + /// The maximum depth which you can nest sub-fields in an index, including the + /// top-level complex field. For example, a/b/c has a nesting depth of 3. + /// + /// + /// The maximum number of fields of type Collection(Edm.ComplexType) allowed in an + /// index. + /// + /// The maximum number of objects in complex collections allowed per document. + /// The maximum amount of storage in bytes allowed per index. + /// A new instance for mocking. + public static SearchServiceLimits SearchServiceLimits(int? maxFieldsPerIndex = null, int? maxFieldNestingDepthPerIndex = null, int? maxComplexCollectionFieldsPerIndex = null, int? maxComplexObjectsInCollectionsPerDocument = null, long? maxStoragePerIndex = null) + { + return new SearchServiceLimits( + maxFieldsPerIndex, + maxFieldNestingDepthPerIndex, + maxComplexCollectionFieldsPerIndex, + maxComplexObjectsInCollectionsPerDocument, + maxStoragePerIndex, + serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The name of the index. + /// The number of documents in the index. + /// The amount of storage in bytes consumed by the index. + /// The amount of memory in bytes consumed by vectors in the index. + /// A new instance for mocking. + public static IndexStatisticsSummary IndexStatisticsSummary(string name = null, long documentCount = default, long storageSize = default, long? vectorIndexSize = null) + { + return new IndexStatisticsSummary(name, documentCount, storageSize, vectorIndexSize, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The name of the suggester. + /// A value indicating the capabilities of the suggester. + /// + /// The list of field names to which the suggester applies. Each field must be + /// searchable. + /// + /// A new instance for mocking. + public static SearchSuggester SearchSuggester(string name = null, SearchSuggesterSearchMode searchMode = default, IEnumerable sourceFields = null) + { + sourceFields ??= new List(); + + return new SearchSuggester(name, searchMode, sourceFields?.ToList(), serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The number of documents in the index. + /// The amount of storage in bytes consumed by the index. + /// The amount of memory in bytes consumed by vectors in the index. + /// A new instance for mocking. + public static GetIndexStatisticsResult GetIndexStatisticsResult(long documentCount = default, long storageSize = default, long vectorIndexSize = default) + { + return new GetIndexStatisticsResult(documentCount, storageSize, vectorIndexSize, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The text to break into tokens. + /// + /// The name of the analyzer to use to break the given text. If this parameter is + /// not specified, you must specify a tokenizer instead. The tokenizer and analyzer + /// parameters are mutually exclusive. + /// + /// + /// The name of the tokenizer to use to break the given text. If this parameter is + /// not specified, you must specify an analyzer instead. The tokenizer and analyzer + /// parameters are mutually exclusive. + /// + /// The name of the normalizer to use to normalize the given text. + /// + /// An optional list of token filters to use when breaking the given text. This + /// parameter can only be set when using the tokenizer parameter. + /// + /// + /// An optional list of character filters to use when breaking the given text. This + /// parameter can only be set when using the tokenizer parameter. + /// + /// A new instance for mocking. + public static AnalyzeRequest AnalyzeRequest(string text = null, LexicalAnalyzerName? analyzer = null, LexicalTokenizerName? tokenizer = null, LexicalNormalizerName? normalizer = null, IEnumerable tokenFilters = null, IEnumerable charFilters = null) + { + tokenFilters ??= new List(); + charFilters ??= new List(); + + return new AnalyzeRequest( + text, + analyzer, + tokenizer, + normalizer, + tokenFilters?.ToList(), + charFilters?.ToList(), + serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The list of tokens returned by the analyzer specified in the request. + /// A new instance for mocking. + public static AnalyzeResult AnalyzeResult(IEnumerable tokens = null) + { + tokens ??= new List(); + + return new AnalyzeResult(tokens?.ToList(), serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The token returned by the analyzer. + /// The index of the first character of the token in the input text. + /// The index of the last character of the token in the input text. + /// + /// The position of the token in the input text relative to other tokens. The first + /// token in the input text has position 0, the next has position 1, and so on. + /// Depending on the analyzer used, some tokens might have the same position, for + /// example if they are synonyms of each other. + /// + /// A new instance for mocking. + public static AnalyzedTokenInfo AnalyzedTokenInfo(string token = null, int startOffset = default, int endOffset = default, int position = default) + { + return new AnalyzedTokenInfo(token, startOffset, endOffset, position, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// 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. + /// 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. + /// A new instance for mocking. + public static SynonymMap SynonymMap(string name = null, SynonymMapFormat format = default, string synonyms = null, SearchResourceEncryptionKey encryptionKey = null, string eTag = null) + { + return new SynonymMap( + name, + format, + synonyms, + encryptionKey, + eTag, + serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The synonym maps in the Search service. + /// A new instance for mocking. + public static ListSynonymMapsResult ListSynonymMapsResult(IEnumerable value = null) + { + value ??= new List(); + + return new ListSynonymMapsResult(value?.ToList(), serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The skillsets defined in the Search service. + /// A new instance for mocking. + public static ListSkillsetsResult ListSkillsetsResult(IEnumerable value = null) + { + value ??= new List(); + + return new ListSkillsetsResult(value?.ToList(), serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The indexers in the Search service. + /// A new instance for mocking. + public static ListIndexersResult ListIndexersResult(IEnumerable value = null) + { + value ??= new List(); + + return new ListIndexersResult(value?.ToList(), serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// Overall indexer status. + /// The result of the most recent or an in-progress indexer execution. + /// History of the recent indexer executions, sorted in reverse chronological order. + /// The execution limits for the indexer. + /// A new instance for mocking. + public static SearchIndexerStatus SearchIndexerStatus(IndexerStatus status = default, IndexerExecutionResult lastResult = null, IEnumerable executionHistory = null, SearchIndexerLimits limits = null) + { + executionHistory ??= new List(); + + return new SearchIndexerStatus(status, lastResult, executionHistory?.ToList(), limits, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The outcome of this indexer execution. + /// The outcome of this indexer execution. + /// All of the state that defines and dictates the indexer's current execution. + /// The error message indicating the top-level error, if any. + /// The start time of this indexer execution. + /// The end time of this indexer execution, if the execution has already completed. + /// The item-level indexing errors. + /// The item-level indexing warnings. + /// + /// The number of items that were processed during this indexer execution. This + /// includes both successfully processed items and items where indexing was + /// attempted but failed. + /// + /// The number of items that failed to be indexed during this indexer execution. + /// Change tracking state with which an indexer execution started. + /// Change tracking state with which an indexer execution finished. + /// A new instance for mocking. + public static IndexerExecutionResult IndexerExecutionResult(IndexerExecutionStatus status = default, IndexerExecutionStatusDetail? statusDetail = null, IndexerCurrentState currentState = null, string errorMessage = null, DateTimeOffset? startTime = null, DateTimeOffset? endTime = null, IEnumerable errors = null, IEnumerable warnings = null, int itemsProcessed = default, int itemsFailed = default, string initialTrackingState = null, string finalTrackingState = null) + { + errors ??= new List(); + warnings ??= new List(); + + return new IndexerExecutionResult( + status, + statusDetail, + currentState, + errorMessage, + startTime, + endTime, + errors?.ToList(), + warnings?.ToList(), + itemsProcessed, + itemsFailed, + initialTrackingState, + finalTrackingState, + serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The mode the indexer is running in. + /// + /// Change tracking state used when indexing starts on all documents in the + /// datasource. + /// + /// + /// Change tracking state value when indexing finishes on all documents in the + /// datasource. + /// + /// + /// Change tracking state used when indexing starts on select, reset documents in + /// the datasource. + /// + /// + /// Change tracking state value when indexing finishes on select, reset documents + /// in the datasource. + /// + /// + /// The list of document keys that have been reset. The document key is the + /// document's unique identifier for the data in the search index. The indexer will + /// prioritize selectively re-ingesting these keys. + /// + /// + /// The list of datasource document ids that have been reset. The datasource + /// document id is the unique identifier for the data in the datasource. The + /// indexer will prioritize selectively re-ingesting these ids. + /// + /// A new instance for mocking. + public static IndexerCurrentState IndexerCurrentState(IndexingMode? mode = null, string allDocsInitialChangeTrackingState = null, string allDocsFinalChangeTrackingState = null, string resetDocsInitialChangeTrackingState = null, string resetDocsFinalChangeTrackingState = null, IEnumerable resetDocumentKeys = null, IEnumerable resetDatasourceDocumentIds = null) + { + resetDocumentKeys ??= new List(); + resetDatasourceDocumentIds ??= new List(); + + return new IndexerCurrentState( + mode, + allDocsInitialChangeTrackingState, + allDocsFinalChangeTrackingState, + resetDocsInitialChangeTrackingState, + resetDocsFinalChangeTrackingState, + resetDocumentKeys?.ToList(), + resetDatasourceDocumentIds?.ToList(), + serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The key of the item for which indexing failed. + /// The message describing the error that occurred while processing the item. + /// + /// The status code indicating why the indexing operation failed. Possible values + /// include: 400 for a malformed input document, 404 for document not found, 409 + /// for a version conflict, 422 when the index is temporarily unavailable, or 503 + /// for when the service is too busy. + /// + /// + /// The name of the source at which the error originated. For example, this could + /// refer to a particular skill in the attached skillset. This may not be always + /// available. + /// + /// + /// Additional, verbose details about the error to assist in debugging the indexer. + /// This may not be always available. + /// + /// + /// A link to a troubleshooting guide for these classes of errors. This may not be + /// always available. + /// + /// A new instance for mocking. + public static SearchIndexerError SearchIndexerError(string key = null, string errorMessage = null, int statusCode = default, string name = null, string details = null, string documentationLink = null) + { + return new SearchIndexerError( + key, + errorMessage, + statusCode, + name, + details, + documentationLink, + serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The key of the item which generated a warning. + /// The message describing the warning that occurred while processing the item. + /// + /// The name of the source at which the warning originated. For example, this could + /// refer to a particular skill in the attached skillset. This may not be always + /// available. + /// + /// + /// Additional, verbose details about the warning to assist in debugging the + /// indexer. This may not be always available. + /// + /// + /// A link to a troubleshooting guide for these classes of warnings. This may not + /// be always available. + /// + /// A new instance for mocking. + public static SearchIndexerWarning SearchIndexerWarning(string key = null, string message = null, string name = null, string details = null, string documentationLink = null) + { + return new SearchIndexerWarning( + key, + message, + name, + details, + documentationLink, + serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The maximum duration that the indexer is permitted to run for one execution. + /// + /// The maximum size of a document, in bytes, which will be considered valid for + /// indexing. + /// + /// + /// The maximum number of characters that will be extracted from a document picked + /// up for indexing. + /// + /// A new instance for mocking. + public static SearchIndexerLimits SearchIndexerLimits(TimeSpan? maxRunTime = null, long? maxDocumentExtractionSize = null, long? maxDocumentContentCharactersToExtract = null) + { + return new SearchIndexerLimits(maxRunTime, maxDocumentExtractionSize, maxDocumentContentCharactersToExtract, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The datasources in the Search service. + /// A new instance for mocking. + public static ListDataSourcesResult ListDataSourcesResult(IEnumerable value = null) + { + value ??= new List(); + + return new ListDataSourcesResult(value?.ToList(), serializedAdditionalRawData: null); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchField.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchField.Serialization.cs new file mode 100644 index 000000000000..15cac074772c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchField.Serialization.cs @@ -0,0 +1,425 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchField : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchField)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + writer.WritePropertyName("type"u8); + writer.WriteStringValue(Type.ToString()); + if (Optional.IsDefined(Key)) + { + writer.WritePropertyName("key"u8); + writer.WriteBooleanValue(Key.Value); + } + if (Optional.IsDefined(Retrievable)) + { + writer.WritePropertyName("retrievable"u8); + writer.WriteBooleanValue(Retrievable.Value); + } + if (Optional.IsDefined(Stored)) + { + writer.WritePropertyName("stored"u8); + writer.WriteBooleanValue(Stored.Value); + } + if (Optional.IsDefined(Searchable)) + { + writer.WritePropertyName("searchable"u8); + writer.WriteBooleanValue(Searchable.Value); + } + if (Optional.IsDefined(Filterable)) + { + writer.WritePropertyName("filterable"u8); + writer.WriteBooleanValue(Filterable.Value); + } + if (Optional.IsDefined(Sortable)) + { + writer.WritePropertyName("sortable"u8); + writer.WriteBooleanValue(Sortable.Value); + } + if (Optional.IsDefined(Facetable)) + { + writer.WritePropertyName("facetable"u8); + writer.WriteBooleanValue(Facetable.Value); + } + if (Optional.IsDefined(Analyzer)) + { + writer.WritePropertyName("analyzer"u8); + writer.WriteStringValue(Analyzer.Value.ToString()); + } + if (Optional.IsDefined(SearchAnalyzer)) + { + writer.WritePropertyName("searchAnalyzer"u8); + writer.WriteStringValue(SearchAnalyzer.Value.ToString()); + } + if (Optional.IsDefined(IndexAnalyzer)) + { + writer.WritePropertyName("indexAnalyzer"u8); + writer.WriteStringValue(IndexAnalyzer.Value.ToString()); + } + if (Optional.IsDefined(Normalizer)) + { + writer.WritePropertyName("normalizer"u8); + writer.WriteStringValue(Normalizer.Value.ToString()); + } + if (Optional.IsDefined(Dimensions)) + { + writer.WritePropertyName("dimensions"u8); + writer.WriteNumberValue(Dimensions.Value); + } + if (Optional.IsDefined(VectorSearchProfile)) + { + writer.WritePropertyName("vectorSearchProfile"u8); + writer.WriteStringValue(VectorSearchProfile); + } + if (Optional.IsDefined(VectorEncoding)) + { + writer.WritePropertyName("vectorEncoding"u8); + writer.WriteStringValue(VectorEncoding.Value.ToString()); + } + if (Optional.IsCollectionDefined(SynonymMaps)) + { + writer.WritePropertyName("synonymMaps"u8); + writer.WriteStartArray(); + foreach (var item in SynonymMaps) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(Fields)) + { + writer.WritePropertyName("fields"u8); + writer.WriteStartArray(); + foreach (var item in Fields) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchField IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchField)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchField(document.RootElement, options); + } + + internal static SearchField DeserializeSearchField(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + SearchFieldDataType type = default; + bool? key = default; + bool? retrievable = default; + bool? stored = default; + bool? searchable = default; + bool? filterable = default; + bool? sortable = default; + bool? facetable = default; + LexicalAnalyzerName? analyzer = default; + LexicalAnalyzerName? searchAnalyzer = default; + LexicalAnalyzerName? indexAnalyzer = default; + LexicalNormalizerName? normalizer = default; + int? dimensions = default; + string vectorSearchProfile = default; + VectorEncodingFormat? vectorEncoding = default; + IList synonymMaps = default; + IList fields = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("type"u8)) + { + type = new SearchFieldDataType(property.Value.GetString()); + continue; + } + if (property.NameEquals("key"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + key = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("retrievable"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + retrievable = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("stored"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + stored = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("searchable"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + searchable = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("filterable"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + filterable = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("sortable"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + sortable = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("facetable"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + facetable = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("analyzer"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + analyzer = new LexicalAnalyzerName(property.Value.GetString()); + continue; + } + if (property.NameEquals("searchAnalyzer"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + searchAnalyzer = new LexicalAnalyzerName(property.Value.GetString()); + continue; + } + if (property.NameEquals("indexAnalyzer"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + indexAnalyzer = new LexicalAnalyzerName(property.Value.GetString()); + continue; + } + if (property.NameEquals("normalizer"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + normalizer = new LexicalNormalizerName(property.Value.GetString()); + continue; + } + if (property.NameEquals("dimensions"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + dimensions = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("vectorSearchProfile"u8)) + { + vectorSearchProfile = property.Value.GetString(); + continue; + } + if (property.NameEquals("vectorEncoding"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + vectorEncoding = new VectorEncodingFormat(property.Value.GetString()); + continue; + } + if (property.NameEquals("synonymMaps"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + synonymMaps = array; + continue; + } + if (property.NameEquals("fields"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(DeserializeSearchField(item, options)); + } + fields = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchField( + name, + type, + key, + retrievable, + stored, + searchable, + filterable, + sortable, + facetable, + analyzer, + searchAnalyzer, + indexAnalyzer, + normalizer, + dimensions, + vectorSearchProfile, + vectorEncoding, + synonymMaps ?? new ChangeTrackingList(), + fields ?? new ChangeTrackingList(), + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchField)} does not support writing '{options.Format}' format."); + } + } + + SearchField IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchField(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchField)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchField FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchField(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchField.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchField.cs new file mode 100644 index 000000000000..301b60a7dcb6 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchField.cs @@ -0,0 +1,365 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Represents a field in an index definition, which describes the name, data type, + /// and search behavior of a field. + /// + public partial class SearchField + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// The name of the field, which must be unique within the fields collection of the + /// index or parent field. + /// + /// The data type of the field. + /// is null. + public SearchField(string name, SearchFieldDataType type) + { + Argument.AssertNotNull(name, nameof(name)); + + Name = name; + Type = type; + SynonymMaps = new ChangeTrackingList(); + Fields = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// + /// The name of the field, which must be unique within the fields collection of the + /// index or parent field. + /// + /// 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, false for vector fields, and null for + /// complex fields. + /// + /// + /// An immutable value indicating whether the field will be persisted separately on + /// disk to be returned in a search result. You can disable this option if you + /// don't plan to return the field contents in a search response to save on storage + /// overhead. This can only be set during index creation and only for vector + /// fields. This property cannot be changed for existing fields or set as false for + /// new fields. If this property is set as false, the property 'retrievable' must + /// also be set to false. This property must be true or unset for key fields, for + /// new fields, and for non-vector fields, and it must be null for complex fields. + /// Disabling this property will reduce index storage requirements. The default is + /// true for vector 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 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, 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. + /// + /// + /// The name of the analyzer used at indexing time for the field. This option can + /// be used only with searchable fields. It must be set together with + /// searchAnalyzer 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. Once the analyzer is chosen, + /// it cannot be changed for the field. Must be null for complex fields. + /// + /// + /// The name of the normalizer to use for the field. This option can be used only + /// with fields with filterable, sortable, or facetable enabled. Once the + /// normalizer is chosen, it cannot be changed for the field. Must be null for + /// complex fields. + /// + /// The dimensionality of the vector field. + /// + /// The name of the vector search profile that specifies the algorithm and + /// vectorizer to use when searching the vector field. + /// + /// The encoding format to interpret the field contents. + /// + /// A list of the names of synonym maps to associate with this field. This option + /// can be used only with searchable fields. Currently only one synonym map per + /// field is supported. Assigning a synonym map to a field ensures that query terms + /// targeting that field are expanded at query-time using the rules in the synonym + /// map. This attribute can be changed on existing fields. Must be null or an empty + /// collection for complex fields. + /// + /// + /// A list of sub-fields if this is a field of type Edm.ComplexType or + /// Collection(Edm.ComplexType). Must be null or empty for simple fields. + /// + /// Keeps track of any properties unknown to the library. + internal SearchField(string name, SearchFieldDataType type, bool? key, bool? retrievable, bool? stored, bool? searchable, bool? filterable, bool? sortable, bool? facetable, LexicalAnalyzerName? analyzer, LexicalAnalyzerName? searchAnalyzer, LexicalAnalyzerName? indexAnalyzer, LexicalNormalizerName? normalizer, int? dimensions, string vectorSearchProfile, VectorEncodingFormat? vectorEncoding, IList synonymMaps, IList fields, IDictionary serializedAdditionalRawData) + { + Name = name; + Type = type; + Key = key; + Retrievable = retrievable; + Stored = stored; + Searchable = searchable; + Filterable = filterable; + Sortable = sortable; + Facetable = facetable; + Analyzer = analyzer; + SearchAnalyzer = searchAnalyzer; + IndexAnalyzer = indexAnalyzer; + Normalizer = normalizer; + Dimensions = dimensions; + VectorSearchProfile = vectorSearchProfile; + VectorEncoding = vectorEncoding; + SynonymMaps = synonymMaps; + Fields = fields; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchField() + { + } + + /// + /// The name of the field, which must be unique within the fields collection of the + /// index or parent field. + /// + public string Name { get; set; } + /// The data type of the field. + public SearchFieldDataType Type { get; set; } + /// + /// 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. + /// + public bool? Key { get; set; } + /// + /// 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, false for vector fields, and null for + /// complex fields. + /// + public bool? Retrievable { get; set; } + /// + /// An immutable value indicating whether the field will be persisted separately on + /// disk to be returned in a search result. You can disable this option if you + /// don't plan to return the field contents in a search response to save on storage + /// overhead. This can only be set during index creation and only for vector + /// fields. This property cannot be changed for existing fields or set as false for + /// new fields. If this property is set as false, the property 'retrievable' must + /// also be set to false. This property must be true or unset for key fields, for + /// new fields, and for non-vector fields, and it must be null for complex fields. + /// Disabling this property will reduce index storage requirements. The default is + /// true for vector fields. + /// + public bool? Stored { get; set; } + /// + /// 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. + /// + public bool? Searchable { get; set; } + /// + /// 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. + /// + public bool? Filterable { get; set; } + /// + /// 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. + /// + public bool? Sortable { get; set; } + /// + /// 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. + /// + public bool? Facetable { get; set; } + /// + /// 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. + /// + public LexicalAnalyzerName? Analyzer { get; set; } + /// + /// 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. + /// + public LexicalAnalyzerName? SearchAnalyzer { get; set; } + /// + /// The name of the analyzer used at indexing time for the field. This option can + /// be used only with searchable fields. It must be set together with + /// searchAnalyzer 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. Once the analyzer is chosen, + /// it cannot be changed for the field. Must be null for complex fields. + /// + public LexicalAnalyzerName? IndexAnalyzer { get; set; } + /// + /// The name of the normalizer to use for the field. This option can be used only + /// with fields with filterable, sortable, or facetable enabled. Once the + /// normalizer is chosen, it cannot be changed for the field. Must be null for + /// complex fields. + /// + public LexicalNormalizerName? Normalizer { get; set; } + /// The dimensionality of the vector field. + public int? Dimensions { get; set; } + /// + /// The name of the vector search profile that specifies the algorithm and + /// vectorizer to use when searching the vector field. + /// + public string VectorSearchProfile { get; set; } + /// The encoding format to interpret the field contents. + public VectorEncodingFormat? VectorEncoding { get; set; } + /// + /// A list of the names of synonym maps to associate with this field. This option + /// can be used only with searchable fields. Currently only one synonym map per + /// field is supported. Assigning a synonym map to a field ensures that query terms + /// targeting that field are expanded at query-time using the rules in the synonym + /// map. This attribute can be changed on existing fields. Must be null or an empty + /// collection for complex fields. + /// + public IList SynonymMaps { get; } + /// + /// A list of sub-fields if this is a field of type Edm.ComplexType or + /// Collection(Edm.ComplexType). Must be null or empty for simple fields. + /// + public IList Fields { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchFieldDataType.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchFieldDataType.cs new file mode 100644 index 000000000000..d2b04f17d8bc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchFieldDataType.cs @@ -0,0 +1,108 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Defines the data type of a field in a search index. + public readonly partial struct SearchFieldDataType : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public SearchFieldDataType(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string StringValue = "Edm.String"; + private const string Int32Value = "Edm.Int32"; + private const string Int64Value = "Edm.Int64"; + private const string DoubleValue = "Edm.Double"; + private const string BooleanValue = "Edm.Boolean"; + private const string DateTimeOffsetValue = "Edm.DateTimeOffset"; + private const string GeographyPointValue = "Edm.GeographyPoint"; + private const string ComplexValue = "Edm.ComplexType"; + private const string SingleValue = "Edm.Single"; + private const string HalfValue = "Edm.Half"; + private const string Int16Value = "Edm.Int16"; + private const string SByteValue = "Edm.SByte"; + private const string ByteValue = "Edm.Byte"; + + /// Indicates that a field contains a string. + public static SearchFieldDataType String { get; } = new SearchFieldDataType(StringValue); + /// Indicates that a field contains a 32-bit signed integer. + public static SearchFieldDataType Int32 { get; } = new SearchFieldDataType(Int32Value); + /// Indicates that a field contains a 64-bit signed integer. + public static SearchFieldDataType Int64 { get; } = new SearchFieldDataType(Int64Value); + /// Indicates that a field contains an IEEE double-precision floating point number. + public static SearchFieldDataType Double { get; } = new SearchFieldDataType(DoubleValue); + /// Indicates that a field contains a Boolean value (true or false). + public static SearchFieldDataType Boolean { get; } = new SearchFieldDataType(BooleanValue); + /// + /// Indicates that a field contains a date/time value, including timezone + /// information. + /// + public static SearchFieldDataType DateTimeOffset { get; } = new SearchFieldDataType(DateTimeOffsetValue); + /// + /// Indicates that a field contains a geo-location in terms of longitude and + /// latitude. + /// + public static SearchFieldDataType GeographyPoint { get; } = new SearchFieldDataType(GeographyPointValue); + /// + /// Indicates that a field contains one or more complex objects that in turn have + /// sub-fields of other types. + /// + public static SearchFieldDataType Complex { get; } = new SearchFieldDataType(ComplexValue); + /// + /// Indicates that a field contains a single-precision floating point number. This + /// is only valid when used with Collection(Edm.Single). + /// + public static SearchFieldDataType Single { get; } = new SearchFieldDataType(SingleValue); + /// + /// Indicates that a field contains a half-precision floating point number. This is + /// only valid when used with Collection(Edm.Half). + /// + public static SearchFieldDataType Half { get; } = new SearchFieldDataType(HalfValue); + /// + /// Indicates that a field contains a 16-bit signed integer. This is only valid + /// when used with Collection(Edm.Int16). + /// + public static SearchFieldDataType Int16 { get; } = new SearchFieldDataType(Int16Value); + /// + /// Indicates that a field contains a 8-bit signed integer. This is only valid when + /// used with Collection(Edm.SByte). + /// + public static SearchFieldDataType SByte { get; } = new SearchFieldDataType(SByteValue); + /// + /// Indicates that a field contains a 8-bit unsigned integer. This is only valid + /// when used with Collection(Edm.Byte). + /// + public static SearchFieldDataType Byte { get; } = new SearchFieldDataType(ByteValue); + /// Determines if two values are the same. + public static bool operator ==(SearchFieldDataType left, SearchFieldDataType right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(SearchFieldDataType left, SearchFieldDataType right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator SearchFieldDataType(string value) => new SearchFieldDataType(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is SearchFieldDataType other && Equals(other); + /// + public bool Equals(SearchFieldDataType other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndex.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndex.Serialization.cs new file mode 100644 index 000000000000..868257e98e43 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndex.Serialization.cs @@ -0,0 +1,449 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndex : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndex)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + writer.WritePropertyName("fields"u8); + writer.WriteStartArray(); + foreach (var item in Fields) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (Optional.IsCollectionDefined(ScoringProfiles)) + { + writer.WritePropertyName("scoringProfiles"u8); + writer.WriteStartArray(); + foreach (var item in ScoringProfiles) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsDefined(DefaultScoringProfile)) + { + writer.WritePropertyName("defaultScoringProfile"u8); + writer.WriteStringValue(DefaultScoringProfile); + } + if (Optional.IsDefined(CorsOptions)) + { + writer.WritePropertyName("corsOptions"u8); + writer.WriteObjectValue(CorsOptions, options); + } + if (Optional.IsCollectionDefined(Suggesters)) + { + writer.WritePropertyName("suggesters"u8); + writer.WriteStartArray(); + foreach (var item in Suggesters) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(Analyzers)) + { + writer.WritePropertyName("analyzers"u8); + writer.WriteStartArray(); + foreach (var item in Analyzers) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(Tokenizers)) + { + writer.WritePropertyName("tokenizers"u8); + writer.WriteStartArray(); + foreach (var item in Tokenizers) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(TokenFilters)) + { + writer.WritePropertyName("tokenFilters"u8); + writer.WriteStartArray(); + foreach (var item in TokenFilters) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(CharFilters)) + { + writer.WritePropertyName("charFilters"u8); + writer.WriteStartArray(); + foreach (var item in CharFilters) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(Normalizers)) + { + writer.WritePropertyName("normalizers"u8); + writer.WriteStartArray(); + foreach (var item in Normalizers) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsDefined(EncryptionKey)) + { + writer.WritePropertyName("encryptionKey"u8); + writer.WriteObjectValue(EncryptionKey, options); + } + if (Optional.IsDefined(Similarity)) + { + writer.WritePropertyName("similarity"u8); + writer.WriteObjectValue(Similarity, options); + } + if (Optional.IsDefined(Semantic)) + { + writer.WritePropertyName("semantic"u8); + writer.WriteObjectValue(Semantic, options); + } + if (Optional.IsDefined(VectorSearch)) + { + writer.WritePropertyName("vectorSearch"u8); + writer.WriteObjectValue(VectorSearch, options); + } + if (Optional.IsDefined(ETag)) + { + writer.WritePropertyName("@odata.etag"u8); + writer.WriteStringValue(ETag); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndex IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndex)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndex(document.RootElement, options); + } + + internal static SearchIndex DeserializeSearchIndex(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + IList fields = default; + IList scoringProfiles = default; + string defaultScoringProfile = default; + CorsOptions corsOptions = default; + IList suggesters = default; + IList analyzers = default; + IList tokenizers = default; + IList tokenFilters = default; + IList charFilters = default; + IList normalizers = default; + SearchResourceEncryptionKey encryptionKey = default; + SimilarityAlgorithm similarity = default; + SemanticSearch semantic = default; + VectorSearch vectorSearch = default; + string odataEtag = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("fields"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SearchField.DeserializeSearchField(item, options)); + } + fields = array; + continue; + } + if (property.NameEquals("scoringProfiles"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(ScoringProfile.DeserializeScoringProfile(item, options)); + } + scoringProfiles = array; + continue; + } + if (property.NameEquals("defaultScoringProfile"u8)) + { + defaultScoringProfile = property.Value.GetString(); + continue; + } + if (property.NameEquals("corsOptions"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + corsOptions = CorsOptions.DeserializeCorsOptions(property.Value, options); + continue; + } + if (property.NameEquals("suggesters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SearchSuggester.DeserializeSearchSuggester(item, options)); + } + suggesters = array; + continue; + } + if (property.NameEquals("analyzers"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(LexicalAnalyzer.DeserializeLexicalAnalyzer(item, options)); + } + analyzers = array; + continue; + } + if (property.NameEquals("tokenizers"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(LexicalTokenizer.DeserializeLexicalTokenizer(item, options)); + } + tokenizers = array; + continue; + } + if (property.NameEquals("tokenFilters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(TokenFilter.DeserializeTokenFilter(item, options)); + } + tokenFilters = array; + continue; + } + if (property.NameEquals("charFilters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(CharFilter.DeserializeCharFilter(item, options)); + } + charFilters = array; + continue; + } + if (property.NameEquals("normalizers"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(LexicalNormalizer.DeserializeLexicalNormalizer(item, options)); + } + normalizers = array; + continue; + } + if (property.NameEquals("encryptionKey"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + encryptionKey = SearchResourceEncryptionKey.DeserializeSearchResourceEncryptionKey(property.Value, options); + continue; + } + if (property.NameEquals("similarity"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + similarity = SimilarityAlgorithm.DeserializeSimilarityAlgorithm(property.Value, options); + continue; + } + if (property.NameEquals("semantic"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + semantic = SemanticSearch.DeserializeSemanticSearch(property.Value, options); + continue; + } + if (property.NameEquals("vectorSearch"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + vectorSearch = VectorSearch.DeserializeVectorSearch(property.Value, options); + continue; + } + if (property.NameEquals("@odata.etag"u8)) + { + odataEtag = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndex( + name, + fields, + scoringProfiles ?? new ChangeTrackingList(), + defaultScoringProfile, + corsOptions, + suggesters ?? new ChangeTrackingList(), + analyzers ?? new ChangeTrackingList(), + tokenizers ?? new ChangeTrackingList(), + tokenFilters ?? new ChangeTrackingList(), + charFilters ?? new ChangeTrackingList(), + normalizers ?? new ChangeTrackingList(), + encryptionKey, + similarity, + semantic, + vectorSearch, + odataEtag, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndex)} does not support writing '{options.Format}' format."); + } + } + + SearchIndex IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndex(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndex)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndex FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndex(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndex.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndex.cs new file mode 100644 index 000000000000..bfc5352aea93 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndex.cs @@ -0,0 +1,231 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Represents a search index definition, which describes the fields and search + /// behavior of an index. + /// + public partial class SearchIndex + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name of the index. + /// The fields of the index. + /// or is null. + public SearchIndex(string name, IEnumerable fields) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(fields, nameof(fields)); + + Name = name; + Fields = fields.ToList(); + ScoringProfiles = new ChangeTrackingList(); + Suggesters = new ChangeTrackingList(); + Analyzers = new ChangeTrackingList(); + Tokenizers = new ChangeTrackingList(); + TokenFilters = new ChangeTrackingList(); + CharFilters = new ChangeTrackingList(); + Normalizers = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The name of the index. + /// The fields of the index. + /// The scoring profiles for the index. + /// + /// The name of the scoring profile to use if none is specified in the query. If + /// this property is not set and no scoring profile is specified in the query, then + /// default scoring (tf-idf) will be used. + /// + /// Options to control Cross-Origin Resource Sharing (CORS) for the index. + /// The suggesters for the index. + /// + /// The analyzers for the index. + /// 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 . + /// + /// + /// The tokenizers for the index. + /// 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 . + /// + /// + /// The token filters for the index. + /// 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 . + /// + /// + /// The character filters for the index. + /// 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 . + /// + /// + /// The normalizers for the index. + /// 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. + /// 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. + /// The available derived classes include and . + /// + /// Defines parameters for a search index that influence semantic capabilities. + /// Contains configuration options related to vector search. + /// The ETag of the index. + /// Keeps track of any properties unknown to the library. + internal SearchIndex(string name, IList fields, IList scoringProfiles, string defaultScoringProfile, CorsOptions corsOptions, IList suggesters, IList analyzers, IList tokenizers, IList tokenFilters, IList charFilters, IList normalizers, SearchResourceEncryptionKey encryptionKey, SimilarityAlgorithm similarity, SemanticSearch semantic, VectorSearch vectorSearch, string eTag, IDictionary serializedAdditionalRawData) + { + Name = name; + Fields = fields; + ScoringProfiles = scoringProfiles; + DefaultScoringProfile = defaultScoringProfile; + CorsOptions = corsOptions; + Suggesters = suggesters; + Analyzers = analyzers; + Tokenizers = tokenizers; + TokenFilters = tokenFilters; + CharFilters = charFilters; + Normalizers = normalizers; + EncryptionKey = encryptionKey; + Similarity = similarity; + Semantic = semantic; + VectorSearch = vectorSearch; + ETag = eTag; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchIndex() + { + } + + /// The name of the index. + public string Name { get; set; } + /// The fields of the index. + public IList Fields { get; } + /// The scoring profiles for the index. + public IList ScoringProfiles { get; } + /// + /// The name of the scoring profile to use if none is specified in the query. If + /// this property is not set and no scoring profile is specified in the query, then + /// default scoring (tf-idf) will be used. + /// + public string DefaultScoringProfile { get; set; } + /// Options to control Cross-Origin Resource Sharing (CORS) for the index. + public CorsOptions CorsOptions { get; set; } + /// The suggesters for the index. + public IList Suggesters { get; } + /// + /// The analyzers for the index. + /// 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 IList Analyzers { get; } + /// + /// The tokenizers for the index. + /// 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 IList Tokenizers { get; } + /// + /// The token filters for the index. + /// 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 IList TokenFilters { get; } + /// + /// The character filters for the index. + /// 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 IList CharFilters { get; } + /// + /// The normalizers for the index. + /// 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 . + /// + public IList Normalizers { get; } + /// + /// 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. + /// 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 SimilarityAlgorithm Similarity { get; set; } + /// Defines parameters for a search index that influence semantic capabilities. + public SemanticSearch Semantic { get; set; } + /// Contains configuration options related to vector search. + public VectorSearch VectorSearch { get; set; } + /// The ETag of the index. + public string ETag { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexer.Serialization.cs new file mode 100644 index 000000000000..88139fc7b857 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexer.Serialization.cs @@ -0,0 +1,330 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexer)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + if (Optional.IsDefined(Description)) + { + writer.WritePropertyName("description"u8); + writer.WriteStringValue(Description); + } + writer.WritePropertyName("dataSourceName"u8); + writer.WriteStringValue(DataSourceName); + if (Optional.IsDefined(SkillsetName)) + { + writer.WritePropertyName("skillsetName"u8); + writer.WriteStringValue(SkillsetName); + } + writer.WritePropertyName("targetIndexName"u8); + writer.WriteStringValue(TargetIndexName); + if (Optional.IsDefined(Schedule)) + { + writer.WritePropertyName("schedule"u8); + writer.WriteObjectValue(Schedule, options); + } + if (Optional.IsDefined(Parameters)) + { + writer.WritePropertyName("parameters"u8); + writer.WriteObjectValue(Parameters, options); + } + if (Optional.IsCollectionDefined(FieldMappings)) + { + writer.WritePropertyName("fieldMappings"u8); + writer.WriteStartArray(); + foreach (var item in FieldMappings) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(OutputFieldMappings)) + { + writer.WritePropertyName("outputFieldMappings"u8); + writer.WriteStartArray(); + foreach (var item in OutputFieldMappings) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsDefined(Disabled)) + { + writer.WritePropertyName("disabled"u8); + writer.WriteBooleanValue(Disabled.Value); + } + if (Optional.IsDefined(ETag)) + { + writer.WritePropertyName("@odata.etag"u8); + writer.WriteStringValue(ETag); + } + if (Optional.IsDefined(EncryptionKey)) + { + writer.WritePropertyName("encryptionKey"u8); + writer.WriteObjectValue(EncryptionKey, options); + } + if (Optional.IsDefined(Cache)) + { + writer.WritePropertyName("cache"u8); + writer.WriteObjectValue(Cache, options); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexer(document.RootElement, options); + } + + internal static SearchIndexer DeserializeSearchIndexer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + string description = default; + string dataSourceName = default; + string skillsetName = default; + string targetIndexName = default; + IndexingSchedule schedule = default; + IndexingParameters parameters = default; + IList fieldMappings = default; + IList outputFieldMappings = default; + bool? disabled = default; + string odataEtag = default; + SearchResourceEncryptionKey encryptionKey = default; + SearchIndexerCache cache = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("dataSourceName"u8)) + { + dataSourceName = property.Value.GetString(); + continue; + } + if (property.NameEquals("skillsetName"u8)) + { + skillsetName = property.Value.GetString(); + continue; + } + if (property.NameEquals("targetIndexName"u8)) + { + targetIndexName = property.Value.GetString(); + continue; + } + if (property.NameEquals("schedule"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + schedule = IndexingSchedule.DeserializeIndexingSchedule(property.Value, options); + continue; + } + if (property.NameEquals("parameters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + parameters = IndexingParameters.DeserializeIndexingParameters(property.Value, options); + continue; + } + if (property.NameEquals("fieldMappings"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(FieldMapping.DeserializeFieldMapping(item, options)); + } + fieldMappings = array; + continue; + } + if (property.NameEquals("outputFieldMappings"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(FieldMapping.DeserializeFieldMapping(item, options)); + } + outputFieldMappings = array; + continue; + } + if (property.NameEquals("disabled"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + disabled = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("@odata.etag"u8)) + { + odataEtag = property.Value.GetString(); + continue; + } + if (property.NameEquals("encryptionKey"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + encryptionKey = SearchResourceEncryptionKey.DeserializeSearchResourceEncryptionKey(property.Value, options); + continue; + } + if (property.NameEquals("cache"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + cache = SearchIndexerCache.DeserializeSearchIndexerCache(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexer( + name, + description, + dataSourceName, + skillsetName, + targetIndexName, + schedule, + parameters, + fieldMappings ?? new ChangeTrackingList(), + outputFieldMappings ?? new ChangeTrackingList(), + disabled, + odataEtag, + encryptionKey, + cache, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexer)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexer(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexer.cs new file mode 100644 index 000000000000..57ed8ca2cb08 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexer.cs @@ -0,0 +1,171 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents an indexer. + public partial class SearchIndexer + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name of the indexer. + /// The name of the datasource from which this indexer reads data. + /// The name of the index to which this indexer writes data. + /// , or is null. + public SearchIndexer(string name, string dataSourceName, string targetIndexName) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(dataSourceName, nameof(dataSourceName)); + Argument.AssertNotNull(targetIndexName, nameof(targetIndexName)); + + Name = name; + DataSourceName = dataSourceName; + TargetIndexName = targetIndexName; + FieldMappings = new ChangeTrackingList(); + OutputFieldMappings = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The name of the indexer. + /// The description of the indexer. + /// The name of the datasource from which this indexer reads data. + /// The name of the skillset executing with this indexer. + /// The name of the index to which this indexer writes data. + /// The schedule for this indexer. + /// Parameters for indexer execution. + /// + /// Defines mappings between fields in the data source and corresponding target + /// fields in the index. + /// + /// + /// 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. 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. + /// + /// Keeps track of any properties unknown to the library. + internal SearchIndexer(string name, string description, string dataSourceName, string skillsetName, string targetIndexName, IndexingSchedule schedule, IndexingParameters parameters, IList fieldMappings, IList outputFieldMappings, bool? disabled, string eTag, SearchResourceEncryptionKey encryptionKey, SearchIndexerCache cache, IDictionary serializedAdditionalRawData) + { + Name = name; + Description = description; + DataSourceName = dataSourceName; + SkillsetName = skillsetName; + TargetIndexName = targetIndexName; + Schedule = schedule; + Parameters = parameters; + FieldMappings = fieldMappings; + OutputFieldMappings = outputFieldMappings; + Disabled = disabled; + ETag = eTag; + EncryptionKey = encryptionKey; + Cache = cache; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexer() + { + } + + /// The name of the indexer. + public string Name { get; set; } + /// The description of the indexer. + public string Description { get; set; } + /// The name of the datasource from which this indexer reads data. + public string DataSourceName { get; set; } + /// The name of the skillset executing with this indexer. + public string SkillsetName { get; set; } + /// The name of the index to which this indexer writes data. + public string TargetIndexName { get; set; } + /// The schedule for this indexer. + public IndexingSchedule Schedule { get; set; } + /// Parameters for indexer execution. + public IndexingParameters Parameters { get; set; } + /// + /// Defines mappings between fields in the data source and corresponding target + /// fields in the index. + /// + public IList FieldMappings { get; } + /// + /// Output field mappings are applied after enrichment and immediately before + /// indexing. + /// + public IList OutputFieldMappings { get; } + /// A value indicating whether the indexer is disabled. Default is false. + public bool? Disabled { get; set; } + /// The ETag of the indexer. + public string ETag { 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. 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.Indexes/src/Generated/SearchIndexerCache.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerCache.Serialization.cs new file mode 100644 index 000000000000..3129187d93e5 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerCache.Serialization.cs @@ -0,0 +1,186 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerCache : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerCache)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(StorageConnectionString)) + { + writer.WritePropertyName("storageConnectionString"u8); + writer.WriteStringValue(StorageConnectionString); + } + if (Optional.IsDefined(EnableReprocessing)) + { + writer.WritePropertyName("enableReprocessing"u8); + writer.WriteBooleanValue(EnableReprocessing.Value); + } + if (Optional.IsDefined(Identity)) + { + writer.WritePropertyName("identity"u8); + writer.WriteObjectValue(Identity, options); + } + if (Optional.IsDefined(Id)) + { + writer.WritePropertyName("id"u8); + writer.WriteStringValue(Id); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexerCache IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerCache)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerCache(document.RootElement, options); + } + + internal static SearchIndexerCache DeserializeSearchIndexerCache(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string storageConnectionString = default; + bool? enableReprocessing = default; + SearchIndexerDataIdentity identity = default; + string id = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("storageConnectionString"u8)) + { + storageConnectionString = property.Value.GetString(); + continue; + } + if (property.NameEquals("enableReprocessing"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + enableReprocessing = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("identity"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + identity = SearchIndexerDataIdentity.DeserializeSearchIndexerDataIdentity(property.Value, options); + continue; + } + if (property.NameEquals("id"u8)) + { + id = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerCache(storageConnectionString, enableReprocessing, identity, id, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerCache)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerCache IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerCache(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerCache)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerCache FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerCache(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerCache.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerCache.cs new file mode 100644 index 000000000000..44a0cfe05569 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerCache.cs @@ -0,0 +1,99 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// The type of the cache. + public partial class SearchIndexerCache + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public SearchIndexerCache() + { + } + + /// Initializes a new instance of . + /// + /// The connection string to the storage account where the cache data will be + /// persisted. + /// + /// Specifies whether incremental reprocessing is enabled. + /// + /// The user-assigned managed identity used for connections to the enrichment + /// cache. If the connection string indicates an identity (ResourceId) and it's + /// not specified, the system-assigned managed identity is used. On updates to the + /// indexer, if the identity is unspecified, the value remains unchanged. If set to + /// "none", the value of this property is cleared. + /// 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 . + /// + /// A guid for the SearchIndexerCache. + /// Keeps track of any properties unknown to the library. + internal SearchIndexerCache(string storageConnectionString, bool? enableReprocessing, SearchIndexerDataIdentity identity, string id, IDictionary serializedAdditionalRawData) + { + StorageConnectionString = storageConnectionString; + EnableReprocessing = enableReprocessing; + Identity = identity; + Id = id; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// + /// The connection string to the storage account where the cache data will be + /// persisted. + /// + public string StorageConnectionString { get; set; } + /// Specifies whether incremental reprocessing is enabled. + public bool? EnableReprocessing { get; set; } + /// + /// The user-assigned managed identity used for connections to the enrichment + /// cache. If the connection string indicates an identity (ResourceId) and it's + /// not specified, the system-assigned managed identity is used. On updates to the + /// indexer, if the identity is unspecified, the value remains unchanged. If set to + /// "none", the value of this property is cleared. + /// 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 SearchIndexerDataIdentity Identity { get; set; } + /// A guid for the SearchIndexerCache. + public string Id { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataContainer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataContainer.Serialization.cs new file mode 100644 index 000000000000..3bbb74d757b4 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataContainer.Serialization.cs @@ -0,0 +1,153 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerDataContainer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerDataContainer)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + if (Optional.IsDefined(Query)) + { + writer.WritePropertyName("query"u8); + writer.WriteStringValue(Query); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexerDataContainer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerDataContainer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerDataContainer(document.RootElement, options); + } + + internal static SearchIndexerDataContainer DeserializeSearchIndexerDataContainer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + string query = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("query"u8)) + { + query = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerDataContainer(name, query, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerDataContainer)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerDataContainer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerDataContainer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerDataContainer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerDataContainer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerDataContainer(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataContainer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataContainer.cs new file mode 100644 index 000000000000..96f48c62f244 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataContainer.cs @@ -0,0 +1,97 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Represents information about the entity (such as Azure SQL table or CosmosDB + /// collection) that will be indexed. + /// + public partial class SearchIndexerDataContainer + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// The name of the table or view (for Azure SQL data source) or collection (for + /// CosmosDB data source) that will be indexed. + /// + /// is null. + public SearchIndexerDataContainer(string name) + { + Argument.AssertNotNull(name, nameof(name)); + + Name = name; + } + + /// Initializes a new instance of . + /// + /// The name of the table or view (for Azure SQL data source) or collection (for + /// CosmosDB data source) that will be indexed. + /// + /// + /// A query that is applied to this data container. The syntax and meaning of this + /// parameter is datasource-specific. Not supported by Azure SQL datasources. + /// + /// Keeps track of any properties unknown to the library. + internal SearchIndexerDataContainer(string name, string query, IDictionary serializedAdditionalRawData) + { + Name = name; + Query = query; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexerDataContainer() + { + } + + /// + /// The name of the table or view (for Azure SQL data source) or collection (for + /// CosmosDB data source) that will be indexed. + /// + public string Name { get; set; } + /// + /// A query that is applied to this data container. The syntax and meaning of this + /// parameter is datasource-specific. Not supported by Azure SQL datasources. + /// + public string Query { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataIdentity.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataIdentity.Serialization.cs new file mode 100644 index 000000000000..f8c346596889 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataIdentity.Serialization.cs @@ -0,0 +1,134 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + [PersistableModelProxy(typeof(UnknownSearchIndexerDataIdentity))] + public partial class SearchIndexerDataIdentity : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerDataIdentity)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("@odata.type"u8); + writer.WriteStringValue(OdataType); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexerDataIdentity IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerDataIdentity)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerDataIdentity(document.RootElement, options); + } + + internal static SearchIndexerDataIdentity DeserializeSearchIndexerDataIdentity(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("@odata.type", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "#Microsoft.Azure.Search.DataNoneIdentity": return SearchIndexerDataNoneIdentity.DeserializeSearchIndexerDataNoneIdentity(element, options); + case "#Microsoft.Azure.Search.DataUserAssignedIdentity": return SearchIndexerDataUserAssignedIdentity.DeserializeSearchIndexerDataUserAssignedIdentity(element, options); + } + } + return UnknownSearchIndexerDataIdentity.DeserializeUnknownSearchIndexerDataIdentity(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerDataIdentity)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerDataIdentity IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerDataIdentity(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerDataIdentity)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerDataIdentity FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerDataIdentity(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataIdentity.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataIdentity.cs new file mode 100644 index 000000000000..fd71d05a7221 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataIdentity.cs @@ -0,0 +1,69 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Abstract base type for data identities. + /// 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 abstract partial class SearchIndexerDataIdentity + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + protected SearchIndexerDataIdentity() + { + } + + /// Initializes a new instance of . + /// A URI fragment specifying the type of identity. + /// Keeps track of any properties unknown to the library. + internal SearchIndexerDataIdentity(string odataType, IDictionary serializedAdditionalRawData) + { + OdataType = odataType; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// A URI fragment specifying the type of identity. + internal string OdataType { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataNoneIdentity.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataNoneIdentity.Serialization.cs new file mode 100644 index 000000000000..4e232af6d3df --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataNoneIdentity.Serialization.cs @@ -0,0 +1,126 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerDataNoneIdentity : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerDataNoneIdentity)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + SearchIndexerDataNoneIdentity IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerDataNoneIdentity)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerDataNoneIdentity(document.RootElement, options); + } + + internal static SearchIndexerDataNoneIdentity DeserializeSearchIndexerDataNoneIdentity(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerDataNoneIdentity(odataType, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerDataNoneIdentity)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerDataNoneIdentity IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerDataNoneIdentity(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerDataNoneIdentity)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new SearchIndexerDataNoneIdentity FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerDataNoneIdentity(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataNoneIdentity.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataNoneIdentity.cs new file mode 100644 index 000000000000..47c740c48341 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataNoneIdentity.cs @@ -0,0 +1,29 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Clears the identity property of a datasource. + public partial class SearchIndexerDataNoneIdentity : SearchIndexerDataIdentity + { + /// Initializes a new instance of . + public SearchIndexerDataNoneIdentity() + { + OdataType = "#Microsoft.Azure.Search.DataNoneIdentity"; + } + + /// Initializes a new instance of . + /// A URI fragment specifying the type of identity. + /// Keeps track of any properties unknown to the library. + internal SearchIndexerDataNoneIdentity(string odataType, IDictionary serializedAdditionalRawData) : base(odataType, serializedAdditionalRawData) + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataSource.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataSource.Serialization.cs new file mode 100644 index 000000000000..c8ea25ed3005 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataSource.Serialization.cs @@ -0,0 +1,259 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerDataSource : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerDataSource)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + if (Optional.IsDefined(Description)) + { + writer.WritePropertyName("description"u8); + writer.WriteStringValue(Description); + } + writer.WritePropertyName("type"u8); + writer.WriteStringValue(Type.ToString()); + writer.WritePropertyName("credentials"u8); + writer.WriteObjectValue(Credentials, options); + writer.WritePropertyName("container"u8); + writer.WriteObjectValue(Container, options); + if (Optional.IsDefined(Identity)) + { + writer.WritePropertyName("identity"u8); + writer.WriteObjectValue(Identity, options); + } + if (Optional.IsDefined(DataChangeDetectionPolicy)) + { + writer.WritePropertyName("dataChangeDetectionPolicy"u8); + writer.WriteObjectValue(DataChangeDetectionPolicy, options); + } + if (Optional.IsDefined(DataDeletionDetectionPolicy)) + { + writer.WritePropertyName("dataDeletionDetectionPolicy"u8); + writer.WriteObjectValue(DataDeletionDetectionPolicy, options); + } + if (Optional.IsDefined(ETag)) + { + writer.WritePropertyName("@odata.etag"u8); + writer.WriteStringValue(ETag); + } + if (Optional.IsDefined(EncryptionKey)) + { + writer.WritePropertyName("encryptionKey"u8); + writer.WriteObjectValue(EncryptionKey, options); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexerDataSource IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerDataSource)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerDataSource(document.RootElement, options); + } + + internal static SearchIndexerDataSource DeserializeSearchIndexerDataSource(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + string description = default; + SearchIndexerDataSourceType type = default; + DataSourceCredentials credentials = default; + SearchIndexerDataContainer container = default; + SearchIndexerDataIdentity identity = default; + DataChangeDetectionPolicy dataChangeDetectionPolicy = default; + DataDeletionDetectionPolicy dataDeletionDetectionPolicy = default; + string odataEtag = default; + SearchResourceEncryptionKey encryptionKey = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("type"u8)) + { + type = new SearchIndexerDataSourceType(property.Value.GetString()); + continue; + } + if (property.NameEquals("credentials"u8)) + { + credentials = DataSourceCredentials.DeserializeDataSourceCredentials(property.Value, options); + continue; + } + if (property.NameEquals("container"u8)) + { + container = SearchIndexerDataContainer.DeserializeSearchIndexerDataContainer(property.Value, options); + continue; + } + if (property.NameEquals("identity"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + identity = SearchIndexerDataIdentity.DeserializeSearchIndexerDataIdentity(property.Value, options); + continue; + } + if (property.NameEquals("dataChangeDetectionPolicy"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + dataChangeDetectionPolicy = DataChangeDetectionPolicy.DeserializeDataChangeDetectionPolicy(property.Value, options); + continue; + } + if (property.NameEquals("dataDeletionDetectionPolicy"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + dataDeletionDetectionPolicy = DataDeletionDetectionPolicy.DeserializeDataDeletionDetectionPolicy(property.Value, options); + continue; + } + if (property.NameEquals("@odata.etag"u8)) + { + odataEtag = property.Value.GetString(); + continue; + } + if (property.NameEquals("encryptionKey"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + encryptionKey = SearchResourceEncryptionKey.DeserializeSearchResourceEncryptionKey(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerDataSource( + name, + description, + type, + credentials, + container, + identity, + dataChangeDetectionPolicy, + dataDeletionDetectionPolicy, + odataEtag, + encryptionKey, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerDataSource)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerDataSource IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerDataSource(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerDataSource)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerDataSource FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerDataSource(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataSource.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataSource.cs new file mode 100644 index 000000000000..a4dc118ac1d9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataSource.cs @@ -0,0 +1,171 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents a datasource definition, which can be used to configure an indexer. + public partial class SearchIndexerDataSource + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name of the datasource. + /// The type of the datasource. + /// Credentials for the datasource. + /// The data container for the datasource. + /// , or is null. + public SearchIndexerDataSource(string name, SearchIndexerDataSourceType type, DataSourceCredentials credentials, SearchIndexerDataContainer container) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(credentials, nameof(credentials)); + Argument.AssertNotNull(container, nameof(container)); + + Name = name; + Type = type; + Credentials = credentials; + Container = container; + } + + /// Initializes a new instance of . + /// The name of the datasource. + /// The description of the datasource. + /// The type of the datasource. + /// Credentials for the datasource. + /// The data container for the datasource. + /// + /// An explicit managed identity to use for this datasource. If not specified and + /// the connection string is a managed identity, the system-assigned managed + /// identity is used. If not specified, the value remains unchanged. If "none" is + /// specified, the value of this property is cleared. + /// 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 . + /// + /// + /// The data change detection policy for the datasource. + /// 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 . + /// + /// + /// The data deletion detection policy for the datasource. + /// 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 . + /// + /// 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. 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. + /// + /// Keeps track of any properties unknown to the library. + internal SearchIndexerDataSource(string name, string description, SearchIndexerDataSourceType type, DataSourceCredentials credentials, SearchIndexerDataContainer container, SearchIndexerDataIdentity identity, DataChangeDetectionPolicy dataChangeDetectionPolicy, DataDeletionDetectionPolicy dataDeletionDetectionPolicy, string eTag, SearchResourceEncryptionKey encryptionKey, IDictionary serializedAdditionalRawData) + { + Name = name; + Description = description; + Type = type; + Credentials = credentials; + Container = container; + Identity = identity; + DataChangeDetectionPolicy = dataChangeDetectionPolicy; + DataDeletionDetectionPolicy = dataDeletionDetectionPolicy; + ETag = eTag; + EncryptionKey = encryptionKey; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexerDataSource() + { + } + + /// The name of the datasource. + public string Name { get; set; } + /// The description of the datasource. + public string Description { get; set; } + /// The type of the datasource. + public SearchIndexerDataSourceType Type { get; set; } + /// Credentials for the datasource. + public DataSourceCredentials Credentials { get; set; } + /// The data container for the datasource. + public SearchIndexerDataContainer Container { get; set; } + /// + /// An explicit managed identity to use for this datasource. If not specified and + /// the connection string is a managed identity, the system-assigned managed + /// identity is used. If not specified, the value remains unchanged. If "none" is + /// specified, the value of this property is cleared. + /// 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 SearchIndexerDataIdentity Identity { get; set; } + /// + /// The data change detection policy for the datasource. + /// 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 DataChangeDetectionPolicy DataChangeDetectionPolicy { get; set; } + /// + /// The data deletion detection policy for the datasource. + /// 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 DataDeletionDetectionPolicy DataDeletionDetectionPolicy { get; set; } + /// The ETag of the data source. + public string ETag { 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. 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.Indexes/src/Generated/SearchIndexerDataSourceType.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataSourceType.cs new file mode 100644 index 000000000000..7b5bec13a911 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataSourceType.cs @@ -0,0 +1,66 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Defines the type of a datasource. + public readonly partial struct SearchIndexerDataSourceType : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public SearchIndexerDataSourceType(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string AzureSqlValue = "azuresql"; + private const string CosmosDbValue = "cosmosdb"; + private const string AzureBlobValue = "azureblob"; + private const string AzureTableValue = "azuretable"; + private const string MySqlValue = "mysql"; + private const string AdlsGen2Value = "adlsgen2"; + private const string OneLakeValue = "onelake"; + + /// Indicates an Azure SQL datasource. + public static SearchIndexerDataSourceType AzureSql { get; } = new SearchIndexerDataSourceType(AzureSqlValue); + /// Indicates a CosmosDB datasource. + public static SearchIndexerDataSourceType CosmosDb { get; } = new SearchIndexerDataSourceType(CosmosDbValue); + /// Indicates an Azure Blob datasource. + public static SearchIndexerDataSourceType AzureBlob { get; } = new SearchIndexerDataSourceType(AzureBlobValue); + /// Indicates an Azure Table datasource. + public static SearchIndexerDataSourceType AzureTable { get; } = new SearchIndexerDataSourceType(AzureTableValue); + /// Indicates a MySql datasource. + public static SearchIndexerDataSourceType MySql { get; } = new SearchIndexerDataSourceType(MySqlValue); + /// Indicates an ADLS Gen2 datasource. + public static SearchIndexerDataSourceType AdlsGen2 { get; } = new SearchIndexerDataSourceType(AdlsGen2Value); + /// Indicates a Microsoft Fabric OneLake datasource. + public static SearchIndexerDataSourceType OneLake { get; } = new SearchIndexerDataSourceType(OneLakeValue); + /// Determines if two values are the same. + public static bool operator ==(SearchIndexerDataSourceType left, SearchIndexerDataSourceType right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(SearchIndexerDataSourceType left, SearchIndexerDataSourceType right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator SearchIndexerDataSourceType(string value) => new SearchIndexerDataSourceType(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is SearchIndexerDataSourceType other && Equals(other); + /// + public bool Equals(SearchIndexerDataSourceType other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataUserAssignedIdentity.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataUserAssignedIdentity.Serialization.cs new file mode 100644 index 000000000000..5f443d80106f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataUserAssignedIdentity.Serialization.cs @@ -0,0 +1,134 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerDataUserAssignedIdentity : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerDataUserAssignedIdentity)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("userAssignedIdentity"u8); + writer.WriteStringValue(UserAssignedIdentity); + } + + SearchIndexerDataUserAssignedIdentity IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerDataUserAssignedIdentity)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerDataUserAssignedIdentity(document.RootElement, options); + } + + internal static SearchIndexerDataUserAssignedIdentity DeserializeSearchIndexerDataUserAssignedIdentity(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string userAssignedIdentity = default; + string odataType = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("userAssignedIdentity"u8)) + { + userAssignedIdentity = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerDataUserAssignedIdentity(odataType, serializedAdditionalRawData, userAssignedIdentity); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerDataUserAssignedIdentity)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerDataUserAssignedIdentity IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerDataUserAssignedIdentity(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerDataUserAssignedIdentity)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new SearchIndexerDataUserAssignedIdentity FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerDataUserAssignedIdentity(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataUserAssignedIdentity.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataUserAssignedIdentity.cs new file mode 100644 index 000000000000..e2f64ca085b2 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerDataUserAssignedIdentity.cs @@ -0,0 +1,59 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Specifies the identity for a datasource to use. + public partial class SearchIndexerDataUserAssignedIdentity : SearchIndexerDataIdentity + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public SearchIndexerDataUserAssignedIdentity(string userAssignedIdentity) + { + Argument.AssertNotNull(userAssignedIdentity, nameof(userAssignedIdentity)); + + OdataType = "#Microsoft.Azure.Search.DataUserAssignedIdentity"; + UserAssignedIdentity = userAssignedIdentity; + } + + /// Initializes a new instance of . + /// A URI fragment specifying the type of identity. + /// Keeps track of any properties unknown to the library. + /// + /// 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, IDictionary serializedAdditionalRawData, string userAssignedIdentity) : base(odataType, serializedAdditionalRawData) + { + UserAssignedIdentity = userAssignedIdentity; + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexerDataUserAssignedIdentity() + { + } + + /// + /// 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. + /// + public string UserAssignedIdentity { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerError.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerError.Serialization.cs new file mode 100644 index 000000000000..63aaff753510 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerError.Serialization.cs @@ -0,0 +1,201 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerError : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerError)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(Key)) + { + writer.WritePropertyName("key"u8); + writer.WriteStringValue(Key); + } + writer.WritePropertyName("errorMessage"u8); + writer.WriteStringValue(ErrorMessage); + writer.WritePropertyName("statusCode"u8); + writer.WriteNumberValue(StatusCode); + if (Optional.IsDefined(Name)) + { + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + } + if (Optional.IsDefined(Details)) + { + writer.WritePropertyName("details"u8); + writer.WriteStringValue(Details); + } + if (Optional.IsDefined(DocumentationLink)) + { + writer.WritePropertyName("documentationLink"u8); + writer.WriteStringValue(DocumentationLink); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexerError IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerError)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerError(document.RootElement, options); + } + + internal static SearchIndexerError DeserializeSearchIndexerError(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string key = default; + string errorMessage = default; + int statusCode = default; + string name = default; + string details = default; + string documentationLink = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("key"u8)) + { + key = property.Value.GetString(); + continue; + } + if (property.NameEquals("errorMessage"u8)) + { + errorMessage = property.Value.GetString(); + continue; + } + if (property.NameEquals("statusCode"u8)) + { + statusCode = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("details"u8)) + { + details = property.Value.GetString(); + continue; + } + if (property.NameEquals("documentationLink"u8)) + { + documentationLink = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerError( + key, + errorMessage, + statusCode, + name, + details, + documentationLink, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerError)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerError IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerError(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerError)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerError FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerError(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerError.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerError.cs new file mode 100644 index 000000000000..7bbd3393f854 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerError.cs @@ -0,0 +1,132 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents an item- or document-level indexing error. + public partial class SearchIndexerError + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The message describing the error that occurred while processing the item. + /// + /// The status code indicating why the indexing operation failed. Possible values + /// include: 400 for a malformed input document, 404 for document not found, 409 + /// for a version conflict, 422 when the index is temporarily unavailable, or 503 + /// for when the service is too busy. + /// + /// is null. + internal SearchIndexerError(string errorMessage, int statusCode) + { + Argument.AssertNotNull(errorMessage, nameof(errorMessage)); + + ErrorMessage = errorMessage; + StatusCode = statusCode; + } + + /// Initializes a new instance of . + /// The key of the item for which indexing failed. + /// The message describing the error that occurred while processing the item. + /// + /// The status code indicating why the indexing operation failed. Possible values + /// include: 400 for a malformed input document, 404 for document not found, 409 + /// for a version conflict, 422 when the index is temporarily unavailable, or 503 + /// for when the service is too busy. + /// + /// + /// The name of the source at which the error originated. For example, this could + /// refer to a particular skill in the attached skillset. This may not be always + /// available. + /// + /// + /// Additional, verbose details about the error to assist in debugging the indexer. + /// This may not be always available. + /// + /// + /// A link to a troubleshooting guide for these classes of errors. This may not be + /// always available. + /// + /// Keeps track of any properties unknown to the library. + internal SearchIndexerError(string key, string errorMessage, int statusCode, string name, string details, string documentationLink, IDictionary serializedAdditionalRawData) + { + Key = key; + ErrorMessage = errorMessage; + StatusCode = statusCode; + Name = name; + Details = details; + DocumentationLink = documentationLink; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexerError() + { + } + + /// The key of the item for which indexing failed. + public string Key { get; } + /// The message describing the error that occurred while processing the item. + public string ErrorMessage { get; } + /// + /// The status code indicating why the indexing operation failed. Possible values + /// include: 400 for a malformed input document, 404 for document not found, 409 + /// for a version conflict, 422 when the index is temporarily unavailable, or 503 + /// for when the service is too busy. + /// + public int StatusCode { get; } + /// + /// The name of the source at which the error originated. For example, this could + /// refer to a particular skill in the attached skillset. This may not be always + /// available. + /// + public string Name { get; } + /// + /// Additional, verbose details about the error to assist in debugging the indexer. + /// This may not be always available. + /// + public string Details { get; } + /// + /// A link to a troubleshooting guide for these classes of errors. This may not be + /// always available. + /// + public string DocumentationLink { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjection.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjection.Serialization.cs new file mode 100644 index 000000000000..7930d1e54df2 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjection.Serialization.cs @@ -0,0 +1,167 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerIndexProjection : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerIndexProjection)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("selectors"u8); + writer.WriteStartArray(); + foreach (var item in Selectors) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (Optional.IsDefined(Parameters)) + { + writer.WritePropertyName("parameters"u8); + writer.WriteObjectValue(Parameters, options); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexerIndexProjection IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerIndexProjection)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerIndexProjection(document.RootElement, options); + } + + internal static SearchIndexerIndexProjection DeserializeSearchIndexerIndexProjection(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList selectors = default; + SearchIndexerIndexProjectionsParameters parameters = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("selectors"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SearchIndexerIndexProjectionSelector.DeserializeSearchIndexerIndexProjectionSelector(item, options)); + } + selectors = array; + continue; + } + if (property.NameEquals("parameters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + parameters = SearchIndexerIndexProjectionsParameters.DeserializeSearchIndexerIndexProjectionsParameters(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerIndexProjection(selectors, parameters, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerIndexProjection)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerIndexProjection IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerIndexProjection(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerIndexProjection)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerIndexProjection FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerIndexProjection(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjection.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjection.cs new file mode 100644 index 000000000000..9e13404e9ccb --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjection.cs @@ -0,0 +1,86 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// Definition of additional projections to secondary search indexes. + public partial class SearchIndexerIndexProjection + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// A list of projections to be performed to secondary search indexes. + /// is null. + public SearchIndexerIndexProjection(IEnumerable selectors) + { + Argument.AssertNotNull(selectors, nameof(selectors)); + + Selectors = selectors.ToList(); + } + + /// Initializes a new instance of . + /// A list of projections to be performed to secondary search indexes. + /// + /// A dictionary of index projection-specific configuration properties. Each name + /// is the name of a specific property. Each value must be of a primitive type. + /// + /// Keeps track of any properties unknown to the library. + internal SearchIndexerIndexProjection(IList selectors, SearchIndexerIndexProjectionsParameters parameters, IDictionary serializedAdditionalRawData) + { + Selectors = selectors; + Parameters = parameters; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexerIndexProjection() + { + } + + /// A list of projections to be performed to secondary search indexes. + public IList Selectors { get; } + /// + /// A dictionary of index projection-specific configuration properties. Each name + /// is the name of a specific property. Each value must be of a primitive type. + /// + public SearchIndexerIndexProjectionsParameters Parameters { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjectionSelector.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjectionSelector.Serialization.cs new file mode 100644 index 000000000000..88e11c0d00ac --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjectionSelector.Serialization.cs @@ -0,0 +1,176 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerIndexProjectionSelector : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerIndexProjectionSelector)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("targetIndexName"u8); + writer.WriteStringValue(TargetIndexName); + writer.WritePropertyName("parentKeyFieldName"u8); + writer.WriteStringValue(ParentKeyFieldName); + writer.WritePropertyName("sourceContext"u8); + writer.WriteStringValue(SourceContext); + writer.WritePropertyName("mappings"u8); + writer.WriteStartArray(); + foreach (var item in Mappings) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexerIndexProjectionSelector IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerIndexProjectionSelector)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerIndexProjectionSelector(document.RootElement, options); + } + + internal static SearchIndexerIndexProjectionSelector DeserializeSearchIndexerIndexProjectionSelector(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string targetIndexName = default; + string parentKeyFieldName = default; + string sourceContext = default; + IList mappings = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("targetIndexName"u8)) + { + targetIndexName = property.Value.GetString(); + continue; + } + if (property.NameEquals("parentKeyFieldName"u8)) + { + parentKeyFieldName = property.Value.GetString(); + continue; + } + if (property.NameEquals("sourceContext"u8)) + { + sourceContext = property.Value.GetString(); + continue; + } + if (property.NameEquals("mappings"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + mappings = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerIndexProjectionSelector(targetIndexName, parentKeyFieldName, sourceContext, mappings, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerIndexProjectionSelector)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerIndexProjectionSelector IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerIndexProjectionSelector(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerIndexProjectionSelector)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerIndexProjectionSelector FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerIndexProjectionSelector(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjectionSelector.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjectionSelector.cs new file mode 100644 index 000000000000..665bdbad0cd4 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjectionSelector.cs @@ -0,0 +1,124 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// Description for what data to store in the designated search index. + public partial class SearchIndexerIndexProjectionSelector + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// Name of the search index to project to. Must have a key field with the 'keyword' analyzer set. + /// + /// Name of the field in the search index to map the parent document's key value + /// to. Must be a string field that is filterable and not the key field. + /// + /// + /// Source context for the projections. Represents the cardinality at which the + /// document will be split into multiple sub documents. + /// + /// + /// Mappings for the projection, or which source should be mapped to which field in + /// the target index. + /// + /// , , or is null. + public SearchIndexerIndexProjectionSelector(string targetIndexName, string parentKeyFieldName, string sourceContext, IEnumerable mappings) + { + Argument.AssertNotNull(targetIndexName, nameof(targetIndexName)); + Argument.AssertNotNull(parentKeyFieldName, nameof(parentKeyFieldName)); + Argument.AssertNotNull(sourceContext, nameof(sourceContext)); + Argument.AssertNotNull(mappings, nameof(mappings)); + + TargetIndexName = targetIndexName; + ParentKeyFieldName = parentKeyFieldName; + SourceContext = sourceContext; + Mappings = mappings.ToList(); + } + + /// Initializes a new instance of . + /// Name of the search index to project to. Must have a key field with the 'keyword' analyzer set. + /// + /// Name of the field in the search index to map the parent document's key value + /// to. Must be a string field that is filterable and not the key field. + /// + /// + /// Source context for the projections. Represents the cardinality at which the + /// document will be split into multiple sub documents. + /// + /// + /// Mappings for the projection, or which source should be mapped to which field in + /// the target index. + /// + /// Keeps track of any properties unknown to the library. + internal SearchIndexerIndexProjectionSelector(string targetIndexName, string parentKeyFieldName, string sourceContext, IList mappings, IDictionary serializedAdditionalRawData) + { + TargetIndexName = targetIndexName; + ParentKeyFieldName = parentKeyFieldName; + SourceContext = sourceContext; + Mappings = mappings; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexerIndexProjectionSelector() + { + } + + /// Name of the search index to project to. Must have a key field with the 'keyword' analyzer set. + public string TargetIndexName { get; set; } + /// + /// Name of the field in the search index to map the parent document's key value + /// to. Must be a string field that is filterable and not the key field. + /// + public string ParentKeyFieldName { get; set; } + /// + /// Source context for the projections. Represents the cardinality at which the + /// document will be split into multiple sub documents. + /// + public string SourceContext { get; set; } + /// + /// Mappings for the projection, or which source should be mapped to which field in + /// the target index. + /// + public IList Mappings { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjectionsParameters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjectionsParameters.Serialization.cs new file mode 100644 index 000000000000..f328f94ac458 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjectionsParameters.Serialization.cs @@ -0,0 +1,143 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerIndexProjectionsParameters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerIndexProjectionsParameters)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(ProjectionMode)) + { + writer.WritePropertyName("projectionMode"u8); + writer.WriteStringValue(ProjectionMode.Value.ToString()); + } + foreach (var item in AdditionalProperties) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + + SearchIndexerIndexProjectionsParameters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerIndexProjectionsParameters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerIndexProjectionsParameters(document.RootElement, options); + } + + internal static SearchIndexerIndexProjectionsParameters DeserializeSearchIndexerIndexProjectionsParameters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IndexProjectionMode? projectionMode = default; + IDictionary additionalProperties = default; + Dictionary additionalPropertiesDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("projectionMode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + projectionMode = new IndexProjectionMode(property.Value.GetString()); + continue; + } + additionalPropertiesDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + additionalProperties = additionalPropertiesDictionary; + return new SearchIndexerIndexProjectionsParameters(projectionMode, additionalProperties); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerIndexProjectionsParameters)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerIndexProjectionsParameters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerIndexProjectionsParameters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerIndexProjectionsParameters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerIndexProjectionsParameters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerIndexProjectionsParameters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjectionsParameters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjectionsParameters.cs new file mode 100644 index 000000000000..e3b750009515 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerIndexProjectionsParameters.cs @@ -0,0 +1,74 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A dictionary of index projection-specific configuration properties. Each name + /// is the name of a specific property. Each value must be of a primitive type. + /// + public partial class SearchIndexerIndexProjectionsParameters + { + /// Initializes a new instance of . + public SearchIndexerIndexProjectionsParameters() + { + AdditionalProperties = new ChangeTrackingDictionary(); + } + + /// Initializes a new instance of . + /// + /// Defines behavior of the index projections in relation to the rest of the + /// indexer. + /// + /// Additional Properties. + internal SearchIndexerIndexProjectionsParameters(IndexProjectionMode? projectionMode, IDictionary additionalProperties) + { + ProjectionMode = projectionMode; + AdditionalProperties = additionalProperties; + } + + /// + /// Defines behavior of the index projections in relation to the rest of the + /// indexer. + /// + public IndexProjectionMode? ProjectionMode { get; set; } + /// + /// Additional Properties + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + public IDictionary AdditionalProperties { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStore.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStore.Serialization.cs new file mode 100644 index 000000000000..9fa66f6f4da5 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStore.Serialization.cs @@ -0,0 +1,190 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerKnowledgeStore : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStore)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("storageConnectionString"u8); + writer.WriteStringValue(StorageConnectionString); + writer.WritePropertyName("projections"u8); + writer.WriteStartArray(); + foreach (var item in Projections) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (Optional.IsDefined(Identity)) + { + writer.WritePropertyName("identity"u8); + writer.WriteObjectValue(Identity, options); + } + if (Optional.IsDefined(Parameters)) + { + writer.WritePropertyName("parameters"u8); + writer.WriteObjectValue(Parameters, options); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexerKnowledgeStore IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStore)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerKnowledgeStore(document.RootElement, options); + } + + internal static SearchIndexerKnowledgeStore DeserializeSearchIndexerKnowledgeStore(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string storageConnectionString = default; + IList projections = default; + SearchIndexerDataIdentity identity = default; + SearchIndexerKnowledgeStoreParameters parameters = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("storageConnectionString"u8)) + { + storageConnectionString = property.Value.GetString(); + continue; + } + if (property.NameEquals("projections"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SearchIndexerKnowledgeStoreProjection.DeserializeSearchIndexerKnowledgeStoreProjection(item, options)); + } + projections = array; + continue; + } + if (property.NameEquals("identity"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + identity = SearchIndexerDataIdentity.DeserializeSearchIndexerDataIdentity(property.Value, options); + continue; + } + if (property.NameEquals("parameters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + parameters = SearchIndexerKnowledgeStoreParameters.DeserializeSearchIndexerKnowledgeStoreParameters(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerKnowledgeStore(storageConnectionString, projections, identity, parameters, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStore)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerKnowledgeStore IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStore(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStore)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerKnowledgeStore FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStore(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStore.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStore.cs new file mode 100644 index 000000000000..0e4b7dc398da --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStore.cs @@ -0,0 +1,118 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Definition of additional projections to azure blob, table, or files, of + /// enriched data. + /// + public partial class SearchIndexerKnowledgeStore + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The connection string to the storage account projections will be stored in. + /// A list of additional projections to perform during indexing. + /// or is null. + public SearchIndexerKnowledgeStore(string storageConnectionString, IEnumerable projections) + { + Argument.AssertNotNull(storageConnectionString, nameof(storageConnectionString)); + Argument.AssertNotNull(projections, nameof(projections)); + + StorageConnectionString = storageConnectionString; + Projections = projections.ToList(); + } + + /// Initializes a new instance of . + /// The connection string to the storage account projections will be stored in. + /// A list of additional projections to perform during indexing. + /// + /// The user-assigned managed identity used for connections to Azure Storage when + /// writing knowledge store projections. If the connection string indicates an + /// identity (ResourceId) and it's not specified, the system-assigned managed + /// identity is used. On updates to the indexer, if the identity is unspecified, + /// the value remains unchanged. If set to "none", the value of this property is + /// cleared. + /// 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 . + /// + /// + /// A dictionary of knowledge store-specific configuration properties. Each name is + /// the name of a specific property. Each value must be of a primitive type. + /// + /// Keeps track of any properties unknown to the library. + internal SearchIndexerKnowledgeStore(string storageConnectionString, IList projections, SearchIndexerDataIdentity identity, SearchIndexerKnowledgeStoreParameters parameters, IDictionary serializedAdditionalRawData) + { + StorageConnectionString = storageConnectionString; + Projections = projections; + Identity = identity; + Parameters = parameters; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexerKnowledgeStore() + { + } + + /// The connection string to the storage account projections will be stored in. + public string StorageConnectionString { get; set; } + /// A list of additional projections to perform during indexing. + public IList Projections { get; } + /// + /// The user-assigned managed identity used for connections to Azure Storage when + /// writing knowledge store projections. If the connection string indicates an + /// identity (ResourceId) and it's not specified, the system-assigned managed + /// identity is used. On updates to the indexer, if the identity is unspecified, + /// the value remains unchanged. If set to "none", the value of this property is + /// cleared. + /// 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 SearchIndexerDataIdentity Identity { get; set; } + /// + /// A dictionary of knowledge store-specific configuration properties. Each name is + /// the name of a specific property. Each value must be of a primitive type. + /// + public SearchIndexerKnowledgeStoreParameters Parameters { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreBlobProjectionSelector.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreBlobProjectionSelector.Serialization.cs new file mode 100644 index 000000000000..2d881bdf895d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreBlobProjectionSelector.Serialization.cs @@ -0,0 +1,174 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerKnowledgeStoreBlobProjectionSelector : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreBlobProjectionSelector)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("storageContainer"u8); + writer.WriteStringValue(StorageContainer); + } + + SearchIndexerKnowledgeStoreBlobProjectionSelector IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreBlobProjectionSelector)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerKnowledgeStoreBlobProjectionSelector(document.RootElement, options); + } + + internal static SearchIndexerKnowledgeStoreBlobProjectionSelector DeserializeSearchIndexerKnowledgeStoreBlobProjectionSelector(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string storageContainer = default; + string referenceKeyName = default; + string generatedKeyName = default; + string source = default; + string sourceContext = default; + IList inputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("storageContainer"u8)) + { + storageContainer = property.Value.GetString(); + continue; + } + if (property.NameEquals("referenceKeyName"u8)) + { + referenceKeyName = property.Value.GetString(); + continue; + } + if (property.NameEquals("generatedKeyName"u8)) + { + generatedKeyName = property.Value.GetString(); + continue; + } + if (property.NameEquals("source"u8)) + { + source = property.Value.GetString(); + continue; + } + if (property.NameEquals("sourceContext"u8)) + { + sourceContext = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerKnowledgeStoreBlobProjectionSelector( + referenceKeyName, + generatedKeyName, + source, + sourceContext, + inputs ?? new ChangeTrackingList(), + serializedAdditionalRawData, + storageContainer); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreBlobProjectionSelector)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerKnowledgeStoreBlobProjectionSelector IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStoreBlobProjectionSelector(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreBlobProjectionSelector)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new SearchIndexerKnowledgeStoreBlobProjectionSelector FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStoreBlobProjectionSelector(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreBlobProjectionSelector.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreBlobProjectionSelector.cs new file mode 100644 index 000000000000..9469affe9adc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreBlobProjectionSelector.cs @@ -0,0 +1,47 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Abstract class to share properties between concrete selectors. + public partial class SearchIndexerKnowledgeStoreBlobProjectionSelector : SearchIndexerKnowledgeStoreProjectionSelector + { + /// Initializes a new instance of . + /// Blob container to store projections in. + /// is null. + public SearchIndexerKnowledgeStoreBlobProjectionSelector(string storageContainer) + { + Argument.AssertNotNull(storageContainer, nameof(storageContainer)); + + StorageContainer = storageContainer; + } + + /// Initializes a new instance of . + /// Name of reference key to different projection. + /// Name of generated key to store projection under. + /// Source data to project. + /// Source context for complex projections. + /// Nested inputs for complex projections. + /// Keeps track of any properties unknown to the library. + /// Blob container to store projections in. + internal SearchIndexerKnowledgeStoreBlobProjectionSelector(string referenceKeyName, string generatedKeyName, string source, string sourceContext, IList inputs, IDictionary serializedAdditionalRawData, string storageContainer) : base(referenceKeyName, generatedKeyName, source, sourceContext, inputs, serializedAdditionalRawData) + { + StorageContainer = storageContainer; + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexerKnowledgeStoreBlobProjectionSelector() + { + } + + /// Blob container to store projections in. + public string StorageContainer { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreFileProjectionSelector.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreFileProjectionSelector.Serialization.cs new file mode 100644 index 000000000000..069606079ec1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreFileProjectionSelector.Serialization.cs @@ -0,0 +1,172 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerKnowledgeStoreFileProjectionSelector : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreFileProjectionSelector)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + SearchIndexerKnowledgeStoreFileProjectionSelector IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreFileProjectionSelector)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerKnowledgeStoreFileProjectionSelector(document.RootElement, options); + } + + internal static SearchIndexerKnowledgeStoreFileProjectionSelector DeserializeSearchIndexerKnowledgeStoreFileProjectionSelector(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string storageContainer = default; + string referenceKeyName = default; + string generatedKeyName = default; + string source = default; + string sourceContext = default; + IList inputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("storageContainer"u8)) + { + storageContainer = property.Value.GetString(); + continue; + } + if (property.NameEquals("referenceKeyName"u8)) + { + referenceKeyName = property.Value.GetString(); + continue; + } + if (property.NameEquals("generatedKeyName"u8)) + { + generatedKeyName = property.Value.GetString(); + continue; + } + if (property.NameEquals("source"u8)) + { + source = property.Value.GetString(); + continue; + } + if (property.NameEquals("sourceContext"u8)) + { + sourceContext = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerKnowledgeStoreFileProjectionSelector( + referenceKeyName, + generatedKeyName, + source, + sourceContext, + inputs ?? new ChangeTrackingList(), + serializedAdditionalRawData, + storageContainer); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreFileProjectionSelector)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerKnowledgeStoreFileProjectionSelector IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStoreFileProjectionSelector(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreFileProjectionSelector)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new SearchIndexerKnowledgeStoreFileProjectionSelector FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStoreFileProjectionSelector(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreFileProjectionSelector.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreFileProjectionSelector.cs new file mode 100644 index 000000000000..da8d8db948bc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreFileProjectionSelector.cs @@ -0,0 +1,41 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Projection definition for what data to store in Azure Files. + public partial class SearchIndexerKnowledgeStoreFileProjectionSelector : SearchIndexerKnowledgeStoreBlobProjectionSelector + { + /// Initializes a new instance of . + /// Blob container to store projections in. + /// is null. + public SearchIndexerKnowledgeStoreFileProjectionSelector(string storageContainer) : base(storageContainer) + { + Argument.AssertNotNull(storageContainer, nameof(storageContainer)); + } + + /// Initializes a new instance of . + /// Name of reference key to different projection. + /// Name of generated key to store projection under. + /// Source data to project. + /// Source context for complex projections. + /// Nested inputs for complex projections. + /// Keeps track of any properties unknown to the library. + /// Blob container to store projections in. + internal SearchIndexerKnowledgeStoreFileProjectionSelector(string referenceKeyName, string generatedKeyName, string source, string sourceContext, IList inputs, IDictionary serializedAdditionalRawData, string storageContainer) : base(referenceKeyName, generatedKeyName, source, sourceContext, inputs, serializedAdditionalRawData, storageContainer) + { + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexerKnowledgeStoreFileProjectionSelector() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreObjectProjectionSelector.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreObjectProjectionSelector.Serialization.cs new file mode 100644 index 000000000000..2883bb3b9562 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreObjectProjectionSelector.Serialization.cs @@ -0,0 +1,172 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerKnowledgeStoreObjectProjectionSelector : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreObjectProjectionSelector)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + SearchIndexerKnowledgeStoreObjectProjectionSelector IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreObjectProjectionSelector)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerKnowledgeStoreObjectProjectionSelector(document.RootElement, options); + } + + internal static SearchIndexerKnowledgeStoreObjectProjectionSelector DeserializeSearchIndexerKnowledgeStoreObjectProjectionSelector(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string storageContainer = default; + string referenceKeyName = default; + string generatedKeyName = default; + string source = default; + string sourceContext = default; + IList inputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("storageContainer"u8)) + { + storageContainer = property.Value.GetString(); + continue; + } + if (property.NameEquals("referenceKeyName"u8)) + { + referenceKeyName = property.Value.GetString(); + continue; + } + if (property.NameEquals("generatedKeyName"u8)) + { + generatedKeyName = property.Value.GetString(); + continue; + } + if (property.NameEquals("source"u8)) + { + source = property.Value.GetString(); + continue; + } + if (property.NameEquals("sourceContext"u8)) + { + sourceContext = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerKnowledgeStoreObjectProjectionSelector( + referenceKeyName, + generatedKeyName, + source, + sourceContext, + inputs ?? new ChangeTrackingList(), + serializedAdditionalRawData, + storageContainer); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreObjectProjectionSelector)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerKnowledgeStoreObjectProjectionSelector IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStoreObjectProjectionSelector(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreObjectProjectionSelector)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new SearchIndexerKnowledgeStoreObjectProjectionSelector FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStoreObjectProjectionSelector(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreObjectProjectionSelector.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreObjectProjectionSelector.cs new file mode 100644 index 000000000000..4448d180f062 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreObjectProjectionSelector.cs @@ -0,0 +1,41 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Projection definition for what data to store in Azure Blob. + public partial class SearchIndexerKnowledgeStoreObjectProjectionSelector : SearchIndexerKnowledgeStoreBlobProjectionSelector + { + /// Initializes a new instance of . + /// Blob container to store projections in. + /// is null. + public SearchIndexerKnowledgeStoreObjectProjectionSelector(string storageContainer) : base(storageContainer) + { + Argument.AssertNotNull(storageContainer, nameof(storageContainer)); + } + + /// Initializes a new instance of . + /// Name of reference key to different projection. + /// Name of generated key to store projection under. + /// Source data to project. + /// Source context for complex projections. + /// Nested inputs for complex projections. + /// Keeps track of any properties unknown to the library. + /// Blob container to store projections in. + internal SearchIndexerKnowledgeStoreObjectProjectionSelector(string referenceKeyName, string generatedKeyName, string source, string sourceContext, IList inputs, IDictionary serializedAdditionalRawData, string storageContainer) : base(referenceKeyName, generatedKeyName, source, sourceContext, inputs, serializedAdditionalRawData, storageContainer) + { + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexerKnowledgeStoreObjectProjectionSelector() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreParameters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreParameters.Serialization.cs new file mode 100644 index 000000000000..8885c227c71c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreParameters.Serialization.cs @@ -0,0 +1,143 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerKnowledgeStoreParameters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreParameters)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(SynthesizeGeneratedKeyName)) + { + writer.WritePropertyName("synthesizeGeneratedKeyName"u8); + writer.WriteBooleanValue(SynthesizeGeneratedKeyName.Value); + } + foreach (var item in AdditionalProperties) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + + SearchIndexerKnowledgeStoreParameters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreParameters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerKnowledgeStoreParameters(document.RootElement, options); + } + + internal static SearchIndexerKnowledgeStoreParameters DeserializeSearchIndexerKnowledgeStoreParameters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + bool? synthesizeGeneratedKeyName = default; + IDictionary additionalProperties = default; + Dictionary additionalPropertiesDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("synthesizeGeneratedKeyName"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + synthesizeGeneratedKeyName = property.Value.GetBoolean(); + continue; + } + additionalPropertiesDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + additionalProperties = additionalPropertiesDictionary; + return new SearchIndexerKnowledgeStoreParameters(synthesizeGeneratedKeyName, additionalProperties); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreParameters)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerKnowledgeStoreParameters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStoreParameters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreParameters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerKnowledgeStoreParameters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStoreParameters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreParameters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreParameters.cs new file mode 100644 index 000000000000..c4fab12ab4a9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreParameters.cs @@ -0,0 +1,74 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A dictionary of knowledge store-specific configuration properties. Each name is + /// the name of a specific property. Each value must be of a primitive type. + /// + public partial class SearchIndexerKnowledgeStoreParameters + { + /// Initializes a new instance of . + public SearchIndexerKnowledgeStoreParameters() + { + AdditionalProperties = new ChangeTrackingDictionary(); + } + + /// Initializes a new instance of . + /// + /// Whether or not projections should synthesize a generated key name if one isn't + /// already present. + /// + /// Additional Properties. + internal SearchIndexerKnowledgeStoreParameters(bool? synthesizeGeneratedKeyName, IDictionary additionalProperties) + { + SynthesizeGeneratedKeyName = synthesizeGeneratedKeyName; + AdditionalProperties = additionalProperties; + } + + /// + /// Whether or not projections should synthesize a generated key name if one isn't + /// already present. + /// + public bool? SynthesizeGeneratedKeyName { get; set; } + /// + /// Additional Properties + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + public IDictionary AdditionalProperties { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreProjection.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreProjection.Serialization.cs new file mode 100644 index 000000000000..d0be9d6e5ef2 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreProjection.Serialization.cs @@ -0,0 +1,209 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerKnowledgeStoreProjection : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreProjection)} does not support writing '{format}' format."); + } + + if (Optional.IsCollectionDefined(Tables)) + { + writer.WritePropertyName("tables"u8); + writer.WriteStartArray(); + foreach (var item in Tables) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(Objects)) + { + writer.WritePropertyName("objects"u8); + writer.WriteStartArray(); + foreach (var item in Objects) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(Files)) + { + writer.WritePropertyName("files"u8); + writer.WriteStartArray(); + foreach (var item in Files) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexerKnowledgeStoreProjection IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreProjection)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerKnowledgeStoreProjection(document.RootElement, options); + } + + internal static SearchIndexerKnowledgeStoreProjection DeserializeSearchIndexerKnowledgeStoreProjection(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList tables = default; + IList objects = default; + IList files = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("tables"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SearchIndexerKnowledgeStoreTableProjectionSelector.DeserializeSearchIndexerKnowledgeStoreTableProjectionSelector(item, options)); + } + tables = array; + continue; + } + if (property.NameEquals("objects"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SearchIndexerKnowledgeStoreObjectProjectionSelector.DeserializeSearchIndexerKnowledgeStoreObjectProjectionSelector(item, options)); + } + objects = array; + continue; + } + if (property.NameEquals("files"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SearchIndexerKnowledgeStoreFileProjectionSelector.DeserializeSearchIndexerKnowledgeStoreFileProjectionSelector(item, options)); + } + files = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerKnowledgeStoreProjection(tables ?? new ChangeTrackingList(), objects ?? new ChangeTrackingList(), files ?? new ChangeTrackingList(), serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreProjection)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerKnowledgeStoreProjection IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStoreProjection(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreProjection)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerKnowledgeStoreProjection FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStoreProjection(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreProjection.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreProjection.cs new file mode 100644 index 000000000000..8356de32f018 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreProjection.cs @@ -0,0 +1,76 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Container object for various projection selectors. + public partial class SearchIndexerKnowledgeStoreProjection + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public SearchIndexerKnowledgeStoreProjection() + { + Tables = new ChangeTrackingList(); + Objects = new ChangeTrackingList(); + Files = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// Projections to Azure Table storage. + /// Projections to Azure Blob storage. + /// Projections to Azure File storage. + /// Keeps track of any properties unknown to the library. + internal SearchIndexerKnowledgeStoreProjection(IList tables, IList objects, IList files, IDictionary serializedAdditionalRawData) + { + Tables = tables; + Objects = objects; + Files = files; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Projections to Azure Table storage. + public IList Tables { get; } + /// Projections to Azure Blob storage. + public IList Objects { get; } + /// Projections to Azure File storage. + public IList Files { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreProjectionSelector.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreProjectionSelector.Serialization.cs new file mode 100644 index 000000000000..2eee1a29871e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreProjectionSelector.Serialization.cs @@ -0,0 +1,209 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerKnowledgeStoreProjectionSelector : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreProjectionSelector)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(ReferenceKeyName)) + { + writer.WritePropertyName("referenceKeyName"u8); + writer.WriteStringValue(ReferenceKeyName); + } + if (Optional.IsDefined(GeneratedKeyName)) + { + writer.WritePropertyName("generatedKeyName"u8); + writer.WriteStringValue(GeneratedKeyName); + } + if (Optional.IsDefined(Source)) + { + writer.WritePropertyName("source"u8); + writer.WriteStringValue(Source); + } + if (Optional.IsDefined(SourceContext)) + { + writer.WritePropertyName("sourceContext"u8); + writer.WriteStringValue(SourceContext); + } + if (Optional.IsCollectionDefined(Inputs)) + { + writer.WritePropertyName("inputs"u8); + writer.WriteStartArray(); + foreach (var item in Inputs) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexerKnowledgeStoreProjectionSelector IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreProjectionSelector)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerKnowledgeStoreProjectionSelector(document.RootElement, options); + } + + internal static SearchIndexerKnowledgeStoreProjectionSelector DeserializeSearchIndexerKnowledgeStoreProjectionSelector(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string referenceKeyName = default; + string generatedKeyName = default; + string source = default; + string sourceContext = default; + IList inputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("referenceKeyName"u8)) + { + referenceKeyName = property.Value.GetString(); + continue; + } + if (property.NameEquals("generatedKeyName"u8)) + { + generatedKeyName = property.Value.GetString(); + continue; + } + if (property.NameEquals("source"u8)) + { + source = property.Value.GetString(); + continue; + } + if (property.NameEquals("sourceContext"u8)) + { + sourceContext = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerKnowledgeStoreProjectionSelector( + referenceKeyName, + generatedKeyName, + source, + sourceContext, + inputs ?? new ChangeTrackingList(), + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreProjectionSelector)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerKnowledgeStoreProjectionSelector IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStoreProjectionSelector(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreProjectionSelector)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerKnowledgeStoreProjectionSelector FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStoreProjectionSelector(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreProjectionSelector.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreProjectionSelector.cs new file mode 100644 index 000000000000..a8ff35e57050 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreProjectionSelector.cs @@ -0,0 +1,82 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Abstract class to share properties between concrete selectors. + public partial class SearchIndexerKnowledgeStoreProjectionSelector + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public SearchIndexerKnowledgeStoreProjectionSelector() + { + Inputs = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// Name of reference key to different projection. + /// Name of generated key to store projection under. + /// Source data to project. + /// Source context for complex projections. + /// Nested inputs for complex projections. + /// Keeps track of any properties unknown to the library. + internal SearchIndexerKnowledgeStoreProjectionSelector(string referenceKeyName, string generatedKeyName, string source, string sourceContext, IList inputs, IDictionary serializedAdditionalRawData) + { + ReferenceKeyName = referenceKeyName; + GeneratedKeyName = generatedKeyName; + Source = source; + SourceContext = sourceContext; + Inputs = inputs; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Name of reference key to different projection. + public string ReferenceKeyName { get; set; } + /// Name of generated key to store projection under. + public string GeneratedKeyName { get; set; } + /// Source data to project. + public string Source { get; set; } + /// Source context for complex projections. + public string SourceContext { get; set; } + /// Nested inputs for complex projections. + public IList Inputs { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreTableProjectionSelector.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreTableProjectionSelector.Serialization.cs new file mode 100644 index 000000000000..e5e42c1bb84e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreTableProjectionSelector.Serialization.cs @@ -0,0 +1,174 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerKnowledgeStoreTableProjectionSelector : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreTableProjectionSelector)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("tableName"u8); + writer.WriteStringValue(TableName); + } + + SearchIndexerKnowledgeStoreTableProjectionSelector IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreTableProjectionSelector)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerKnowledgeStoreTableProjectionSelector(document.RootElement, options); + } + + internal static SearchIndexerKnowledgeStoreTableProjectionSelector DeserializeSearchIndexerKnowledgeStoreTableProjectionSelector(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string tableName = default; + string referenceKeyName = default; + string generatedKeyName = default; + string source = default; + string sourceContext = default; + IList inputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("tableName"u8)) + { + tableName = property.Value.GetString(); + continue; + } + if (property.NameEquals("referenceKeyName"u8)) + { + referenceKeyName = property.Value.GetString(); + continue; + } + if (property.NameEquals("generatedKeyName"u8)) + { + generatedKeyName = property.Value.GetString(); + continue; + } + if (property.NameEquals("source"u8)) + { + source = property.Value.GetString(); + continue; + } + if (property.NameEquals("sourceContext"u8)) + { + sourceContext = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerKnowledgeStoreTableProjectionSelector( + referenceKeyName, + generatedKeyName, + source, + sourceContext, + inputs ?? new ChangeTrackingList(), + serializedAdditionalRawData, + tableName); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreTableProjectionSelector)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerKnowledgeStoreTableProjectionSelector IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStoreTableProjectionSelector(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerKnowledgeStoreTableProjectionSelector)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new SearchIndexerKnowledgeStoreTableProjectionSelector FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerKnowledgeStoreTableProjectionSelector(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreTableProjectionSelector.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreTableProjectionSelector.cs new file mode 100644 index 000000000000..0aed056e8809 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerKnowledgeStoreTableProjectionSelector.cs @@ -0,0 +1,47 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Description for what data to store in Azure Tables. + public partial class SearchIndexerKnowledgeStoreTableProjectionSelector : SearchIndexerKnowledgeStoreProjectionSelector + { + /// Initializes a new instance of . + /// Name of the Azure table to store projected data in. + /// is null. + public SearchIndexerKnowledgeStoreTableProjectionSelector(string tableName) + { + Argument.AssertNotNull(tableName, nameof(tableName)); + + TableName = tableName; + } + + /// Initializes a new instance of . + /// Name of reference key to different projection. + /// Name of generated key to store projection under. + /// Source data to project. + /// Source context for complex projections. + /// Nested inputs for complex projections. + /// Keeps track of any properties unknown to the library. + /// Name of the Azure table to store projected data in. + internal SearchIndexerKnowledgeStoreTableProjectionSelector(string referenceKeyName, string generatedKeyName, string source, string sourceContext, IList inputs, IDictionary serializedAdditionalRawData, string tableName) : base(referenceKeyName, generatedKeyName, source, sourceContext, inputs, serializedAdditionalRawData) + { + TableName = tableName; + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexerKnowledgeStoreTableProjectionSelector() + { + } + + /// Name of the Azure table to store projected data in. + public string TableName { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerLimits.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerLimits.Serialization.cs new file mode 100644 index 000000000000..2c4d50e4f2ff --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerLimits.Serialization.cs @@ -0,0 +1,179 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerLimits : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerLimits)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(MaxRunTime)) + { + writer.WritePropertyName("maxRunTime"u8); + writer.WriteStringValue(MaxRunTime.Value, "P"); + } + if (Optional.IsDefined(MaxDocumentExtractionSize)) + { + writer.WritePropertyName("maxDocumentExtractionSize"u8); + writer.WriteNumberValue(MaxDocumentExtractionSize.Value); + } + if (Optional.IsDefined(MaxDocumentContentCharactersToExtract)) + { + writer.WritePropertyName("maxDocumentContentCharactersToExtract"u8); + writer.WriteNumberValue(MaxDocumentContentCharactersToExtract.Value); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexerLimits IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerLimits)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerLimits(document.RootElement, options); + } + + internal static SearchIndexerLimits DeserializeSearchIndexerLimits(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + TimeSpan? maxRunTime = default; + long? maxDocumentExtractionSize = default; + long? maxDocumentContentCharactersToExtract = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("maxRunTime"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxRunTime = property.Value.GetTimeSpan("P"); + continue; + } + if (property.NameEquals("maxDocumentExtractionSize"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxDocumentExtractionSize = property.Value.GetInt64(); + continue; + } + if (property.NameEquals("maxDocumentContentCharactersToExtract"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxDocumentContentCharactersToExtract = property.Value.GetInt64(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerLimits(maxRunTime, maxDocumentExtractionSize, maxDocumentContentCharactersToExtract, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerLimits)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerLimits IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerLimits(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerLimits)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerLimits FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerLimits(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerLimits.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerLimits.cs new file mode 100644 index 000000000000..7972cfa23f7f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerLimits.cs @@ -0,0 +1,85 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents the limits that can be applied to an indexer. + public partial class SearchIndexerLimits + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + internal SearchIndexerLimits() + { + } + + /// Initializes a new instance of . + /// The maximum duration that the indexer is permitted to run for one execution. + /// + /// The maximum size of a document, in bytes, which will be considered valid for + /// indexing. + /// + /// + /// The maximum number of characters that will be extracted from a document picked + /// up for indexing. + /// + /// Keeps track of any properties unknown to the library. + internal SearchIndexerLimits(TimeSpan? maxRunTime, long? maxDocumentExtractionSize, long? maxDocumentContentCharactersToExtract, IDictionary serializedAdditionalRawData) + { + MaxRunTime = maxRunTime; + MaxDocumentExtractionSize = maxDocumentExtractionSize; + MaxDocumentContentCharactersToExtract = maxDocumentContentCharactersToExtract; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The maximum duration that the indexer is permitted to run for one execution. + public TimeSpan? MaxRunTime { get; } + /// + /// The maximum size of a document, in bytes, which will be considered valid for + /// indexing. + /// + public long? MaxDocumentExtractionSize { get; } + /// + /// The maximum number of characters that will be extracted from a document picked + /// up for indexing. + /// + public long? MaxDocumentContentCharactersToExtract { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerSkill.Serialization.cs new file mode 100644 index 000000000000..8760b4cc7909 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerSkill.Serialization.cs @@ -0,0 +1,183 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + [PersistableModelProxy(typeof(UnknownSearchIndexerSkill))] + public partial class SearchIndexerSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerSkill)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("@odata.type"u8); + writer.WriteStringValue(OdataType); + if (Optional.IsDefined(Name)) + { + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + } + if (Optional.IsDefined(Description)) + { + writer.WritePropertyName("description"u8); + writer.WriteStringValue(Description); + } + if (Optional.IsDefined(Context)) + { + writer.WritePropertyName("context"u8); + writer.WriteStringValue(Context); + } + writer.WritePropertyName("inputs"u8); + writer.WriteStartArray(); + foreach (var item in Inputs) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + writer.WritePropertyName("outputs"u8); + writer.WriteStartArray(); + foreach (var item in Outputs) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexerSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerSkill(document.RootElement, options); + } + + internal static SearchIndexerSkill DeserializeSearchIndexerSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("@odata.type", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "#Microsoft.Skills.Custom.AmlSkill": return AzureMachineLearningSkill.DeserializeAzureMachineLearningSkill(element, options); + case "#Microsoft.Skills.Custom.WebApiSkill": return WebApiSkill.DeserializeWebApiSkill(element, options); + case "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill": return AzureOpenAIEmbeddingSkill.DeserializeAzureOpenAIEmbeddingSkill(element, options); + case "#Microsoft.Skills.Text.CustomEntityLookupSkill": return CustomEntityLookupSkill.DeserializeCustomEntityLookupSkill(element, options); + case "#Microsoft.Skills.Text.EntityRecognitionSkill": return EntityRecognitionSkill.DeserializeEntityRecognitionSkill(element, options); + case "#Microsoft.Skills.Text.KeyPhraseExtractionSkill": return KeyPhraseExtractionSkill.DeserializeKeyPhraseExtractionSkill(element, options); + case "#Microsoft.Skills.Text.LanguageDetectionSkill": return LanguageDetectionSkill.DeserializeLanguageDetectionSkill(element, options); + case "#Microsoft.Skills.Text.MergeSkill": return MergeSkill.DeserializeMergeSkill(element, options); + case "#Microsoft.Skills.Text.PIIDetectionSkill": return PIIDetectionSkill.DeserializePIIDetectionSkill(element, options); + case "#Microsoft.Skills.Text.SentimentSkill": return SentimentSkill.DeserializeSentimentSkill(element, options); + case "#Microsoft.Skills.Text.SplitSkill": return SplitSkill.DeserializeSplitSkill(element, options); + case "#Microsoft.Skills.Text.TranslationSkill": return TextTranslationSkill.DeserializeTextTranslationSkill(element, options); + case "#Microsoft.Skills.Text.V3.EntityLinkingSkill": return EntityLinkingSkill.DeserializeEntityLinkingSkill(element, options); + case "#Microsoft.Skills.Text.V3.EntityRecognitionSkill": return EntityRecognitionSkillV3.DeserializeEntityRecognitionSkillV3(element, options); + case "#Microsoft.Skills.Text.V3.SentimentSkill": return SentimentSkillV3.DeserializeSentimentSkillV3(element, options); + case "#Microsoft.Skills.Util.ConditionalSkill": return ConditionalSkill.DeserializeConditionalSkill(element, options); + case "#Microsoft.Skills.Util.DocumentExtractionSkill": return DocumentExtractionSkill.DeserializeDocumentExtractionSkill(element, options); + case "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill": return DocumentIntelligenceLayoutSkill.DeserializeDocumentIntelligenceLayoutSkill(element, options); + case "#Microsoft.Skills.Util.ShaperSkill": return ShaperSkill.DeserializeShaperSkill(element, options); + case "#Microsoft.Skills.Vision.ImageAnalysisSkill": return ImageAnalysisSkill.DeserializeImageAnalysisSkill(element, options); + case "#Microsoft.Skills.Vision.OcrSkill": return OcrSkill.DeserializeOcrSkill(element, options); + case "#Microsoft.Skills.Vision.VectorizeSkill": return VisionVectorizeSkill.DeserializeVisionVectorizeSkill(element, options); + } + } + return UnknownSearchIndexerSkill.DeserializeUnknownSearchIndexerSkill(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerSkill)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerSkill(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerSkill.cs new file mode 100644 index 000000000000..3e13853b2516 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerSkill.cs @@ -0,0 +1,143 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Base type for 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 abstract partial class SearchIndexerSkill + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + protected SearchIndexerSkill(IEnumerable inputs, IEnumerable outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + Inputs = inputs.ToList(); + Outputs = outputs.ToList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal SearchIndexerSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData) + { + OdataType = odataType; + Name = name; + Description = description; + Context = context; + Inputs = inputs; + Outputs = outputs; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexerSkill() + { + } + + /// The discriminator for derived types. + internal string OdataType { get; set; } + /// + /// 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 '#'. + /// + public string Name { get; set; } + /// + /// The description of the skill which describes the inputs, outputs, and usage of + /// the skill. + /// + public string Description { get; set; } + /// + /// 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. + /// + public string Context { get; set; } + /// + /// Inputs of the skills could be a column in the source data set, or the output of + /// an upstream skill. + /// + public IList Inputs { get; } + /// + /// 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. + /// + public IList Outputs { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerSkillset.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerSkillset.Serialization.cs new file mode 100644 index 000000000000..2309916730de --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerSkillset.Serialization.cs @@ -0,0 +1,251 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerSkillset : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerSkillset)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + if (Optional.IsDefined(Description)) + { + writer.WritePropertyName("description"u8); + writer.WriteStringValue(Description); + } + writer.WritePropertyName("skills"u8); + writer.WriteStartArray(); + foreach (var item in Skills) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (Optional.IsDefined(CognitiveServices)) + { + writer.WritePropertyName("cognitiveServices"u8); + writer.WriteObjectValue(CognitiveServices, options); + } + if (Optional.IsDefined(KnowledgeStore)) + { + writer.WritePropertyName("knowledgeStore"u8); + writer.WriteObjectValue(KnowledgeStore, options); + } + if (Optional.IsDefined(IndexProjections)) + { + writer.WritePropertyName("indexProjections"u8); + writer.WriteObjectValue(IndexProjections, options); + } + if (Optional.IsDefined(ETag)) + { + writer.WritePropertyName("@odata.etag"u8); + writer.WriteStringValue(ETag); + } + if (Optional.IsDefined(EncryptionKey)) + { + writer.WritePropertyName("encryptionKey"u8); + writer.WriteObjectValue(EncryptionKey, options); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexerSkillset IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerSkillset)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerSkillset(document.RootElement, options); + } + + internal static SearchIndexerSkillset DeserializeSearchIndexerSkillset(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + string description = default; + IList skills = default; + CognitiveServicesAccount cognitiveServices = default; + SearchIndexerKnowledgeStore knowledgeStore = default; + SearchIndexerIndexProjection indexProjections = default; + string odataEtag = default; + SearchResourceEncryptionKey encryptionKey = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("skills"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SearchIndexerSkill.DeserializeSearchIndexerSkill(item, options)); + } + skills = array; + continue; + } + if (property.NameEquals("cognitiveServices"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + cognitiveServices = CognitiveServicesAccount.DeserializeCognitiveServicesAccount(property.Value, options); + continue; + } + if (property.NameEquals("knowledgeStore"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + knowledgeStore = SearchIndexerKnowledgeStore.DeserializeSearchIndexerKnowledgeStore(property.Value, options); + continue; + } + if (property.NameEquals("indexProjections"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + indexProjections = SearchIndexerIndexProjection.DeserializeSearchIndexerIndexProjection(property.Value, options); + continue; + } + if (property.NameEquals("@odata.etag"u8)) + { + odataEtag = property.Value.GetString(); + continue; + } + if (property.NameEquals("encryptionKey"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + encryptionKey = SearchResourceEncryptionKey.DeserializeSearchResourceEncryptionKey(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerSkillset( + name, + description, + skills, + cognitiveServices, + knowledgeStore, + indexProjections, + odataEtag, + encryptionKey, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerSkillset)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerSkillset IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerSkillset(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerSkillset)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerSkillset FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerSkillset(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerSkillset.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerSkillset.cs new file mode 100644 index 000000000000..bfb4f3e61ec2 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerSkillset.cs @@ -0,0 +1,155 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// A list of skills. + public partial class SearchIndexerSkillset + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name of the skillset. + /// + /// A list of skills in the 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 . + /// + /// or is null. + public SearchIndexerSkillset(string name, IEnumerable skills) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(skills, nameof(skills)); + + Name = name; + Skills = skills.ToList(); + } + + /// Initializes a new instance of . + /// The name of the skillset. + /// The description of the skillset. + /// + /// A list of skills in the 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 . + /// + /// + /// 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 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. 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. + /// + /// Keeps track of any properties unknown to the library. + internal SearchIndexerSkillset(string name, string description, IList skills, CognitiveServicesAccount cognitiveServices, SearchIndexerKnowledgeStore knowledgeStore, SearchIndexerIndexProjection indexProjections, string eTag, SearchResourceEncryptionKey encryptionKey, IDictionary serializedAdditionalRawData) + { + Name = name; + Description = description; + Skills = skills; + CognitiveServices = cognitiveServices; + KnowledgeStore = knowledgeStore; + IndexProjections = indexProjections; + ETag = eTag; + EncryptionKey = encryptionKey; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexerSkillset() + { + } + + /// The name of the skillset. + public string Name { get; set; } + /// The description of the skillset. + public string Description { get; set; } + /// + /// A list of skills in the 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 IList Skills { get; } + /// + /// 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 CognitiveServices { get; set; } + /// + /// Definition of additional projections to Azure blob, table, or files, of + /// enriched data. + /// + public SearchIndexerKnowledgeStore KnowledgeStore { get; set; } + /// Definition of additional projections to secondary search index(es). + public SearchIndexerIndexProjection IndexProjections { get; set; } + /// The ETag of the skillset. + public string ETag { 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. 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.Indexes/src/Generated/SearchIndexerStatus.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerStatus.Serialization.cs new file mode 100644 index 000000000000..14a0c5007de1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerStatus.Serialization.cs @@ -0,0 +1,183 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerStatus : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerStatus)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("status"u8); + writer.WriteStringValue(Status.ToString()); + if (Optional.IsDefined(LastResult)) + { + writer.WritePropertyName("lastResult"u8); + writer.WriteObjectValue(LastResult, options); + } + writer.WritePropertyName("executionHistory"u8); + writer.WriteStartArray(); + foreach (var item in ExecutionHistory) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + writer.WritePropertyName("limits"u8); + writer.WriteObjectValue(Limits, options); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexerStatus IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerStatus)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerStatus(document.RootElement, options); + } + + internal static SearchIndexerStatus DeserializeSearchIndexerStatus(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IndexerStatus status = default; + IndexerExecutionResult lastResult = default; + IReadOnlyList executionHistory = default; + SearchIndexerLimits limits = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("status"u8)) + { + status = new IndexerStatus(property.Value.GetString()); + continue; + } + if (property.NameEquals("lastResult"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + lastResult = IndexerExecutionResult.DeserializeIndexerExecutionResult(property.Value, options); + continue; + } + if (property.NameEquals("executionHistory"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(IndexerExecutionResult.DeserializeIndexerExecutionResult(item, options)); + } + executionHistory = array; + continue; + } + if (property.NameEquals("limits"u8)) + { + limits = SearchIndexerLimits.DeserializeSearchIndexerLimits(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerStatus(status, lastResult, executionHistory, limits, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerStatus)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerStatus IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerStatus(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerStatus)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerStatus FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerStatus(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerStatus.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerStatus.cs new file mode 100644 index 000000000000..42c757cb61c2 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerStatus.cs @@ -0,0 +1,93 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents the current status and execution history of an indexer. + public partial class SearchIndexerStatus + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// Overall indexer status. + /// History of the recent indexer executions, sorted in reverse chronological order. + /// The execution limits for the indexer. + /// or is null. + internal SearchIndexerStatus(IndexerStatus status, IEnumerable executionHistory, SearchIndexerLimits limits) + { + Argument.AssertNotNull(executionHistory, nameof(executionHistory)); + Argument.AssertNotNull(limits, nameof(limits)); + + Status = status; + ExecutionHistory = executionHistory.ToList(); + Limits = limits; + } + + /// Initializes a new instance of . + /// Overall indexer status. + /// The result of the most recent or an in-progress indexer execution. + /// History of the recent indexer executions, sorted in reverse chronological order. + /// The execution limits for the indexer. + /// Keeps track of any properties unknown to the library. + internal SearchIndexerStatus(IndexerStatus status, IndexerExecutionResult lastResult, IReadOnlyList executionHistory, SearchIndexerLimits limits, IDictionary serializedAdditionalRawData) + { + Status = status; + LastResult = lastResult; + ExecutionHistory = executionHistory; + Limits = limits; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexerStatus() + { + } + + /// Overall indexer status. + public IndexerStatus Status { get; } + /// The result of the most recent or an in-progress indexer execution. + public IndexerExecutionResult LastResult { get; } + /// History of the recent indexer executions, sorted in reverse chronological order. + public IReadOnlyList ExecutionHistory { get; } + /// The execution limits for the indexer. + public SearchIndexerLimits Limits { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerWarning.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerWarning.Serialization.cs new file mode 100644 index 000000000000..ef234178421b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerWarning.Serialization.cs @@ -0,0 +1,192 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchIndexerWarning : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerWarning)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(Key)) + { + writer.WritePropertyName("key"u8); + writer.WriteStringValue(Key); + } + writer.WritePropertyName("message"u8); + writer.WriteStringValue(Message); + if (Optional.IsDefined(Name)) + { + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + } + if (Optional.IsDefined(Details)) + { + writer.WritePropertyName("details"u8); + writer.WriteStringValue(Details); + } + if (Optional.IsDefined(DocumentationLink)) + { + writer.WritePropertyName("documentationLink"u8); + writer.WriteStringValue(DocumentationLink); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchIndexerWarning IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerWarning)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerWarning(document.RootElement, options); + } + + internal static SearchIndexerWarning DeserializeSearchIndexerWarning(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string key = default; + string message = default; + string name = default; + string details = default; + string documentationLink = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("key"u8)) + { + key = property.Value.GetString(); + continue; + } + if (property.NameEquals("message"u8)) + { + message = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("details"u8)) + { + details = property.Value.GetString(); + continue; + } + if (property.NameEquals("documentationLink"u8)) + { + documentationLink = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchIndexerWarning( + key, + message, + name, + details, + documentationLink, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerWarning)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerWarning IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerWarning(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerWarning)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchIndexerWarning FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerWarning(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerWarning.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerWarning.cs new file mode 100644 index 000000000000..aae1794c0a49 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchIndexerWarning.cs @@ -0,0 +1,111 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents an item-level warning. + public partial class SearchIndexerWarning + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The message describing the warning that occurred while processing the item. + /// is null. + internal SearchIndexerWarning(string message) + { + Argument.AssertNotNull(message, nameof(message)); + + Message = message; + } + + /// Initializes a new instance of . + /// The key of the item which generated a warning. + /// The message describing the warning that occurred while processing the item. + /// + /// The name of the source at which the warning originated. For example, this could + /// refer to a particular skill in the attached skillset. This may not be always + /// available. + /// + /// + /// Additional, verbose details about the warning to assist in debugging the + /// indexer. This may not be always available. + /// + /// + /// A link to a troubleshooting guide for these classes of warnings. This may not + /// be always available. + /// + /// Keeps track of any properties unknown to the library. + internal SearchIndexerWarning(string key, string message, string name, string details, string documentationLink, IDictionary serializedAdditionalRawData) + { + Key = key; + Message = message; + Name = name; + Details = details; + DocumentationLink = documentationLink; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchIndexerWarning() + { + } + + /// The key of the item which generated a warning. + public string Key { get; } + /// The message describing the warning that occurred while processing the item. + public string Message { get; } + /// + /// The name of the source at which the warning originated. For example, this could + /// refer to a particular skill in the attached skillset. This may not be always + /// available. + /// + public string Name { get; } + /// + /// Additional, verbose details about the warning to assist in debugging the + /// indexer. This may not be always available. + /// + public string Details { get; } + /// + /// A link to a troubleshooting guide for these classes of warnings. This may not + /// be always available. + /// + public string DocumentationLink { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchResourceEncryptionKey.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchResourceEncryptionKey.Serialization.cs new file mode 100644 index 000000000000..6902076d96a1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchResourceEncryptionKey.Serialization.cs @@ -0,0 +1,197 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchResourceEncryptionKey : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchResourceEncryptionKey)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("keyVaultKeyName"u8); + writer.WriteStringValue(KeyVaultKeyName); + if (Optional.IsDefined(KeyVaultKeyVersion)) + { + writer.WritePropertyName("keyVaultKeyVersion"u8); + writer.WriteStringValue(KeyVaultKeyVersion); + } + writer.WritePropertyName("keyVaultUri"u8); + writer.WriteStringValue(KeyVaultUri); + if (Optional.IsDefined(AccessCredentials)) + { + writer.WritePropertyName("accessCredentials"u8); + writer.WriteObjectValue(AccessCredentials, options); + } + if (Optional.IsDefined(Identity)) + { + writer.WritePropertyName("identity"u8); + writer.WriteObjectValue(Identity, options); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchResourceEncryptionKey IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchResourceEncryptionKey)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchResourceEncryptionKey(document.RootElement, options); + } + + internal static SearchResourceEncryptionKey DeserializeSearchResourceEncryptionKey(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string keyVaultKeyName = default; + string keyVaultKeyVersion = default; + string keyVaultUri = default; + AzureActiveDirectoryApplicationCredentials accessCredentials = default; + SearchIndexerDataIdentity identity = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("keyVaultKeyName"u8)) + { + keyVaultKeyName = property.Value.GetString(); + continue; + } + if (property.NameEquals("keyVaultKeyVersion"u8)) + { + keyVaultKeyVersion = property.Value.GetString(); + continue; + } + if (property.NameEquals("keyVaultUri"u8)) + { + keyVaultUri = property.Value.GetString(); + continue; + } + if (property.NameEquals("accessCredentials"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + accessCredentials = AzureActiveDirectoryApplicationCredentials.DeserializeAzureActiveDirectoryApplicationCredentials(property.Value, options); + continue; + } + if (property.NameEquals("identity"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + identity = SearchIndexerDataIdentity.DeserializeSearchIndexerDataIdentity(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchResourceEncryptionKey( + keyVaultKeyName, + keyVaultKeyVersion, + keyVaultUri, + accessCredentials, + identity, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchResourceEncryptionKey)} does not support writing '{options.Format}' format."); + } + } + + SearchResourceEncryptionKey IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchResourceEncryptionKey(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchResourceEncryptionKey)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchResourceEncryptionKey FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchResourceEncryptionKey(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchResourceEncryptionKey.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchResourceEncryptionKey.cs new file mode 100644 index 000000000000..855ca9f40ec5 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchResourceEncryptionKey.cs @@ -0,0 +1,132 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// 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 + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name 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`. + /// + /// or is null. + public SearchResourceEncryptionKey(string keyVaultKeyName, string keyVaultUri) + { + Argument.AssertNotNull(keyVaultKeyName, nameof(keyVaultKeyName)); + Argument.AssertNotNull(keyVaultUri, nameof(keyVaultUri)); + + KeyVaultKeyName = keyVaultKeyName; + KeyVaultUri = keyVaultUri; + } + + /// Initializes a new instance of . + /// 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`. + /// + /// + /// 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. + /// 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 . + /// + /// Keeps track of any properties unknown to the library. + internal SearchResourceEncryptionKey(string keyVaultKeyName, string keyVaultKeyVersion, string keyVaultUri, AzureActiveDirectoryApplicationCredentials accessCredentials, SearchIndexerDataIdentity identity, IDictionary serializedAdditionalRawData) + { + KeyVaultKeyName = keyVaultKeyName; + KeyVaultKeyVersion = keyVaultKeyVersion; + KeyVaultUri = keyVaultUri; + AccessCredentials = accessCredentials; + Identity = identity; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchResourceEncryptionKey() + { + } + + /// The name of your Azure Key Vault key to be used to encrypt your data at rest. + public string KeyVaultKeyName { get; set; } + /// The version of your Azure Key Vault key to be used to encrypt your data at rest. + public string KeyVaultKeyVersion { get; set; } + /// + /// 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`. + /// + public string KeyVaultUri { get; set; } + /// + /// Optional Azure Active Directory credentials used for accessing your Azure Key + /// Vault. Not required if using managed identity instead. + /// + public AzureActiveDirectoryApplicationCredentials AccessCredentials { get; set; } + /// + /// 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. + /// 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 SearchIndexerDataIdentity Identity { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceCounters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceCounters.Serialization.cs new file mode 100644 index 000000000000..7bb6b00e39b1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceCounters.Serialization.cs @@ -0,0 +1,216 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchServiceCounters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchServiceCounters)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("aliasesCount"u8); + writer.WriteObjectValue(AliasesCount, options); + writer.WritePropertyName("documentCount"u8); + writer.WriteObjectValue(DocumentCount, options); + writer.WritePropertyName("indexesCount"u8); + writer.WriteObjectValue(IndexesCount, options); + writer.WritePropertyName("indexersCount"u8); + writer.WriteObjectValue(IndexersCount, options); + writer.WritePropertyName("dataSourcesCount"u8); + writer.WriteObjectValue(DataSourcesCount, options); + writer.WritePropertyName("storageSize"u8); + writer.WriteObjectValue(StorageSize, options); + writer.WritePropertyName("synonymMaps"u8); + writer.WriteObjectValue(SynonymMaps, options); + writer.WritePropertyName("skillsetCount"u8); + writer.WriteObjectValue(SkillsetCount, options); + writer.WritePropertyName("vectorIndexSize"u8); + writer.WriteObjectValue(VectorIndexSize, options); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchServiceCounters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchServiceCounters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchServiceCounters(document.RootElement, options); + } + + internal static SearchServiceCounters DeserializeSearchServiceCounters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + ResourceCounter aliasesCount = default; + ResourceCounter documentCount = default; + ResourceCounter indexesCount = default; + ResourceCounter indexersCount = default; + ResourceCounter dataSourcesCount = default; + ResourceCounter storageSize = default; + ResourceCounter synonymMaps = default; + ResourceCounter skillsetCount = default; + ResourceCounter vectorIndexSize = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("aliasesCount"u8)) + { + aliasesCount = ResourceCounter.DeserializeResourceCounter(property.Value, options); + continue; + } + if (property.NameEquals("documentCount"u8)) + { + documentCount = ResourceCounter.DeserializeResourceCounter(property.Value, options); + continue; + } + if (property.NameEquals("indexesCount"u8)) + { + indexesCount = ResourceCounter.DeserializeResourceCounter(property.Value, options); + continue; + } + if (property.NameEquals("indexersCount"u8)) + { + indexersCount = ResourceCounter.DeserializeResourceCounter(property.Value, options); + continue; + } + if (property.NameEquals("dataSourcesCount"u8)) + { + dataSourcesCount = ResourceCounter.DeserializeResourceCounter(property.Value, options); + continue; + } + if (property.NameEquals("storageSize"u8)) + { + storageSize = ResourceCounter.DeserializeResourceCounter(property.Value, options); + continue; + } + if (property.NameEquals("synonymMaps"u8)) + { + synonymMaps = ResourceCounter.DeserializeResourceCounter(property.Value, options); + continue; + } + if (property.NameEquals("skillsetCount"u8)) + { + skillsetCount = ResourceCounter.DeserializeResourceCounter(property.Value, options); + continue; + } + if (property.NameEquals("vectorIndexSize"u8)) + { + vectorIndexSize = ResourceCounter.DeserializeResourceCounter(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchServiceCounters( + aliasesCount, + documentCount, + indexesCount, + indexersCount, + dataSourcesCount, + storageSize, + synonymMaps, + skillsetCount, + vectorIndexSize, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchServiceCounters)} does not support writing '{options.Format}' format."); + } + } + + SearchServiceCounters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchServiceCounters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchServiceCounters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchServiceCounters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchServiceCounters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceCounters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceCounters.cs new file mode 100644 index 000000000000..ee2122fe00ab --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceCounters.cs @@ -0,0 +1,131 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents service-level resource counters and quotas. + public partial class SearchServiceCounters + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// Total number of aliases. + /// Total number of documents across all indexes in the service. + /// Total number of indexes. + /// Total number of indexers. + /// Total number of data sources. + /// Total size of used storage in bytes. + /// Total number of synonym maps. + /// Total number of skillsets. + /// Total memory consumption of all vector indexes within the service, in bytes. + /// , , , , , , , or is null. + internal SearchServiceCounters(ResourceCounter aliasesCount, ResourceCounter documentCount, ResourceCounter indexesCount, ResourceCounter indexersCount, ResourceCounter dataSourcesCount, ResourceCounter storageSize, ResourceCounter synonymMaps, ResourceCounter skillsetCount, ResourceCounter vectorIndexSize) + { + Argument.AssertNotNull(aliasesCount, nameof(aliasesCount)); + Argument.AssertNotNull(documentCount, nameof(documentCount)); + Argument.AssertNotNull(indexesCount, nameof(indexesCount)); + Argument.AssertNotNull(indexersCount, nameof(indexersCount)); + Argument.AssertNotNull(dataSourcesCount, nameof(dataSourcesCount)); + Argument.AssertNotNull(storageSize, nameof(storageSize)); + Argument.AssertNotNull(synonymMaps, nameof(synonymMaps)); + Argument.AssertNotNull(skillsetCount, nameof(skillsetCount)); + Argument.AssertNotNull(vectorIndexSize, nameof(vectorIndexSize)); + + AliasesCount = aliasesCount; + DocumentCount = documentCount; + IndexesCount = indexesCount; + IndexersCount = indexersCount; + DataSourcesCount = dataSourcesCount; + StorageSize = storageSize; + SynonymMaps = synonymMaps; + SkillsetCount = skillsetCount; + VectorIndexSize = vectorIndexSize; + } + + /// Initializes a new instance of . + /// Total number of aliases. + /// Total number of documents across all indexes in the service. + /// Total number of indexes. + /// Total number of indexers. + /// Total number of data sources. + /// Total size of used storage in bytes. + /// Total number of synonym maps. + /// Total number of skillsets. + /// Total memory consumption of all vector indexes within the service, in bytes. + /// Keeps track of any properties unknown to the library. + internal SearchServiceCounters(ResourceCounter aliasesCount, ResourceCounter documentCount, ResourceCounter indexesCount, ResourceCounter indexersCount, ResourceCounter dataSourcesCount, ResourceCounter storageSize, ResourceCounter synonymMaps, ResourceCounter skillsetCount, ResourceCounter vectorIndexSize, IDictionary serializedAdditionalRawData) + { + AliasesCount = aliasesCount; + DocumentCount = documentCount; + IndexesCount = indexesCount; + IndexersCount = indexersCount; + DataSourcesCount = dataSourcesCount; + StorageSize = storageSize; + SynonymMaps = synonymMaps; + SkillsetCount = skillsetCount; + VectorIndexSize = vectorIndexSize; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchServiceCounters() + { + } + + /// Total number of aliases. + public ResourceCounter AliasesCount { get; } + /// Total number of documents across all indexes in the service. + public ResourceCounter DocumentCount { get; } + /// Total number of indexes. + public ResourceCounter IndexesCount { get; } + /// Total number of indexers. + public ResourceCounter IndexersCount { get; } + /// Total number of data sources. + public ResourceCounter DataSourcesCount { get; } + /// Total size of used storage in bytes. + public ResourceCounter StorageSize { get; } + /// Total number of synonym maps. + public ResourceCounter SynonymMaps { get; } + /// Total number of skillsets. + public ResourceCounter SkillsetCount { get; } + /// Total memory consumption of all vector indexes within the service, in bytes. + public ResourceCounter VectorIndexSize { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceLimits.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceLimits.Serialization.cs new file mode 100644 index 000000000000..ebf9ce865e4c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceLimits.Serialization.cs @@ -0,0 +1,215 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchServiceLimits : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchServiceLimits)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(MaxFieldsPerIndex)) + { + writer.WritePropertyName("maxFieldsPerIndex"u8); + writer.WriteNumberValue(MaxFieldsPerIndex.Value); + } + if (Optional.IsDefined(MaxFieldNestingDepthPerIndex)) + { + writer.WritePropertyName("maxFieldNestingDepthPerIndex"u8); + writer.WriteNumberValue(MaxFieldNestingDepthPerIndex.Value); + } + if (Optional.IsDefined(MaxComplexCollectionFieldsPerIndex)) + { + writer.WritePropertyName("maxComplexCollectionFieldsPerIndex"u8); + writer.WriteNumberValue(MaxComplexCollectionFieldsPerIndex.Value); + } + if (Optional.IsDefined(MaxComplexObjectsInCollectionsPerDocument)) + { + writer.WritePropertyName("maxComplexObjectsInCollectionsPerDocument"u8); + writer.WriteNumberValue(MaxComplexObjectsInCollectionsPerDocument.Value); + } + if (Optional.IsDefined(MaxStoragePerIndex)) + { + writer.WritePropertyName("maxStoragePerIndex"u8); + writer.WriteNumberValue(MaxStoragePerIndex.Value); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchServiceLimits IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchServiceLimits)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchServiceLimits(document.RootElement, options); + } + + internal static SearchServiceLimits DeserializeSearchServiceLimits(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? maxFieldsPerIndex = default; + int? maxFieldNestingDepthPerIndex = default; + int? maxComplexCollectionFieldsPerIndex = default; + int? maxComplexObjectsInCollectionsPerDocument = default; + long? maxStoragePerIndex = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("maxFieldsPerIndex"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxFieldsPerIndex = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("maxFieldNestingDepthPerIndex"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxFieldNestingDepthPerIndex = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("maxComplexCollectionFieldsPerIndex"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxComplexCollectionFieldsPerIndex = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("maxComplexObjectsInCollectionsPerDocument"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxComplexObjectsInCollectionsPerDocument = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("maxStoragePerIndex"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxStoragePerIndex = property.Value.GetInt64(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchServiceLimits( + maxFieldsPerIndex, + maxFieldNestingDepthPerIndex, + maxComplexCollectionFieldsPerIndex, + maxComplexObjectsInCollectionsPerDocument, + maxStoragePerIndex, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchServiceLimits)} does not support writing '{options.Format}' format."); + } + } + + SearchServiceLimits IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchServiceLimits(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchServiceLimits)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchServiceLimits FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchServiceLimits(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceLimits.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceLimits.cs new file mode 100644 index 000000000000..2862da463701 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceLimits.cs @@ -0,0 +1,93 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents various service level limits. + public partial class SearchServiceLimits + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + internal SearchServiceLimits() + { + } + + /// Initializes a new instance of . + /// The maximum allowed fields per index. + /// + /// The maximum depth which you can nest sub-fields in an index, including the + /// top-level complex field. For example, a/b/c has a nesting depth of 3. + /// + /// + /// The maximum number of fields of type Collection(Edm.ComplexType) allowed in an + /// index. + /// + /// The maximum number of objects in complex collections allowed per document. + /// The maximum amount of storage in bytes allowed per index. + /// Keeps track of any properties unknown to the library. + internal SearchServiceLimits(int? maxFieldsPerIndex, int? maxFieldNestingDepthPerIndex, int? maxComplexCollectionFieldsPerIndex, int? maxComplexObjectsInCollectionsPerDocument, long? maxStoragePerIndex, IDictionary serializedAdditionalRawData) + { + MaxFieldsPerIndex = maxFieldsPerIndex; + MaxFieldNestingDepthPerIndex = maxFieldNestingDepthPerIndex; + MaxComplexCollectionFieldsPerIndex = maxComplexCollectionFieldsPerIndex; + MaxComplexObjectsInCollectionsPerDocument = maxComplexObjectsInCollectionsPerDocument; + MaxStoragePerIndex = maxStoragePerIndex; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The maximum allowed fields per index. + public int? MaxFieldsPerIndex { get; } + /// + /// The maximum depth which you can nest sub-fields in an index, including the + /// top-level complex field. For example, a/b/c has a nesting depth of 3. + /// + public int? MaxFieldNestingDepthPerIndex { get; } + /// + /// The maximum number of fields of type Collection(Edm.ComplexType) allowed in an + /// index. + /// + public int? MaxComplexCollectionFieldsPerIndex { get; } + /// The maximum number of objects in complex collections allowed per document. + public int? MaxComplexObjectsInCollectionsPerDocument { get; } + /// The maximum amount of storage in bytes allowed per index. + public long? MaxStoragePerIndex { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceStatistics.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceStatistics.Serialization.cs new file mode 100644 index 000000000000..3b372eafe880 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceStatistics.Serialization.cs @@ -0,0 +1,150 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchServiceStatistics : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchServiceStatistics)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("counters"u8); + writer.WriteObjectValue(Counters, options); + writer.WritePropertyName("limits"u8); + writer.WriteObjectValue(Limits, options); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchServiceStatistics IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchServiceStatistics)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchServiceStatistics(document.RootElement, options); + } + + internal static SearchServiceStatistics DeserializeSearchServiceStatistics(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + SearchServiceCounters counters = default; + SearchServiceLimits limits = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("counters"u8)) + { + counters = SearchServiceCounters.DeserializeSearchServiceCounters(property.Value, options); + continue; + } + if (property.NameEquals("limits"u8)) + { + limits = SearchServiceLimits.DeserializeSearchServiceLimits(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchServiceStatistics(counters, limits, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchServiceStatistics)} does not support writing '{options.Format}' format."); + } + } + + SearchServiceStatistics IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchServiceStatistics(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchServiceStatistics)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchServiceStatistics FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchServiceStatistics(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceStatistics.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceStatistics.cs new file mode 100644 index 000000000000..e3ef180fc73e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchServiceStatistics.cs @@ -0,0 +1,85 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Response from a get service statistics request. If successful, it includes + /// service level counters and limits. + /// + public partial class SearchServiceStatistics + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// Service level resource counters. + /// Service level general limits. + /// or is null. + internal SearchServiceStatistics(SearchServiceCounters counters, SearchServiceLimits limits) + { + Argument.AssertNotNull(counters, nameof(counters)); + Argument.AssertNotNull(limits, nameof(limits)); + + Counters = counters; + Limits = limits; + } + + /// Initializes a new instance of . + /// Service level resource counters. + /// Service level general limits. + /// Keeps track of any properties unknown to the library. + internal SearchServiceStatistics(SearchServiceCounters counters, SearchServiceLimits limits, IDictionary serializedAdditionalRawData) + { + Counters = counters; + Limits = limits; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchServiceStatistics() + { + } + + /// Service level resource counters. + public SearchServiceCounters Counters { get; } + /// Service level general limits. + public SearchServiceLimits Limits { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchSuggester.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchSuggester.Serialization.cs new file mode 100644 index 000000000000..e4f30739e1c4 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchSuggester.Serialization.cs @@ -0,0 +1,168 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SearchSuggester : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchSuggester)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + writer.WritePropertyName("searchMode"u8); + writer.WriteStringValue(SearchMode.ToString()); + writer.WritePropertyName("sourceFields"u8); + writer.WriteStartArray(); + foreach (var item in SourceFields) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchSuggester IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchSuggester)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchSuggester(document.RootElement, options); + } + + internal static SearchSuggester DeserializeSearchSuggester(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + SearchSuggesterSearchMode searchMode = default; + IList sourceFields = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("searchMode"u8)) + { + searchMode = new SearchSuggesterSearchMode(property.Value.GetString()); + continue; + } + if (property.NameEquals("sourceFields"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + sourceFields = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchSuggester(name, searchMode, sourceFields, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchSuggester)} does not support writing '{options.Format}' format."); + } + } + + SearchSuggester IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchSuggester(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchSuggester)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchSuggester FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchSuggester(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchSuggester.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchSuggester.cs new file mode 100644 index 000000000000..1cb070671e31 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchSuggester.cs @@ -0,0 +1,97 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// Defines how the Suggest API should apply to a group of fields in the index. + public partial class SearchSuggester + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name of the suggester. + /// + /// The list of field names to which the suggester applies. Each field must be + /// searchable. + /// + /// or is null. + public SearchSuggester(string name, IEnumerable sourceFields) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(sourceFields, nameof(sourceFields)); + + Name = name; + SourceFields = sourceFields.ToList(); + } + + /// Initializes a new instance of . + /// The name of the suggester. + /// A value indicating the capabilities of the suggester. + /// + /// The list of field names to which the suggester applies. Each field must be + /// searchable. + /// + /// Keeps track of any properties unknown to the library. + internal SearchSuggester(string name, SearchSuggesterSearchMode searchMode, IList sourceFields, IDictionary serializedAdditionalRawData) + { + Name = name; + SearchMode = searchMode; + SourceFields = sourceFields; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SearchSuggester() + { + } + + /// The name of the suggester. + public string Name { get; set; } + /// A value indicating the capabilities of the suggester. + public SearchSuggesterSearchMode SearchMode { get; } = SearchSuggesterSearchMode.AnalyzingInfixMatching; + + /// + /// The list of field names to which the suggester applies. Each field must be + /// searchable. + /// + public IList SourceFields { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchSuggesterSearchMode.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchSuggesterSearchMode.cs new file mode 100644 index 000000000000..59beb0769cba --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SearchSuggesterSearchMode.cs @@ -0,0 +1,48 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The SearchSuggester_searchMode. + public readonly partial struct SearchSuggesterSearchMode : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public SearchSuggesterSearchMode(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string AnalyzingInfixMatchingValue = "analyzingInfixMatching"; + + /// analyzingInfixMatching. + public static SearchSuggesterSearchMode AnalyzingInfixMatching { get; } = new SearchSuggesterSearchMode(AnalyzingInfixMatchingValue); + /// Determines if two values are the same. + public static bool operator ==(SearchSuggesterSearchMode left, SearchSuggesterSearchMode right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(SearchSuggesterSearchMode left, SearchSuggesterSearchMode right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator SearchSuggesterSearchMode(string value) => new SearchSuggesterSearchMode(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is SearchSuggesterSearchMode other && Equals(other); + /// + public bool Equals(SearchSuggesterSearchMode other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticConfiguration.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticConfiguration.Serialization.cs new file mode 100644 index 000000000000..d856a81253c1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticConfiguration.Serialization.cs @@ -0,0 +1,165 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SemanticConfiguration : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SemanticConfiguration)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + writer.WritePropertyName("prioritizedFields"u8); + writer.WriteObjectValue(PrioritizedFields, options); + if (Optional.IsDefined(FlightingOptIn)) + { + writer.WritePropertyName("flightingOptIn"u8); + writer.WriteBooleanValue(FlightingOptIn.Value); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SemanticConfiguration IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SemanticConfiguration)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSemanticConfiguration(document.RootElement, options); + } + + internal static SemanticConfiguration DeserializeSemanticConfiguration(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + SemanticPrioritizedFields prioritizedFields = default; + bool? flightingOptIn = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("prioritizedFields"u8)) + { + prioritizedFields = SemanticPrioritizedFields.DeserializeSemanticPrioritizedFields(property.Value, options); + continue; + } + if (property.NameEquals("flightingOptIn"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + flightingOptIn = property.Value.GetBoolean(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SemanticConfiguration(name, prioritizedFields, flightingOptIn, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SemanticConfiguration)} does not support writing '{options.Format}' format."); + } + } + + SemanticConfiguration IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSemanticConfiguration(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SemanticConfiguration)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SemanticConfiguration FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSemanticConfiguration(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticConfiguration.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticConfiguration.cs new file mode 100644 index 000000000000..076da64b83ef --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticConfiguration.cs @@ -0,0 +1,104 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Defines a specific configuration to be used in the context of semantic + /// capabilities. + /// + public partial class SemanticConfiguration + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name of the semantic configuration. + /// + /// Describes the title, content, and keyword fields to be used for semantic + /// ranking, captions, highlights, and answers. At least one of the three sub + /// properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) + /// need to be set. + /// + /// or is null. + public SemanticConfiguration(string name, SemanticPrioritizedFields prioritizedFields) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(prioritizedFields, nameof(prioritizedFields)); + + Name = name; + PrioritizedFields = prioritizedFields; + } + + /// Initializes a new instance of . + /// The name of the semantic configuration. + /// + /// Describes the title, content, and keyword fields to be used for semantic + /// ranking, captions, highlights, and answers. At least one of the three sub + /// properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) + /// need to be set. + /// + /// Determines how which semantic or query rewrite models to use during model flighting/upgrades. + /// Keeps track of any properties unknown to the library. + internal SemanticConfiguration(string name, SemanticPrioritizedFields prioritizedFields, bool? flightingOptIn, IDictionary serializedAdditionalRawData) + { + Name = name; + PrioritizedFields = prioritizedFields; + FlightingOptIn = flightingOptIn; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SemanticConfiguration() + { + } + + /// The name of the semantic configuration. + public string Name { get; set; } + /// + /// Describes the title, content, and keyword fields to be used for semantic + /// ranking, captions, highlights, and answers. At least one of the three sub + /// properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) + /// need to be set. + /// + public SemanticPrioritizedFields PrioritizedFields { get; set; } + /// Determines how which semantic or query rewrite models to use during model flighting/upgrades. + public bool? FlightingOptIn { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticField.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticField.Serialization.cs new file mode 100644 index 000000000000..f0333e37753b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticField.Serialization.cs @@ -0,0 +1,142 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SemanticField : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SemanticField)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("fieldName"u8); + writer.WriteStringValue(FieldName); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SemanticField IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SemanticField)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSemanticField(document.RootElement, options); + } + + internal static SemanticField DeserializeSemanticField(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string fieldName = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("fieldName"u8)) + { + fieldName = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SemanticField(fieldName, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SemanticField)} does not support writing '{options.Format}' format."); + } + } + + SemanticField IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSemanticField(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SemanticField)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SemanticField FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSemanticField(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticField.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticField.cs new file mode 100644 index 000000000000..c84f954a2713 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticField.cs @@ -0,0 +1,75 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// A field that is used as part of the semantic configuration. + public partial class SemanticField + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// File name. + /// is null. + public SemanticField(string fieldName) + { + Argument.AssertNotNull(fieldName, nameof(fieldName)); + + FieldName = fieldName; + } + + /// Initializes a new instance of . + /// File name. + /// Keeps track of any properties unknown to the library. + internal SemanticField(string fieldName, IDictionary serializedAdditionalRawData) + { + FieldName = fieldName; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SemanticField() + { + } + + /// File name. + public string FieldName { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticPrioritizedFields.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticPrioritizedFields.Serialization.cs new file mode 100644 index 000000000000..3df2f15622f3 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticPrioritizedFields.Serialization.cs @@ -0,0 +1,199 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SemanticPrioritizedFields : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SemanticPrioritizedFields)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(TitleField)) + { + writer.WritePropertyName("titleField"u8); + writer.WriteObjectValue(TitleField, options); + } + if (Optional.IsCollectionDefined(PrioritizedContentFields)) + { + writer.WritePropertyName("prioritizedContentFields"u8); + writer.WriteStartArray(); + foreach (var item in PrioritizedContentFields) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(PrioritizedKeywordsFields)) + { + writer.WritePropertyName("prioritizedKeywordsFields"u8); + writer.WriteStartArray(); + foreach (var item in PrioritizedKeywordsFields) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SemanticPrioritizedFields IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SemanticPrioritizedFields)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSemanticPrioritizedFields(document.RootElement, options); + } + + internal static SemanticPrioritizedFields DeserializeSemanticPrioritizedFields(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + SemanticField titleField = default; + IList prioritizedContentFields = default; + IList prioritizedKeywordsFields = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("titleField"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + titleField = SemanticField.DeserializeSemanticField(property.Value, options); + continue; + } + if (property.NameEquals("prioritizedContentFields"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SemanticField.DeserializeSemanticField(item, options)); + } + prioritizedContentFields = array; + continue; + } + if (property.NameEquals("prioritizedKeywordsFields"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SemanticField.DeserializeSemanticField(item, options)); + } + prioritizedKeywordsFields = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SemanticPrioritizedFields(titleField, prioritizedContentFields ?? new ChangeTrackingList(), prioritizedKeywordsFields ?? new ChangeTrackingList(), serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SemanticPrioritizedFields)} does not support writing '{options.Format}' format."); + } + } + + SemanticPrioritizedFields IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSemanticPrioritizedFields(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SemanticPrioritizedFields)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SemanticPrioritizedFields FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSemanticPrioritizedFields(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticPrioritizedFields.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticPrioritizedFields.cs new file mode 100644 index 000000000000..26f7c7fb8895 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticPrioritizedFields.cs @@ -0,0 +1,108 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Describes the title, content, and keywords fields to be used for semantic + /// ranking, captions, highlights, and answers. + /// + public partial class SemanticPrioritizedFields + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public SemanticPrioritizedFields() + { + PrioritizedContentFields = new ChangeTrackingList(); + PrioritizedKeywordsFields = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// + /// Defines the title field to be used for semantic ranking, captions, highlights, + /// and answers. If you don't have a title field in your index, leave this blank. + /// + /// + /// Defines the content fields to be used for semantic ranking, captions, + /// highlights, and answers. For the best result, the selected fields should + /// contain text in natural language form. The order of the fields in the array + /// represents their priority. Fields with lower priority may get truncated if the + /// content is long. + /// + /// + /// Defines the keyword fields to be used for semantic ranking, captions, + /// highlights, and answers. For the best result, the selected fields should + /// contain a list of keywords. The order of the fields in the array represents + /// their priority. Fields with lower priority may get truncated if the content is + /// long. + /// + /// Keeps track of any properties unknown to the library. + internal SemanticPrioritizedFields(SemanticField titleField, IList prioritizedContentFields, IList prioritizedKeywordsFields, IDictionary serializedAdditionalRawData) + { + TitleField = titleField; + PrioritizedContentFields = prioritizedContentFields; + PrioritizedKeywordsFields = prioritizedKeywordsFields; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// + /// Defines the title field to be used for semantic ranking, captions, highlights, + /// and answers. If you don't have a title field in your index, leave this blank. + /// + public SemanticField TitleField { get; set; } + /// + /// Defines the content fields to be used for semantic ranking, captions, + /// highlights, and answers. For the best result, the selected fields should + /// contain text in natural language form. The order of the fields in the array + /// represents their priority. Fields with lower priority may get truncated if the + /// content is long. + /// + public IList PrioritizedContentFields { get; } + /// + /// Defines the keyword fields to be used for semantic ranking, captions, + /// highlights, and answers. For the best result, the selected fields should + /// contain a list of keywords. The order of the fields in the array represents + /// their priority. Fields with lower priority may get truncated if the content is + /// long. + /// + public IList PrioritizedKeywordsFields { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticSearch.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticSearch.Serialization.cs new file mode 100644 index 000000000000..0aff8e8bb5f4 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticSearch.Serialization.cs @@ -0,0 +1,170 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SemanticSearch : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SemanticSearch)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(DefaultConfiguration)) + { + writer.WritePropertyName("defaultConfiguration"u8); + writer.WriteStringValue(DefaultConfiguration); + } + if (Optional.IsCollectionDefined(Configurations)) + { + writer.WritePropertyName("configurations"u8); + writer.WriteStartArray(); + foreach (var item in Configurations) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SemanticSearch IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SemanticSearch)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSemanticSearch(document.RootElement, options); + } + + internal static SemanticSearch DeserializeSemanticSearch(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string defaultConfiguration = default; + IList configurations = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("defaultConfiguration"u8)) + { + defaultConfiguration = property.Value.GetString(); + continue; + } + if (property.NameEquals("configurations"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SemanticConfiguration.DeserializeSemanticConfiguration(item, options)); + } + configurations = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SemanticSearch(defaultConfiguration, configurations ?? new ChangeTrackingList(), serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SemanticSearch)} does not support writing '{options.Format}' format."); + } + } + + SemanticSearch IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSemanticSearch(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SemanticSearch)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SemanticSearch FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSemanticSearch(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticSearch.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticSearch.cs new file mode 100644 index 000000000000..3e06ef4827fb --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SemanticSearch.cs @@ -0,0 +1,76 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Defines parameters for a search index that influence semantic capabilities. + public partial class SemanticSearch + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public SemanticSearch() + { + Configurations = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// + /// Allows you to set the name of a default semantic configuration in your index, + /// making it optional to pass it on as a query parameter every time. + /// + /// The semantic configurations for the index. + /// Keeps track of any properties unknown to the library. + internal SemanticSearch(string defaultConfiguration, IList configurations, IDictionary serializedAdditionalRawData) + { + DefaultConfiguration = defaultConfiguration; + Configurations = configurations; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// + /// Allows you to set the name of a default semantic configuration in your index, + /// making it optional to pass it on as a query parameter every time. + /// + public string DefaultConfiguration { get; set; } + /// The semantic configurations for the index. + public IList Configurations { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SentimentSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SentimentSkill.Serialization.cs new file mode 100644 index 000000000000..d2150c7ec858 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SentimentSkill.Serialization.cs @@ -0,0 +1,189 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SentimentSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SentimentSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(DefaultLanguageCode)) + { + writer.WritePropertyName("defaultLanguageCode"u8); + writer.WriteStringValue(DefaultLanguageCode.Value.ToString()); + } + } + + SentimentSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SentimentSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSentimentSkill(document.RootElement, options); + } + + internal static SentimentSkill DeserializeSentimentSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + SentimentSkillLanguage? defaultLanguageCode = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("defaultLanguageCode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + defaultLanguageCode = new SentimentSkillLanguage(property.Value.GetString()); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SentimentSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + defaultLanguageCode); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SentimentSkill)} does not support writing '{options.Format}' format."); + } + } + + SentimentSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSentimentSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SentimentSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new SentimentSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSentimentSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SentimentSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SentimentSkill.cs new file mode 100644 index 000000000000..1c2ef1eabb96 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SentimentSkill.cs @@ -0,0 +1,73 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// This skill is deprecated. Use the V3.SentimentSkill instead. + public partial class SentimentSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public SentimentSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Text.SentimentSkill"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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, IDictionary serializedAdditionalRawData, SentimentSkillLanguage? defaultLanguageCode) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + DefaultLanguageCode = defaultLanguageCode; + } + + /// Initializes a new instance of for deserialization. + internal SentimentSkill() + { + } + + /// A value indicating which language code to use. Default is `en`. + public SentimentSkillLanguage? DefaultLanguageCode { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SentimentSkillLanguage.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SentimentSkillLanguage.cs new file mode 100644 index 000000000000..2b7a0b42381c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SentimentSkillLanguage.cs @@ -0,0 +1,90 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Deprecated. The language codes supported for input text by SentimentSkill. + public readonly partial struct SentimentSkillLanguage : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public SentimentSkillLanguage(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string DaValue = "da"; + private const string NlValue = "nl"; + private const string EnValue = "en"; + private const string FiValue = "fi"; + private const string FrValue = "fr"; + private const string DeValue = "de"; + private const string ElValue = "el"; + private const string ItValue = "it"; + private const string NoValue = "no"; + private const string PlValue = "pl"; + private const string PtPTValue = "pt-PT"; + private const string RuValue = "ru"; + private const string EsValue = "es"; + private const string SvValue = "sv"; + private const string TrValue = "tr"; + + /// Danish. + public static SentimentSkillLanguage Da { get; } = new SentimentSkillLanguage(DaValue); + /// Dutch. + public static SentimentSkillLanguage Nl { get; } = new SentimentSkillLanguage(NlValue); + /// English. + public static SentimentSkillLanguage En { get; } = new SentimentSkillLanguage(EnValue); + /// Finnish. + public static SentimentSkillLanguage Fi { get; } = new SentimentSkillLanguage(FiValue); + /// French. + public static SentimentSkillLanguage Fr { get; } = new SentimentSkillLanguage(FrValue); + /// German. + public static SentimentSkillLanguage De { get; } = new SentimentSkillLanguage(DeValue); + /// Greek. + public static SentimentSkillLanguage El { get; } = new SentimentSkillLanguage(ElValue); + /// Italian. + public static SentimentSkillLanguage It { get; } = new SentimentSkillLanguage(ItValue); + /// Norwegian (Bokmaal). + public static SentimentSkillLanguage No { get; } = new SentimentSkillLanguage(NoValue); + /// Polish. + public static SentimentSkillLanguage Pl { get; } = new SentimentSkillLanguage(PlValue); + /// Portuguese (Portugal). + public static SentimentSkillLanguage PtPT { get; } = new SentimentSkillLanguage(PtPTValue); + /// Russian. + public static SentimentSkillLanguage Ru { get; } = new SentimentSkillLanguage(RuValue); + /// Spanish. + public static SentimentSkillLanguage Es { get; } = new SentimentSkillLanguage(EsValue); + /// Swedish. + public static SentimentSkillLanguage Sv { get; } = new SentimentSkillLanguage(SvValue); + /// Turkish. + public static SentimentSkillLanguage Tr { get; } = new SentimentSkillLanguage(TrValue); + /// Determines if two values are the same. + public static bool operator ==(SentimentSkillLanguage left, SentimentSkillLanguage right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(SentimentSkillLanguage left, SentimentSkillLanguage right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator SentimentSkillLanguage(string value) => new SentimentSkillLanguage(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is SentimentSkillLanguage other && Equals(other); + /// + public bool Equals(SentimentSkillLanguage other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SentimentSkillV3.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SentimentSkillV3.Serialization.cs new file mode 100644 index 000000000000..2249411fb4fb --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SentimentSkillV3.Serialization.cs @@ -0,0 +1,213 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SentimentSkillV3 : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SentimentSkillV3)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(DefaultLanguageCode)) + { + writer.WritePropertyName("defaultLanguageCode"u8); + writer.WriteStringValue(DefaultLanguageCode); + } + if (Optional.IsDefined(IncludeOpinionMining)) + { + writer.WritePropertyName("includeOpinionMining"u8); + writer.WriteBooleanValue(IncludeOpinionMining.Value); + } + if (Optional.IsDefined(ModelVersion)) + { + writer.WritePropertyName("modelVersion"u8); + writer.WriteStringValue(ModelVersion); + } + } + + SentimentSkillV3 IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SentimentSkillV3)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSentimentSkillV3(document.RootElement, options); + } + + internal static SentimentSkillV3 DeserializeSentimentSkillV3(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string defaultLanguageCode = default; + bool? includeOpinionMining = default; + string modelVersion = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("defaultLanguageCode"u8)) + { + defaultLanguageCode = property.Value.GetString(); + continue; + } + if (property.NameEquals("includeOpinionMining"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + includeOpinionMining = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("modelVersion"u8)) + { + modelVersion = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SentimentSkillV3( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + defaultLanguageCode, + includeOpinionMining, + modelVersion); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SentimentSkillV3)} does not support writing '{options.Format}' format."); + } + } + + SentimentSkillV3 IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSentimentSkillV3(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SentimentSkillV3)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new SentimentSkillV3 FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSentimentSkillV3(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SentimentSkillV3.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SentimentSkillV3.cs new file mode 100644 index 000000000000..a9ef7340fe0e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SentimentSkillV3.cs @@ -0,0 +1,102 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Using the Text Analytics API, evaluates unstructured text and for each record, + /// provides sentiment labels (such as "negative", "neutral" and "positive") based + /// on the highest confidence score found by the service at a sentence and + /// document-level. + /// + public partial class SentimentSkillV3 : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public SentimentSkillV3(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Text.V3.SentimentSkill"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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, IDictionary serializedAdditionalRawData, string defaultLanguageCode, bool? includeOpinionMining, string modelVersion) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + DefaultLanguageCode = defaultLanguageCode; + IncludeOpinionMining = includeOpinionMining; + ModelVersion = modelVersion; + } + + /// Initializes a new instance of for deserialization. + internal SentimentSkillV3() + { + } + + /// 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; } + /// + /// 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. + /// + public string ModelVersion { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ShaperSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ShaperSkill.Serialization.cs new file mode 100644 index 000000000000..a49007bb73f4 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ShaperSkill.Serialization.cs @@ -0,0 +1,173 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ShaperSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ShaperSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + ShaperSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ShaperSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeShaperSkill(document.RootElement, options); + } + + internal static ShaperSkill DeserializeShaperSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ShaperSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ShaperSkill)} does not support writing '{options.Format}' format."); + } + } + + ShaperSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeShaperSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ShaperSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new ShaperSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeShaperSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ShaperSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ShaperSkill.cs new file mode 100644 index 000000000000..4f1147f93fe6 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ShaperSkill.cs @@ -0,0 +1,71 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A skill for reshaping the outputs. It creates a complex type to support + /// composite fields (also known as multipart fields). + /// + public partial class ShaperSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public ShaperSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Util.ShaperSkill"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal ShaperSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal ShaperSkill() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ShingleTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ShingleTokenFilter.Serialization.cs new file mode 100644 index 000000000000..fb86113f7dc0 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ShingleTokenFilter.Serialization.cs @@ -0,0 +1,223 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class ShingleTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ShingleTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(MaxShingleSize)) + { + writer.WritePropertyName("maxShingleSize"u8); + writer.WriteNumberValue(MaxShingleSize.Value); + } + if (Optional.IsDefined(MinShingleSize)) + { + writer.WritePropertyName("minShingleSize"u8); + writer.WriteNumberValue(MinShingleSize.Value); + } + if (Optional.IsDefined(OutputUnigrams)) + { + writer.WritePropertyName("outputUnigrams"u8); + writer.WriteBooleanValue(OutputUnigrams.Value); + } + if (Optional.IsDefined(OutputUnigramsIfNoShingles)) + { + writer.WritePropertyName("outputUnigramsIfNoShingles"u8); + writer.WriteBooleanValue(OutputUnigramsIfNoShingles.Value); + } + if (Optional.IsDefined(TokenSeparator)) + { + writer.WritePropertyName("tokenSeparator"u8); + writer.WriteStringValue(TokenSeparator); + } + if (Optional.IsDefined(FilterToken)) + { + writer.WritePropertyName("filterToken"u8); + writer.WriteStringValue(FilterToken); + } + } + + ShingleTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ShingleTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeShingleTokenFilter(document.RootElement, options); + } + + internal static ShingleTokenFilter DeserializeShingleTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? maxShingleSize = default; + int? minShingleSize = default; + bool? outputUnigrams = default; + bool? outputUnigramsIfNoShingles = default; + string tokenSeparator = default; + string filterToken = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("maxShingleSize"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxShingleSize = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("minShingleSize"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + minShingleSize = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("outputUnigrams"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + outputUnigrams = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("outputUnigramsIfNoShingles"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + outputUnigramsIfNoShingles = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("tokenSeparator"u8)) + { + tokenSeparator = property.Value.GetString(); + continue; + } + if (property.NameEquals("filterToken"u8)) + { + filterToken = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new ShingleTokenFilter( + odataType, + name, + serializedAdditionalRawData, + maxShingleSize, + minShingleSize, + outputUnigrams, + outputUnigramsIfNoShingles, + tokenSeparator, + filterToken); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ShingleTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + ShingleTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeShingleTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ShingleTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new ShingleTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeShingleTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ShingleTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ShingleTokenFilter.cs new file mode 100644 index 000000000000..75723b300c0e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/ShingleTokenFilter.cs @@ -0,0 +1,107 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Creates combinations of tokens as a single token. This token filter is + /// implemented using Apache Lucene. + /// + public partial class ShingleTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public ShingleTokenFilter(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.ShingleTokenFilter"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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. + /// + /// + /// A value indicating whether the output stream will contain the input tokens + /// (unigrams) as well as shingles. Default is true. + /// + /// + /// A value indicating whether to output unigrams for those times when no shingles + /// are available. This property takes precedence when outputUnigrams is set to + /// false. Default is false. + /// + /// + /// The string to use when joining adjacent tokens to form a shingle. Default is a + /// single space (" "). + /// + /// + /// The string to insert for each position at which there is no token. Default is + /// an underscore ("_"). + /// + internal ShingleTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, int? maxShingleSize, int? minShingleSize, bool? outputUnigrams, bool? outputUnigramsIfNoShingles, string tokenSeparator, string filterToken) : base(odataType, name, serializedAdditionalRawData) + { + MaxShingleSize = maxShingleSize; + MinShingleSize = minShingleSize; + OutputUnigrams = outputUnigrams; + OutputUnigramsIfNoShingles = outputUnigramsIfNoShingles; + TokenSeparator = tokenSeparator; + FilterToken = filterToken; + } + + /// Initializes a new instance of for deserialization. + internal ShingleTokenFilter() + { + } + + /// The maximum shingle size. Default and minimum value is 2. + public int? MaxShingleSize { get; set; } + /// + /// The minimum shingle size. Default and minimum value is 2. Must be less than the + /// value of maxShingleSize. + /// + public int? MinShingleSize { get; set; } + /// + /// A value indicating whether the output stream will contain the input tokens + /// (unigrams) as well as shingles. Default is true. + /// + public bool? OutputUnigrams { get; set; } + /// + /// A value indicating whether to output unigrams for those times when no shingles + /// are available. This property takes precedence when outputUnigrams is set to + /// false. Default is false. + /// + public bool? OutputUnigramsIfNoShingles { get; set; } + /// + /// The string to use when joining adjacent tokens to form a shingle. Default is a + /// single space (" "). + /// + public string TokenSeparator { get; set; } + /// + /// The string to insert for each position at which there is no token. Default is + /// an underscore ("_"). + /// + public string FilterToken { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SimilarityAlgorithm.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SimilarityAlgorithm.Serialization.cs new file mode 100644 index 000000000000..5f4120ec5a89 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SimilarityAlgorithm.Serialization.cs @@ -0,0 +1,134 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + [PersistableModelProxy(typeof(UnknownSimilarityAlgorithm))] + public partial class SimilarityAlgorithm : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SimilarityAlgorithm)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("@odata.type"u8); + writer.WriteStringValue(OdataType); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SimilarityAlgorithm IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SimilarityAlgorithm)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSimilarityAlgorithm(document.RootElement, options); + } + + internal static SimilarityAlgorithm DeserializeSimilarityAlgorithm(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("@odata.type", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "#Microsoft.Azure.Search.BM25Similarity": return BM25SimilarityAlgorithm.DeserializeBM25SimilarityAlgorithm(element, options); + case "#Microsoft.Azure.Search.ClassicSimilarity": return ClassicSimilarityAlgorithm.DeserializeClassicSimilarityAlgorithm(element, options); + } + } + return UnknownSimilarityAlgorithm.DeserializeUnknownSimilarityAlgorithm(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SimilarityAlgorithm)} does not support writing '{options.Format}' format."); + } + } + + SimilarityAlgorithm IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSimilarityAlgorithm(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SimilarityAlgorithm)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SimilarityAlgorithm FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSimilarityAlgorithm(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SimilarityAlgorithm.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SimilarityAlgorithm.cs new file mode 100644 index 000000000000..33c0fa6c3a02 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SimilarityAlgorithm.cs @@ -0,0 +1,72 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Base type for similarity algorithms. Similarity algorithms are used to + /// calculate scores that tie queries to documents. The higher the score, the more + /// relevant the document is to that specific query. Those scores are used to rank + /// the search results. + /// 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 abstract partial class SimilarityAlgorithm + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + protected SimilarityAlgorithm() + { + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Keeps track of any properties unknown to the library. + internal SimilarityAlgorithm(string odataType, IDictionary serializedAdditionalRawData) + { + OdataType = odataType; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The discriminator for derived types. + internal string OdataType { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SkillNames.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SkillNames.Serialization.cs new file mode 100644 index 000000000000..d3ee20ae83e0 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SkillNames.Serialization.cs @@ -0,0 +1,159 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SkillNames : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SkillNames)} does not support writing '{format}' format."); + } + + if (Optional.IsCollectionDefined(SkillNamesProperty)) + { + writer.WritePropertyName("skillNames"u8); + writer.WriteStartArray(); + foreach (var item in SkillNamesProperty) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SkillNames IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SkillNames)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSkillNames(document.RootElement, options); + } + + internal static SkillNames DeserializeSkillNames(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList skillNames = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("skillNames"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + skillNames = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SkillNames(skillNames ?? new ChangeTrackingList(), serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SkillNames)} does not support writing '{options.Format}' format."); + } + } + + SkillNames IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSkillNames(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SkillNames)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SkillNames FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSkillNames(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SkillNames.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SkillNames.cs new file mode 100644 index 000000000000..95fbc436d2f7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SkillNames.cs @@ -0,0 +1,66 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// The type of the skill names. + public partial class SkillNames + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public SkillNames() + { + SkillNamesProperty = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// the names of skills to be reset. + /// Keeps track of any properties unknown to the library. + internal SkillNames(IList skillNamesProperty, IDictionary serializedAdditionalRawData) + { + SkillNamesProperty = skillNamesProperty; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// the names of skills to be reset. + public IList SkillNamesProperty { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Skillsets.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Skillsets.cs new file mode 100644 index 000000000000..27f60ef38cee --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/Skillsets.cs @@ -0,0 +1,871 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading; +using System.Threading.Tasks; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Search.Documents.Indexes +{ + // Data plane generated sub-client. + /// The Skillsets sub-client. + public partial class Skillsets + { + private const string AuthorizationHeader = "api-key"; + private readonly AzureKeyCredential _keyCredential; + private static readonly string[] AuthorizationScopes = new string[] { "https://search.azure.com/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + private readonly string _apiVersion; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of Skillsets for mocking. + protected Skillsets() + { + } + + /// Initializes a new instance of Skillsets. + /// The handler for diagnostic messaging in the client. + /// The HTTP pipeline for sending and receiving REST requests and responses. + /// The key credential to copy. + /// The token credential to copy. + /// Service host. + /// The API version to use for this operation. + internal Skillsets(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, AzureKeyCredential keyCredential, TokenCredential tokenCredential, Uri endpoint, string apiVersion) + { + ClientDiagnostics = clientDiagnostics; + _pipeline = pipeline; + _keyCredential = keyCredential; + _tokenCredential = tokenCredential; + _endpoint = endpoint; + _apiVersion = apiVersion; + } + + /// + /// Creates a new skillset in a search service or updates the skillset if it + /// already exists. + /// + /// The name of the skillset. + /// + /// The skillset containing one or more skills to create or update in a search + /// service. + /// + /// Ignores cache reset requirements. + /// Disables cache reprocessing change detection. + /// The content to send as the request conditions of the request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> CreateOrUpdateAsync(string skillsetName, SearchIndexerSkillset skillset, bool? skipIndexerResetRequirementForCache = null, bool? disableCacheReprocessingChangeDetection = null, MatchConditions matchConditions = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(skillsetName, nameof(skillsetName)); + Argument.AssertNotNull(skillset, nameof(skillset)); + + using RequestContent content = skillset.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await CreateOrUpdateAsync(skillsetName, content, skipIndexerResetRequirementForCache, disableCacheReprocessingChangeDetection, matchConditions, context).ConfigureAwait(false); + return Response.FromValue(SearchIndexerSkillset.FromResponse(response), response); + } + + /// + /// Creates a new skillset in a search service or updates the skillset if it + /// already exists. + /// + /// The name of the skillset. + /// + /// The skillset containing one or more skills to create or update in a search + /// service. + /// + /// Ignores cache reset requirements. + /// Disables cache reprocessing change detection. + /// The content to send as the request conditions of the request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response CreateOrUpdate(string skillsetName, SearchIndexerSkillset skillset, bool? skipIndexerResetRequirementForCache = null, bool? disableCacheReprocessingChangeDetection = null, MatchConditions matchConditions = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(skillsetName, nameof(skillsetName)); + Argument.AssertNotNull(skillset, nameof(skillset)); + + using RequestContent content = skillset.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = CreateOrUpdate(skillsetName, content, skipIndexerResetRequirementForCache, disableCacheReprocessingChangeDetection, matchConditions, context); + return Response.FromValue(SearchIndexerSkillset.FromResponse(response), response); + } + + /// + /// [Protocol Method] Creates a new skillset in a search service or updates the skillset if it + /// already exists. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the skillset. + /// The content to send as the body of the request. + /// Ignores cache reset requirements. + /// Disables cache reprocessing change detection. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task CreateOrUpdateAsync(string skillsetName, RequestContent content, bool? skipIndexerResetRequirementForCache = null, bool? disableCacheReprocessingChangeDetection = null, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(skillsetName, nameof(skillsetName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Skillsets.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(skillsetName, content, skipIndexerResetRequirementForCache, disableCacheReprocessingChangeDetection, matchConditions, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Creates a new skillset in a search service or updates the skillset if it + /// already exists. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the skillset. + /// The content to send as the body of the request. + /// Ignores cache reset requirements. + /// Disables cache reprocessing change detection. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response CreateOrUpdate(string skillsetName, RequestContent content, bool? skipIndexerResetRequirementForCache = null, bool? disableCacheReprocessingChangeDetection = null, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(skillsetName, nameof(skillsetName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Skillsets.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(skillsetName, content, skipIndexerResetRequirementForCache, disableCacheReprocessingChangeDetection, matchConditions, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Deletes a skillset in a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the skillset. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteAsync(string skillsetName, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(skillsetName, nameof(skillsetName)); + + using var scope = ClientDiagnostics.CreateScope("Skillsets.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(skillsetName, matchConditions, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Deletes a skillset in a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the skillset. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Delete(string skillsetName, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(skillsetName, nameof(skillsetName)); + + using var scope = ClientDiagnostics.CreateScope("Skillsets.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(skillsetName, matchConditions, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Retrieves a skillset in a search service. + /// The name of the skillset. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> GetSkillsetAsync(string skillsetName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(skillsetName, nameof(skillsetName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await GetSkillsetAsync(skillsetName, context).ConfigureAwait(false); + return Response.FromValue(SearchIndexerSkillset.FromResponse(response), response); + } + + /// Retrieves a skillset in a search service. + /// The name of the skillset. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response GetSkillset(string skillsetName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(skillsetName, nameof(skillsetName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = GetSkillset(skillsetName, context); + return Response.FromValue(SearchIndexerSkillset.FromResponse(response), response); + } + + /// + /// [Protocol Method] Retrieves a skillset in a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the skillset. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task GetSkillsetAsync(string skillsetName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(skillsetName, nameof(skillsetName)); + + using var scope = ClientDiagnostics.CreateScope("Skillsets.GetSkillset"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSkillsetRequest(skillsetName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Retrieves a skillset in a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the skillset. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response GetSkillset(string skillsetName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(skillsetName, nameof(skillsetName)); + + using var scope = ClientDiagnostics.CreateScope("Skillsets.GetSkillset"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSkillsetRequest(skillsetName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// List all skillsets in a search service. + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The cancellation token to use. + /// + public virtual async Task> GetSkillsetsAsync(string select = null, CancellationToken cancellationToken = default) + { + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await GetSkillsetsAsync(select, context).ConfigureAwait(false); + return Response.FromValue(ListSkillsetsResult.FromResponse(response), response); + } + + /// List all skillsets in a search service. + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The cancellation token to use. + /// + public virtual Response GetSkillsets(string select = null, CancellationToken cancellationToken = default) + { + RequestContext context = FromCancellationToken(cancellationToken); + Response response = GetSkillsets(select, context); + return Response.FromValue(ListSkillsetsResult.FromResponse(response), response); + } + + /// + /// [Protocol Method] List all skillsets in a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task GetSkillsetsAsync(string select, RequestContext context) + { + using var scope = ClientDiagnostics.CreateScope("Skillsets.GetSkillsets"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSkillsetsRequest(select, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] List all skillsets in a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response GetSkillsets(string select, RequestContext context) + { + using var scope = ClientDiagnostics.CreateScope("Skillsets.GetSkillsets"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSkillsetsRequest(select, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates a new skillset in a search service. + /// The skillset containing one or more skills to create in a search service. + /// The cancellation token to use. + /// is null. + /// + public virtual async Task> CreateAsync(SearchIndexerSkillset skillset, CancellationToken cancellationToken = default) + { + Argument.AssertNotNull(skillset, nameof(skillset)); + + using RequestContent content = skillset.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await CreateAsync(content, context).ConfigureAwait(false); + return Response.FromValue(SearchIndexerSkillset.FromResponse(response), response); + } + + /// Creates a new skillset in a search service. + /// The skillset containing one or more skills to create in a search service. + /// The cancellation token to use. + /// is null. + /// + public virtual Response Create(SearchIndexerSkillset skillset, CancellationToken cancellationToken = default) + { + Argument.AssertNotNull(skillset, nameof(skillset)); + + using RequestContent content = skillset.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = Create(content, context); + return Response.FromValue(SearchIndexerSkillset.FromResponse(response), response); + } + + /// + /// [Protocol Method] Creates a new skillset in a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task CreateAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Skillsets.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Creates a new skillset in a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Create(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Skillsets.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Reset an existing skillset in a search service. + /// The name of the skillset. + /// + /// The names of the skills to reset. If not specified, all skills in the skillset + /// will be reset. + /// + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task ResetSkillsAsync(string skillsetName, SkillNames skillNames, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(skillsetName, nameof(skillsetName)); + Argument.AssertNotNull(skillNames, nameof(skillNames)); + + using RequestContent content = skillNames.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await ResetSkillsAsync(skillsetName, content, context).ConfigureAwait(false); + return response; + } + + /// Reset an existing skillset in a search service. + /// The name of the skillset. + /// + /// The names of the skills to reset. If not specified, all skills in the skillset + /// will be reset. + /// + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response ResetSkills(string skillsetName, SkillNames skillNames, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(skillsetName, nameof(skillsetName)); + Argument.AssertNotNull(skillNames, nameof(skillNames)); + + using RequestContent content = skillNames.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = ResetSkills(skillsetName, content, context); + return response; + } + + /// + /// [Protocol Method] Reset an existing skillset in a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the skillset. + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task ResetSkillsAsync(string skillsetName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(skillsetName, nameof(skillsetName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Skillsets.ResetSkills"); + scope.Start(); + try + { + using HttpMessage message = CreateResetSkillsRequest(skillsetName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Reset an existing skillset in a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the skillset. + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response ResetSkills(string skillsetName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(skillsetName, nameof(skillsetName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Skillsets.ResetSkills"); + scope.Start(); + try + { + using HttpMessage message = CreateResetSkillsRequest(skillsetName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateCreateOrUpdateRequest(string skillsetName, RequestContent content, bool? skipIndexerResetRequirementForCache, bool? disableCacheReprocessingChangeDetection, MatchConditions matchConditions, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200201); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/skillsets('", false); + uri.AppendPath(skillsetName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + if (skipIndexerResetRequirementForCache != null) + { + uri.AppendQuery("ignoreResetRequirements", skipIndexerResetRequirementForCache.Value, true); + } + if (disableCacheReprocessingChangeDetection != null) + { + uri.AppendQuery("disableCacheReprocessingChangeDetection", disableCacheReprocessingChangeDetection.Value, true); + } + request.Uri = uri; + request.Headers.Add("Prefer", "return=representation"); + request.Headers.Add("Accept", "application/json"); + if (matchConditions != null) + { + request.Headers.Add(matchConditions); + } + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteRequest(string skillsetName, MatchConditions matchConditions, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204404); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/skillsets('", false); + uri.AppendPath(skillsetName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + if (matchConditions != null) + { + request.Headers.Add(matchConditions); + } + return message; + } + + internal HttpMessage CreateGetSkillsetRequest(string skillsetName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/skillsets('", false); + uri.AppendPath(skillsetName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetSkillsetsRequest(string select, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/skillsets", false); + uri.AppendQuery("api-version", _apiVersion, true); + if (select != null) + { + uri.AppendQuery("$select", select, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier201); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/skillsets", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateResetSkillsRequest(string skillsetName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/skillsets('", false); + uri.AppendPath(skillsetName, true); + uri.AppendPath("')/search.resetskills", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + private static RequestContext DefaultRequestContext = new RequestContext(); + internal static RequestContext FromCancellationToken(CancellationToken cancellationToken = default) + { + if (!cancellationToken.CanBeCanceled) + { + return DefaultRequestContext; + } + + return new RequestContext() { CancellationToken = cancellationToken }; + } + + private static ResponseClassifier _responseClassifier200201; + private static ResponseClassifier ResponseClassifier200201 => _responseClassifier200201 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 201 }); + private static ResponseClassifier _responseClassifier204404; + private static ResponseClassifier ResponseClassifier204404 => _responseClassifier204404 ??= new StatusCodeClassifier(stackalloc ushort[] { 204, 404 }); + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier201; + private static ResponseClassifier ResponseClassifier201 => _responseClassifier201 ??= new StatusCodeClassifier(stackalloc ushort[] { 201 }); + private static ResponseClassifier _responseClassifier204; + private static ResponseClassifier ResponseClassifier204 => _responseClassifier204 ??= new StatusCodeClassifier(stackalloc ushort[] { 204 }); + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SnowballTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SnowballTokenFilter.Serialization.cs new file mode 100644 index 000000000000..313bc81f7f21 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SnowballTokenFilter.Serialization.cs @@ -0,0 +1,140 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SnowballTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SnowballTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("language"u8); + writer.WriteStringValue(Language.ToString()); + } + + SnowballTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SnowballTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSnowballTokenFilter(document.RootElement, options); + } + + internal static SnowballTokenFilter DeserializeSnowballTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + SnowballTokenFilterLanguage language = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("language"u8)) + { + language = new SnowballTokenFilterLanguage(property.Value.GetString()); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SnowballTokenFilter(odataType, name, serializedAdditionalRawData, language); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SnowballTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + SnowballTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSnowballTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SnowballTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new SnowballTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSnowballTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SnowballTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SnowballTokenFilter.cs new file mode 100644 index 000000000000..63954f304a83 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SnowballTokenFilter.cs @@ -0,0 +1,57 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A filter that stems words using a Snowball-generated stemmer. This token filter + /// is implemented using Apache Lucene. + /// + public partial class SnowballTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// is null. + public SnowballTokenFilter(string name, SnowballTokenFilterLanguage language) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.SnowballTokenFilter"; + Language = language; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// The language to use. + internal SnowballTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, SnowballTokenFilterLanguage language) : base(odataType, name, serializedAdditionalRawData) + { + Language = language; + } + + /// Initializes a new instance of for deserialization. + internal SnowballTokenFilter() + { + } + + /// The language to use. + public SnowballTokenFilterLanguage Language { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SnowballTokenFilterLanguage.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SnowballTokenFilterLanguage.cs new file mode 100644 index 000000000000..c3bab7343a4e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SnowballTokenFilterLanguage.cs @@ -0,0 +1,123 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The language to use for a Snowball token filter. + public readonly partial struct SnowballTokenFilterLanguage : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public SnowballTokenFilterLanguage(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string ArmenianValue = "armenian"; + private const string BasqueValue = "basque"; + private const string CatalanValue = "catalan"; + private const string DanishValue = "danish"; + private const string DutchValue = "dutch"; + private const string EnglishValue = "english"; + private const string FinnishValue = "finnish"; + private const string FrenchValue = "french"; + private const string GermanValue = "german"; + private const string German2Value = "german2"; + private const string HungarianValue = "hungarian"; + private const string ItalianValue = "italian"; + private const string KpValue = "kp"; + private const string LovinsValue = "lovins"; + private const string NorwegianValue = "norwegian"; + private const string PorterValue = "porter"; + private const string PortugueseValue = "portuguese"; + private const string RomanianValue = "romanian"; + private const string RussianValue = "russian"; + private const string SpanishValue = "spanish"; + private const string SwedishValue = "swedish"; + private const string TurkishValue = "turkish"; + + /// Selects the Lucene Snowball stemming tokenizer for Armenian. + public static SnowballTokenFilterLanguage Armenian { get; } = new SnowballTokenFilterLanguage(ArmenianValue); + /// Selects the Lucene Snowball stemming tokenizer for Basque. + public static SnowballTokenFilterLanguage Basque { get; } = new SnowballTokenFilterLanguage(BasqueValue); + /// Selects the Lucene Snowball stemming tokenizer for Catalan. + public static SnowballTokenFilterLanguage Catalan { get; } = new SnowballTokenFilterLanguage(CatalanValue); + /// Selects the Lucene Snowball stemming tokenizer for Danish. + public static SnowballTokenFilterLanguage Danish { get; } = new SnowballTokenFilterLanguage(DanishValue); + /// Selects the Lucene Snowball stemming tokenizer for Dutch. + public static SnowballTokenFilterLanguage Dutch { get; } = new SnowballTokenFilterLanguage(DutchValue); + /// Selects the Lucene Snowball stemming tokenizer for English. + public static SnowballTokenFilterLanguage English { get; } = new SnowballTokenFilterLanguage(EnglishValue); + /// Selects the Lucene Snowball stemming tokenizer for Finnish. + public static SnowballTokenFilterLanguage Finnish { get; } = new SnowballTokenFilterLanguage(FinnishValue); + /// Selects the Lucene Snowball stemming tokenizer for French. + public static SnowballTokenFilterLanguage French { get; } = new SnowballTokenFilterLanguage(FrenchValue); + /// Selects the Lucene Snowball stemming tokenizer for German. + public static SnowballTokenFilterLanguage German { get; } = new SnowballTokenFilterLanguage(GermanValue); + /// + /// Selects the Lucene Snowball stemming tokenizer that uses the German variant + /// algorithm. + /// + public static SnowballTokenFilterLanguage German2 { get; } = new SnowballTokenFilterLanguage(German2Value); + /// Selects the Lucene Snowball stemming tokenizer for Hungarian. + public static SnowballTokenFilterLanguage Hungarian { get; } = new SnowballTokenFilterLanguage(HungarianValue); + /// Selects the Lucene Snowball stemming tokenizer for Italian. + public static SnowballTokenFilterLanguage Italian { get; } = new SnowballTokenFilterLanguage(ItalianValue); + /// + /// Selects the Lucene Snowball stemming tokenizer for Dutch that uses the + /// Kraaij-Pohlmann stemming algorithm. + /// + public static SnowballTokenFilterLanguage Kp { get; } = new SnowballTokenFilterLanguage(KpValue); + /// + /// Selects the Lucene Snowball stemming tokenizer for English that uses the Lovins + /// stemming algorithm. + /// + public static SnowballTokenFilterLanguage Lovins { get; } = new SnowballTokenFilterLanguage(LovinsValue); + /// Selects the Lucene Snowball stemming tokenizer for Norwegian. + public static SnowballTokenFilterLanguage Norwegian { get; } = new SnowballTokenFilterLanguage(NorwegianValue); + /// + /// Selects the Lucene Snowball stemming tokenizer for English that uses the Porter + /// stemming algorithm. + /// + public static SnowballTokenFilterLanguage Porter { get; } = new SnowballTokenFilterLanguage(PorterValue); + /// Selects the Lucene Snowball stemming tokenizer for Portuguese. + public static SnowballTokenFilterLanguage Portuguese { get; } = new SnowballTokenFilterLanguage(PortugueseValue); + /// Selects the Lucene Snowball stemming tokenizer for Romanian. + public static SnowballTokenFilterLanguage Romanian { get; } = new SnowballTokenFilterLanguage(RomanianValue); + /// Selects the Lucene Snowball stemming tokenizer for Russian. + public static SnowballTokenFilterLanguage Russian { get; } = new SnowballTokenFilterLanguage(RussianValue); + /// Selects the Lucene Snowball stemming tokenizer for Spanish. + public static SnowballTokenFilterLanguage Spanish { get; } = new SnowballTokenFilterLanguage(SpanishValue); + /// Selects the Lucene Snowball stemming tokenizer for Swedish. + public static SnowballTokenFilterLanguage Swedish { get; } = new SnowballTokenFilterLanguage(SwedishValue); + /// Selects the Lucene Snowball stemming tokenizer for Turkish. + public static SnowballTokenFilterLanguage Turkish { get; } = new SnowballTokenFilterLanguage(TurkishValue); + /// Determines if two values are the same. + public static bool operator ==(SnowballTokenFilterLanguage left, SnowballTokenFilterLanguage right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(SnowballTokenFilterLanguage left, SnowballTokenFilterLanguage right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator SnowballTokenFilterLanguage(string value) => new SnowballTokenFilterLanguage(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is SnowballTokenFilterLanguage other && Equals(other); + /// + public bool Equals(SnowballTokenFilterLanguage other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SoftDeleteColumnDeletionDetectionPolicy.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SoftDeleteColumnDeletionDetectionPolicy.Serialization.cs new file mode 100644 index 000000000000..431a5c8bfa05 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SoftDeleteColumnDeletionDetectionPolicy.Serialization.cs @@ -0,0 +1,148 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SoftDeleteColumnDeletionDetectionPolicy : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SoftDeleteColumnDeletionDetectionPolicy)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(SoftDeleteColumnName)) + { + writer.WritePropertyName("softDeleteColumnName"u8); + writer.WriteStringValue(SoftDeleteColumnName); + } + if (Optional.IsDefined(SoftDeleteMarkerValue)) + { + writer.WritePropertyName("softDeleteMarkerValue"u8); + writer.WriteStringValue(SoftDeleteMarkerValue); + } + } + + SoftDeleteColumnDeletionDetectionPolicy IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SoftDeleteColumnDeletionDetectionPolicy)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSoftDeleteColumnDeletionDetectionPolicy(document.RootElement, options); + } + + internal static SoftDeleteColumnDeletionDetectionPolicy DeserializeSoftDeleteColumnDeletionDetectionPolicy(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string softDeleteColumnName = default; + string softDeleteMarkerValue = default; + string odataType = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("softDeleteColumnName"u8)) + { + softDeleteColumnName = property.Value.GetString(); + continue; + } + if (property.NameEquals("softDeleteMarkerValue"u8)) + { + softDeleteMarkerValue = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SoftDeleteColumnDeletionDetectionPolicy(odataType, serializedAdditionalRawData, softDeleteColumnName, softDeleteMarkerValue); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SoftDeleteColumnDeletionDetectionPolicy)} does not support writing '{options.Format}' format."); + } + } + + SoftDeleteColumnDeletionDetectionPolicy IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSoftDeleteColumnDeletionDetectionPolicy(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SoftDeleteColumnDeletionDetectionPolicy)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new SoftDeleteColumnDeletionDetectionPolicy FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSoftDeleteColumnDeletionDetectionPolicy(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SoftDeleteColumnDeletionDetectionPolicy.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SoftDeleteColumnDeletionDetectionPolicy.cs new file mode 100644 index 000000000000..2adfaa1b93df --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SoftDeleteColumnDeletionDetectionPolicy.cs @@ -0,0 +1,42 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Defines a data deletion detection policy that implements a soft-deletion + /// strategy. It determines whether an item should be deleted based on the value of + /// a designated 'soft delete' column. + /// + public partial class SoftDeleteColumnDeletionDetectionPolicy : DataDeletionDetectionPolicy + { + /// Initializes a new instance of . + public SoftDeleteColumnDeletionDetectionPolicy() + { + OdataType = "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Keeps track of any properties unknown to the library. + /// The name of the column to use for soft-deletion detection. + /// The marker value that identifies an item as deleted. + internal SoftDeleteColumnDeletionDetectionPolicy(string odataType, IDictionary serializedAdditionalRawData, string softDeleteColumnName, string softDeleteMarkerValue) : base(odataType, serializedAdditionalRawData) + { + SoftDeleteColumnName = softDeleteColumnName; + SoftDeleteMarkerValue = softDeleteMarkerValue; + } + + /// The name of the column to use for soft-deletion detection. + public string SoftDeleteColumnName { get; set; } + /// The marker value that identifies an item as deleted. + public string SoftDeleteMarkerValue { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SplitSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SplitSkill.Serialization.cs new file mode 100644 index 000000000000..e15c9da61bd0 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SplitSkill.Serialization.cs @@ -0,0 +1,285 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SplitSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SplitSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(DefaultLanguageCode)) + { + writer.WritePropertyName("defaultLanguageCode"u8); + writer.WriteStringValue(DefaultLanguageCode.Value.ToString()); + } + if (Optional.IsDefined(TextSplitMode)) + { + writer.WritePropertyName("textSplitMode"u8); + writer.WriteStringValue(TextSplitMode.Value.ToString()); + } + if (Optional.IsDefined(MaximumPageLength)) + { + writer.WritePropertyName("maximumPageLength"u8); + writer.WriteNumberValue(MaximumPageLength.Value); + } + if (Optional.IsDefined(PageOverlapLength)) + { + writer.WritePropertyName("pageOverlapLength"u8); + writer.WriteNumberValue(PageOverlapLength.Value); + } + if (Optional.IsDefined(MaximumPagesToTake)) + { + writer.WritePropertyName("maximumPagesToTake"u8); + writer.WriteNumberValue(MaximumPagesToTake.Value); + } + if (Optional.IsDefined(Unit)) + { + writer.WritePropertyName("unit"u8); + writer.WriteStringValue(Unit.Value.ToString()); + } + if (Optional.IsDefined(AzureOpenAITokenizerParameters)) + { + writer.WritePropertyName("azureOpenAITokenizerParameters"u8); + writer.WriteObjectValue(AzureOpenAITokenizerParameters, options); + } + } + + SplitSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SplitSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSplitSkill(document.RootElement, options); + } + + internal static SplitSkill DeserializeSplitSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + SplitSkillLanguage? defaultLanguageCode = default; + TextSplitMode? textSplitMode = default; + int? maximumPageLength = default; + int? pageOverlapLength = default; + int? maximumPagesToTake = default; + SplitSkillUnit? unit = default; + AzureOpenAITokenizerParameters azureOpenAITokenizerParameters = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("defaultLanguageCode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + defaultLanguageCode = new SplitSkillLanguage(property.Value.GetString()); + continue; + } + if (property.NameEquals("textSplitMode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + textSplitMode = new TextSplitMode(property.Value.GetString()); + continue; + } + if (property.NameEquals("maximumPageLength"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maximumPageLength = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("pageOverlapLength"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + pageOverlapLength = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("maximumPagesToTake"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maximumPagesToTake = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("unit"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + unit = new SplitSkillUnit(property.Value.GetString()); + continue; + } + if (property.NameEquals("azureOpenAITokenizerParameters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + azureOpenAITokenizerParameters = AzureOpenAITokenizerParameters.DeserializeAzureOpenAITokenizerParameters(property.Value, options); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SplitSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + defaultLanguageCode, + textSplitMode, + maximumPageLength, + pageOverlapLength, + maximumPagesToTake, + unit, + azureOpenAITokenizerParameters); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SplitSkill)} does not support writing '{options.Format}' format."); + } + } + + SplitSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSplitSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SplitSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new SplitSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSplitSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SplitSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SplitSkill.cs new file mode 100644 index 000000000000..a5d298bc1058 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SplitSkill.cs @@ -0,0 +1,131 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// A skill to split a string into chunks of text. + public partial class SplitSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public SplitSkill(IEnumerable inputs, IEnumerable outputs) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Text.SplitSkill"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// 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. + /// + /// + /// Only applicable when textSplitMode is set to 'pages'. If specified, the + /// SplitSkill will discontinue splitting after processing the first 'maximumPagesToTake' + /// pages, in order to improve performance when only a few + /// initial pages are needed from each document. + /// + /// + /// Only applies if textSplitMode is set to pages. There are two possible values. + /// The choice of the values will decide the length (maximumPageLength and + /// pageOverlapLength) measurement. The default is 'characters', which means the + /// length will be measured by character. + /// + /// + /// Only applies if the unit is set to azureOpenAITokens. If specified, the + /// splitSkill will use these parameters when performing the tokenization. The + /// parameters are a valid 'encoderModelName' and an optional 'allowedSpecialTokens' property. + /// + internal SplitSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData, SplitSkillLanguage? defaultLanguageCode, TextSplitMode? textSplitMode, int? maximumPageLength, int? pageOverlapLength, int? maximumPagesToTake, SplitSkillUnit? unit, AzureOpenAITokenizerParameters azureOpenAITokenizerParameters) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + DefaultLanguageCode = defaultLanguageCode; + TextSplitMode = textSplitMode; + MaximumPageLength = maximumPageLength; + PageOverlapLength = pageOverlapLength; + MaximumPagesToTake = maximumPagesToTake; + Unit = unit; + AzureOpenAITokenizerParameters = azureOpenAITokenizerParameters; + } + + /// Initializes a new instance of for deserialization. + internal SplitSkill() + { + } + + /// 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; } + /// The desired maximum page length. Default is 10000. + public int? MaximumPageLength { get; set; } + /// + /// 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. + /// + public int? PageOverlapLength { get; set; } + /// + /// Only applicable when textSplitMode is set to 'pages'. If specified, the + /// SplitSkill will discontinue splitting after processing the first 'maximumPagesToTake' + /// pages, in order to improve performance when only a few + /// initial pages are needed from each document. + /// + public int? MaximumPagesToTake { get; set; } + /// + /// Only applies if textSplitMode is set to pages. There are two possible values. + /// The choice of the values will decide the length (maximumPageLength and + /// pageOverlapLength) measurement. The default is 'characters', which means the + /// length will be measured by character. + /// + public SplitSkillUnit? Unit { get; set; } + /// + /// Only applies if the unit is set to azureOpenAITokens. If specified, the + /// splitSkill will use these parameters when performing the tokenization. The + /// parameters are a valid 'encoderModelName' and an optional 'allowedSpecialTokens' property. + /// + public AzureOpenAITokenizerParameters AzureOpenAITokenizerParameters { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SplitSkillEncoderModelName.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SplitSkillEncoderModelName.cs new file mode 100644 index 000000000000..d43a030cd997 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SplitSkillEncoderModelName.cs @@ -0,0 +1,63 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// A value indicating which tokenizer to use. + public readonly partial struct SplitSkillEncoderModelName : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public SplitSkillEncoderModelName(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string R50kBaseValue = "r50k_base"; + private const string P50kBaseValue = "p50k_base"; + private const string P50kEditValue = "p50k_edit"; + private const string CL100kBaseValue = "cl100k_base"; + + /// + /// Refers to a base model trained with a 50,000 token vocabulary, often used in + /// general natural language processing tasks. + /// + public static SplitSkillEncoderModelName R50kBase { get; } = new SplitSkillEncoderModelName(R50kBaseValue); + /// A base model with a 50,000 token vocabulary, optimized for prompt-based tasks. + public static SplitSkillEncoderModelName P50kBase { get; } = new SplitSkillEncoderModelName(P50kBaseValue); + /// + /// Similar to p50k_base but fine-tuned for editing or rephrasing tasks with a + /// 50,000 token vocabulary. + /// + public static SplitSkillEncoderModelName P50kEdit { get; } = new SplitSkillEncoderModelName(P50kEditValue); + /// A base model with a 100,000 token vocabulary. + public static SplitSkillEncoderModelName CL100kBase { get; } = new SplitSkillEncoderModelName(CL100kBaseValue); + /// Determines if two values are the same. + public static bool operator ==(SplitSkillEncoderModelName left, SplitSkillEncoderModelName right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(SplitSkillEncoderModelName left, SplitSkillEncoderModelName right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator SplitSkillEncoderModelName(string value) => new SplitSkillEncoderModelName(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is SplitSkillEncoderModelName other && Equals(other); + /// + public bool Equals(SplitSkillEncoderModelName other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SplitSkillLanguage.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SplitSkillLanguage.cs new file mode 100644 index 000000000000..2dd4ae27b1ba --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SplitSkillLanguage.cs @@ -0,0 +1,144 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The language codes supported for input text by SplitSkill. + public readonly partial struct SplitSkillLanguage : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public SplitSkillLanguage(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string AmValue = "am"; + private const string BsValue = "bs"; + private const string CsValue = "cs"; + private const string DaValue = "da"; + private const string DeValue = "de"; + private const string EnValue = "en"; + private const string EsValue = "es"; + private const string EtValue = "et"; + private const string FiValue = "fi"; + private const string FrValue = "fr"; + private const string HeValue = "he"; + private const string HiValue = "hi"; + private const string HrValue = "hr"; + private const string HuValue = "hu"; + private const string IdValue = "id"; + private const string IsValue = "is"; + private const string ItValue = "it"; + private const string JaValue = "ja"; + private const string KoValue = "ko"; + private const string LvValue = "lv"; + private const string NbValue = "nb"; + private const string NlValue = "nl"; + private const string PlValue = "pl"; + private const string PtValue = "pt"; + private const string PtBrValue = "pt-br"; + private const string RuValue = "ru"; + private const string SkValue = "sk"; + private const string SlValue = "sl"; + private const string SrValue = "sr"; + private const string SvValue = "sv"; + private const string TrValue = "tr"; + private const string UrValue = "ur"; + private const string ZhValue = "zh"; + + /// Amharic. + public static SplitSkillLanguage Am { get; } = new SplitSkillLanguage(AmValue); + /// Bosnian. + public static SplitSkillLanguage Bs { get; } = new SplitSkillLanguage(BsValue); + /// Czech. + public static SplitSkillLanguage Cs { get; } = new SplitSkillLanguage(CsValue); + /// Danish. + public static SplitSkillLanguage Da { get; } = new SplitSkillLanguage(DaValue); + /// German. + public static SplitSkillLanguage De { get; } = new SplitSkillLanguage(DeValue); + /// English. + public static SplitSkillLanguage En { get; } = new SplitSkillLanguage(EnValue); + /// Spanish. + public static SplitSkillLanguage Es { get; } = new SplitSkillLanguage(EsValue); + /// Estonian. + public static SplitSkillLanguage Et { get; } = new SplitSkillLanguage(EtValue); + /// Finnish. + public static SplitSkillLanguage Fi { get; } = new SplitSkillLanguage(FiValue); + /// French. + public static SplitSkillLanguage Fr { get; } = new SplitSkillLanguage(FrValue); + /// Hebrew. + public static SplitSkillLanguage He { get; } = new SplitSkillLanguage(HeValue); + /// Hindi. + public static SplitSkillLanguage Hi { get; } = new SplitSkillLanguage(HiValue); + /// Croatian. + public static SplitSkillLanguage Hr { get; } = new SplitSkillLanguage(HrValue); + /// Hungarian. + public static SplitSkillLanguage Hu { get; } = new SplitSkillLanguage(HuValue); + /// Indonesian. + public static SplitSkillLanguage Id { get; } = new SplitSkillLanguage(IdValue); + /// Icelandic. + public static SplitSkillLanguage Is { get; } = new SplitSkillLanguage(IsValue); + /// Italian. + public static SplitSkillLanguage It { get; } = new SplitSkillLanguage(ItValue); + /// Japanese. + public static SplitSkillLanguage Ja { get; } = new SplitSkillLanguage(JaValue); + /// Korean. + public static SplitSkillLanguage Ko { get; } = new SplitSkillLanguage(KoValue); + /// Latvian. + public static SplitSkillLanguage Lv { get; } = new SplitSkillLanguage(LvValue); + /// Norwegian. + public static SplitSkillLanguage Nb { get; } = new SplitSkillLanguage(NbValue); + /// Dutch. + public static SplitSkillLanguage Nl { get; } = new SplitSkillLanguage(NlValue); + /// Polish. + public static SplitSkillLanguage Pl { get; } = new SplitSkillLanguage(PlValue); + /// Portuguese (Portugal). + public static SplitSkillLanguage Pt { get; } = new SplitSkillLanguage(PtValue); + /// Portuguese (Brazil). + public static SplitSkillLanguage PtBr { get; } = new SplitSkillLanguage(PtBrValue); + /// Russian. + public static SplitSkillLanguage Ru { get; } = new SplitSkillLanguage(RuValue); + /// Slovak. + public static SplitSkillLanguage Sk { get; } = new SplitSkillLanguage(SkValue); + /// Slovenian. + public static SplitSkillLanguage Sl { get; } = new SplitSkillLanguage(SlValue); + /// Serbian. + public static SplitSkillLanguage Sr { get; } = new SplitSkillLanguage(SrValue); + /// Swedish. + public static SplitSkillLanguage Sv { get; } = new SplitSkillLanguage(SvValue); + /// Turkish. + public static SplitSkillLanguage Tr { get; } = new SplitSkillLanguage(TrValue); + /// Urdu. + public static SplitSkillLanguage Ur { get; } = new SplitSkillLanguage(UrValue); + /// Chinese (Simplified). + public static SplitSkillLanguage Zh { get; } = new SplitSkillLanguage(ZhValue); + /// Determines if two values are the same. + public static bool operator ==(SplitSkillLanguage left, SplitSkillLanguage right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(SplitSkillLanguage left, SplitSkillLanguage right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator SplitSkillLanguage(string value) => new SplitSkillLanguage(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is SplitSkillLanguage other && Equals(other); + /// + public bool Equals(SplitSkillLanguage other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SplitSkillUnit.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SplitSkillUnit.cs new file mode 100644 index 000000000000..b9b8fe5d1ed8 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SplitSkillUnit.cs @@ -0,0 +1,54 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// A value indicating which unit to use. + public readonly partial struct SplitSkillUnit : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public SplitSkillUnit(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string CharactersValue = "characters"; + private const string AzureOpenAITokensValue = "azureOpenAITokens"; + + /// The length will be measured by character. + public static SplitSkillUnit Characters { get; } = new SplitSkillUnit(CharactersValue); + /// + /// The length will be measured by an AzureOpenAI tokenizer from the tiktoken + /// library. + /// + public static SplitSkillUnit AzureOpenAITokens { get; } = new SplitSkillUnit(AzureOpenAITokensValue); + /// Determines if two values are the same. + public static bool operator ==(SplitSkillUnit left, SplitSkillUnit right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(SplitSkillUnit left, SplitSkillUnit right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator SplitSkillUnit(string value) => new SplitSkillUnit(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is SplitSkillUnit other && Equals(other); + /// + public bool Equals(SplitSkillUnit other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SqlIntegratedChangeTrackingPolicy.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SqlIntegratedChangeTrackingPolicy.Serialization.cs new file mode 100644 index 000000000000..516676e46597 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SqlIntegratedChangeTrackingPolicy.Serialization.cs @@ -0,0 +1,126 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SqlIntegratedChangeTrackingPolicy : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SqlIntegratedChangeTrackingPolicy)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + SqlIntegratedChangeTrackingPolicy IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SqlIntegratedChangeTrackingPolicy)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSqlIntegratedChangeTrackingPolicy(document.RootElement, options); + } + + internal static SqlIntegratedChangeTrackingPolicy DeserializeSqlIntegratedChangeTrackingPolicy(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SqlIntegratedChangeTrackingPolicy(odataType, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SqlIntegratedChangeTrackingPolicy)} does not support writing '{options.Format}' format."); + } + } + + SqlIntegratedChangeTrackingPolicy IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSqlIntegratedChangeTrackingPolicy(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SqlIntegratedChangeTrackingPolicy)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new SqlIntegratedChangeTrackingPolicy FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSqlIntegratedChangeTrackingPolicy(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SqlIntegratedChangeTrackingPolicy.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SqlIntegratedChangeTrackingPolicy.cs new file mode 100644 index 000000000000..57dfe3fbab11 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SqlIntegratedChangeTrackingPolicy.cs @@ -0,0 +1,32 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Defines a data change detection policy that captures changes using the + /// Integrated Change Tracking feature of Azure SQL Database. + /// + public partial class SqlIntegratedChangeTrackingPolicy : DataChangeDetectionPolicy + { + /// Initializes a new instance of . + public SqlIntegratedChangeTrackingPolicy() + { + OdataType = "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Keeps track of any properties unknown to the library. + internal SqlIntegratedChangeTrackingPolicy(string odataType, IDictionary serializedAdditionalRawData) : base(odataType, serializedAdditionalRawData) + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StemmerOverrideTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StemmerOverrideTokenFilter.Serialization.cs new file mode 100644 index 000000000000..5f3e80c9296b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StemmerOverrideTokenFilter.Serialization.cs @@ -0,0 +1,150 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class StemmerOverrideTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(StemmerOverrideTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("rules"u8); + writer.WriteStartArray(); + foreach (var item in Rules) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + + StemmerOverrideTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(StemmerOverrideTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeStemmerOverrideTokenFilter(document.RootElement, options); + } + + internal static StemmerOverrideTokenFilter DeserializeStemmerOverrideTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList rules = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("rules"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + rules = array; + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new StemmerOverrideTokenFilter(odataType, name, serializedAdditionalRawData, rules); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(StemmerOverrideTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + StemmerOverrideTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeStemmerOverrideTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(StemmerOverrideTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new StemmerOverrideTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeStemmerOverrideTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StemmerOverrideTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StemmerOverrideTokenFilter.cs new file mode 100644 index 000000000000..8feace4c05d9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StemmerOverrideTokenFilter.cs @@ -0,0 +1,71 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Provides the ability to override other stemming filters with custom + /// dictionary-based stemming. Any dictionary-stemmed terms will be marked as + /// keywords so that they will not be stemmed with stemmers down the chain. Must be + /// placed before any stemming filters. This token filter is implemented using + /// Apache Lucene. + /// + public partial class StemmerOverrideTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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". + /// + /// or is null. + public StemmerOverrideTokenFilter(string name, IEnumerable rules) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(rules, nameof(rules)); + + OdataType = "#Microsoft.Azure.Search.StemmerOverrideTokenFilter"; + Rules = rules.ToList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// A list of stemming rules in the following format: "word => stem", for example: + /// "ran => run". + /// + internal StemmerOverrideTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, IList rules) : base(odataType, name, serializedAdditionalRawData) + { + Rules = rules; + } + + /// Initializes a new instance of for deserialization. + internal StemmerOverrideTokenFilter() + { + } + + /// + /// A list of stemming rules in the following format: "word => stem", for example: + /// "ran => run". + /// + public IList Rules { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StemmerTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StemmerTokenFilter.Serialization.cs new file mode 100644 index 000000000000..a1735113b80d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StemmerTokenFilter.Serialization.cs @@ -0,0 +1,140 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class StemmerTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(StemmerTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("language"u8); + writer.WriteStringValue(Language.ToString()); + } + + StemmerTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(StemmerTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeStemmerTokenFilter(document.RootElement, options); + } + + internal static StemmerTokenFilter DeserializeStemmerTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + StemmerTokenFilterLanguage language = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("language"u8)) + { + language = new StemmerTokenFilterLanguage(property.Value.GetString()); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new StemmerTokenFilter(odataType, name, serializedAdditionalRawData, language); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(StemmerTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + StemmerTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeStemmerTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(StemmerTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new StemmerTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeStemmerTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StemmerTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StemmerTokenFilter.cs new file mode 100644 index 000000000000..8def47503f6f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StemmerTokenFilter.cs @@ -0,0 +1,57 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Language specific stemming filter. This token filter is implemented using + /// Apache Lucene. + /// + public partial class StemmerTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// is null. + public StemmerTokenFilter(string name, StemmerTokenFilterLanguage language) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.StemmerTokenFilter"; + Language = language; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// The language to use. + internal StemmerTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, StemmerTokenFilterLanguage language) : base(odataType, name, serializedAdditionalRawData) + { + Language = language; + } + + /// Initializes a new instance of for deserialization. + internal StemmerTokenFilter() + { + } + + /// The language to use. + public StemmerTokenFilterLanguage Language { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StemmerTokenFilterLanguage.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StemmerTokenFilterLanguage.cs new file mode 100644 index 000000000000..5b31a5cef613 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StemmerTokenFilterLanguage.cs @@ -0,0 +1,234 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The language to use for a stemmer token filter. + public readonly partial struct StemmerTokenFilterLanguage : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public StemmerTokenFilterLanguage(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string ArabicValue = "arabic"; + private const string ArmenianValue = "armenian"; + private const string BasqueValue = "basque"; + private const string BrazilianValue = "brazilian"; + private const string BulgarianValue = "bulgarian"; + private const string CatalanValue = "catalan"; + private const string CzechValue = "czech"; + private const string DanishValue = "danish"; + private const string DutchValue = "dutch"; + private const string DutchKpValue = "dutchKp"; + private const string EnglishValue = "english"; + private const string LightEnglishValue = "lightEnglish"; + private const string MinimalEnglishValue = "minimalEnglish"; + private const string PossessiveEnglishValue = "possessiveEnglish"; + private const string Porter2Value = "porter2"; + private const string LovinsValue = "lovins"; + private const string FinnishValue = "finnish"; + private const string LightFinnishValue = "lightFinnish"; + private const string FrenchValue = "french"; + private const string LightFrenchValue = "lightFrench"; + private const string MinimalFrenchValue = "minimalFrench"; + private const string GalicianValue = "galician"; + private const string MinimalGalicianValue = "minimalGalician"; + private const string GermanValue = "german"; + private const string German2Value = "german2"; + private const string LightGermanValue = "lightGerman"; + private const string MinimalGermanValue = "minimalGerman"; + private const string GreekValue = "greek"; + private const string HindiValue = "hindi"; + private const string HungarianValue = "hungarian"; + private const string LightHungarianValue = "lightHungarian"; + private const string IndonesianValue = "indonesian"; + private const string IrishValue = "irish"; + private const string ItalianValue = "italian"; + private const string LightItalianValue = "lightItalian"; + private const string SoraniValue = "sorani"; + private const string LatvianValue = "latvian"; + private const string NorwegianValue = "norwegian"; + private const string LightNorwegianValue = "lightNorwegian"; + private const string MinimalNorwegianValue = "minimalNorwegian"; + private const string LightNynorskValue = "lightNynorsk"; + private const string MinimalNynorskValue = "minimalNynorsk"; + private const string PortugueseValue = "portuguese"; + private const string LightPortugueseValue = "lightPortuguese"; + private const string MinimalPortugueseValue = "minimalPortuguese"; + private const string PortugueseRslpValue = "portugueseRslp"; + private const string RomanianValue = "romanian"; + private const string RussianValue = "russian"; + private const string LightRussianValue = "lightRussian"; + private const string SpanishValue = "spanish"; + private const string LightSpanishValue = "lightSpanish"; + private const string SwedishValue = "swedish"; + private const string LightSwedishValue = "lightSwedish"; + private const string TurkishValue = "turkish"; + + /// Selects the Lucene stemming tokenizer for Arabic. + public static StemmerTokenFilterLanguage Arabic { get; } = new StemmerTokenFilterLanguage(ArabicValue); + /// Selects the Lucene stemming tokenizer for Armenian. + public static StemmerTokenFilterLanguage Armenian { get; } = new StemmerTokenFilterLanguage(ArmenianValue); + /// Selects the Lucene stemming tokenizer for Basque. + public static StemmerTokenFilterLanguage Basque { get; } = new StemmerTokenFilterLanguage(BasqueValue); + /// Selects the Lucene stemming tokenizer for Portuguese (Brazil). + public static StemmerTokenFilterLanguage Brazilian { get; } = new StemmerTokenFilterLanguage(BrazilianValue); + /// Selects the Lucene stemming tokenizer for Bulgarian. + public static StemmerTokenFilterLanguage Bulgarian { get; } = new StemmerTokenFilterLanguage(BulgarianValue); + /// Selects the Lucene stemming tokenizer for Catalan. + public static StemmerTokenFilterLanguage Catalan { get; } = new StemmerTokenFilterLanguage(CatalanValue); + /// Selects the Lucene stemming tokenizer for Czech. + public static StemmerTokenFilterLanguage Czech { get; } = new StemmerTokenFilterLanguage(CzechValue); + /// Selects the Lucene stemming tokenizer for Danish. + public static StemmerTokenFilterLanguage Danish { get; } = new StemmerTokenFilterLanguage(DanishValue); + /// Selects the Lucene stemming tokenizer for Dutch. + public static StemmerTokenFilterLanguage Dutch { get; } = new StemmerTokenFilterLanguage(DutchValue); + /// + /// Selects the Lucene stemming tokenizer for Dutch that uses the Kraaij-Pohlmann + /// stemming algorithm. + /// + public static StemmerTokenFilterLanguage DutchKp { get; } = new StemmerTokenFilterLanguage(DutchKpValue); + /// Selects the Lucene stemming tokenizer for English. + public static StemmerTokenFilterLanguage English { get; } = new StemmerTokenFilterLanguage(EnglishValue); + /// Selects the Lucene stemming tokenizer for English that does light stemming. + public static StemmerTokenFilterLanguage LightEnglish { get; } = new StemmerTokenFilterLanguage(LightEnglishValue); + /// Selects the Lucene stemming tokenizer for English that does minimal stemming. + public static StemmerTokenFilterLanguage MinimalEnglish { get; } = new StemmerTokenFilterLanguage(MinimalEnglishValue); + /// + /// Selects the Lucene stemming tokenizer for English that removes trailing + /// possessives from words. + /// + public static StemmerTokenFilterLanguage PossessiveEnglish { get; } = new StemmerTokenFilterLanguage(PossessiveEnglishValue); + /// + /// Selects the Lucene stemming tokenizer for English that uses the Porter2 + /// stemming algorithm. + /// + public static StemmerTokenFilterLanguage Porter2 { get; } = new StemmerTokenFilterLanguage(Porter2Value); + /// + /// Selects the Lucene stemming tokenizer for English that uses the Lovins stemming + /// algorithm. + /// + public static StemmerTokenFilterLanguage Lovins { get; } = new StemmerTokenFilterLanguage(LovinsValue); + /// Selects the Lucene stemming tokenizer for Finnish. + public static StemmerTokenFilterLanguage Finnish { get; } = new StemmerTokenFilterLanguage(FinnishValue); + /// Selects the Lucene stemming tokenizer for Finnish that does light stemming. + public static StemmerTokenFilterLanguage LightFinnish { get; } = new StemmerTokenFilterLanguage(LightFinnishValue); + /// Selects the Lucene stemming tokenizer for French. + public static StemmerTokenFilterLanguage French { get; } = new StemmerTokenFilterLanguage(FrenchValue); + /// Selects the Lucene stemming tokenizer for French that does light stemming. + public static StemmerTokenFilterLanguage LightFrench { get; } = new StemmerTokenFilterLanguage(LightFrenchValue); + /// Selects the Lucene stemming tokenizer for French that does minimal stemming. + public static StemmerTokenFilterLanguage MinimalFrench { get; } = new StemmerTokenFilterLanguage(MinimalFrenchValue); + /// Selects the Lucene stemming tokenizer for Galician. + public static StemmerTokenFilterLanguage Galician { get; } = new StemmerTokenFilterLanguage(GalicianValue); + /// Selects the Lucene stemming tokenizer for Galician that does minimal stemming. + public static StemmerTokenFilterLanguage MinimalGalician { get; } = new StemmerTokenFilterLanguage(MinimalGalicianValue); + /// Selects the Lucene stemming tokenizer for German. + public static StemmerTokenFilterLanguage German { get; } = new StemmerTokenFilterLanguage(GermanValue); + /// Selects the Lucene stemming tokenizer that uses the German variant algorithm. + public static StemmerTokenFilterLanguage German2 { get; } = new StemmerTokenFilterLanguage(German2Value); + /// Selects the Lucene stemming tokenizer for German that does light stemming. + public static StemmerTokenFilterLanguage LightGerman { get; } = new StemmerTokenFilterLanguage(LightGermanValue); + /// Selects the Lucene stemming tokenizer for German that does minimal stemming. + public static StemmerTokenFilterLanguage MinimalGerman { get; } = new StemmerTokenFilterLanguage(MinimalGermanValue); + /// Selects the Lucene stemming tokenizer for Greek. + public static StemmerTokenFilterLanguage Greek { get; } = new StemmerTokenFilterLanguage(GreekValue); + /// Selects the Lucene stemming tokenizer for Hindi. + public static StemmerTokenFilterLanguage Hindi { get; } = new StemmerTokenFilterLanguage(HindiValue); + /// Selects the Lucene stemming tokenizer for Hungarian. + public static StemmerTokenFilterLanguage Hungarian { get; } = new StemmerTokenFilterLanguage(HungarianValue); + /// Selects the Lucene stemming tokenizer for Hungarian that does light stemming. + public static StemmerTokenFilterLanguage LightHungarian { get; } = new StemmerTokenFilterLanguage(LightHungarianValue); + /// Selects the Lucene stemming tokenizer for Indonesian. + public static StemmerTokenFilterLanguage Indonesian { get; } = new StemmerTokenFilterLanguage(IndonesianValue); + /// Selects the Lucene stemming tokenizer for Irish. + public static StemmerTokenFilterLanguage Irish { get; } = new StemmerTokenFilterLanguage(IrishValue); + /// Selects the Lucene stemming tokenizer for Italian. + public static StemmerTokenFilterLanguage Italian { get; } = new StemmerTokenFilterLanguage(ItalianValue); + /// Selects the Lucene stemming tokenizer for Italian that does light stemming. + public static StemmerTokenFilterLanguage LightItalian { get; } = new StemmerTokenFilterLanguage(LightItalianValue); + /// Selects the Lucene stemming tokenizer for Sorani. + public static StemmerTokenFilterLanguage Sorani { get; } = new StemmerTokenFilterLanguage(SoraniValue); + /// Selects the Lucene stemming tokenizer for Latvian. + public static StemmerTokenFilterLanguage Latvian { get; } = new StemmerTokenFilterLanguage(LatvianValue); + /// Selects the Lucene stemming tokenizer for Norwegian (Bokmål). + public static StemmerTokenFilterLanguage Norwegian { get; } = new StemmerTokenFilterLanguage(NorwegianValue); + /// + /// Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does light + /// stemming. + /// + public static StemmerTokenFilterLanguage LightNorwegian { get; } = new StemmerTokenFilterLanguage(LightNorwegianValue); + /// + /// Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does minimal + /// stemming. + /// + public static StemmerTokenFilterLanguage MinimalNorwegian { get; } = new StemmerTokenFilterLanguage(MinimalNorwegianValue); + /// + /// Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does light + /// stemming. + /// + public static StemmerTokenFilterLanguage LightNynorsk { get; } = new StemmerTokenFilterLanguage(LightNynorskValue); + /// + /// Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does minimal + /// stemming. + /// + public static StemmerTokenFilterLanguage MinimalNynorsk { get; } = new StemmerTokenFilterLanguage(MinimalNynorskValue); + /// Selects the Lucene stemming tokenizer for Portuguese. + public static StemmerTokenFilterLanguage Portuguese { get; } = new StemmerTokenFilterLanguage(PortugueseValue); + /// Selects the Lucene stemming tokenizer for Portuguese that does light stemming. + public static StemmerTokenFilterLanguage LightPortuguese { get; } = new StemmerTokenFilterLanguage(LightPortugueseValue); + /// Selects the Lucene stemming tokenizer for Portuguese that does minimal stemming. + public static StemmerTokenFilterLanguage MinimalPortuguese { get; } = new StemmerTokenFilterLanguage(MinimalPortugueseValue); + /// + /// Selects the Lucene stemming tokenizer for Portuguese that uses the RSLP + /// stemming algorithm. + /// + public static StemmerTokenFilterLanguage PortugueseRslp { get; } = new StemmerTokenFilterLanguage(PortugueseRslpValue); + /// Selects the Lucene stemming tokenizer for Romanian. + public static StemmerTokenFilterLanguage Romanian { get; } = new StemmerTokenFilterLanguage(RomanianValue); + /// Selects the Lucene stemming tokenizer for Russian. + public static StemmerTokenFilterLanguage Russian { get; } = new StemmerTokenFilterLanguage(RussianValue); + /// Selects the Lucene stemming tokenizer for Russian that does light stemming. + public static StemmerTokenFilterLanguage LightRussian { get; } = new StemmerTokenFilterLanguage(LightRussianValue); + /// Selects the Lucene stemming tokenizer for Spanish. + public static StemmerTokenFilterLanguage Spanish { get; } = new StemmerTokenFilterLanguage(SpanishValue); + /// Selects the Lucene stemming tokenizer for Spanish that does light stemming. + public static StemmerTokenFilterLanguage LightSpanish { get; } = new StemmerTokenFilterLanguage(LightSpanishValue); + /// Selects the Lucene stemming tokenizer for Swedish. + public static StemmerTokenFilterLanguage Swedish { get; } = new StemmerTokenFilterLanguage(SwedishValue); + /// Selects the Lucene stemming tokenizer for Swedish that does light stemming. + public static StemmerTokenFilterLanguage LightSwedish { get; } = new StemmerTokenFilterLanguage(LightSwedishValue); + /// Selects the Lucene stemming tokenizer for Turkish. + public static StemmerTokenFilterLanguage Turkish { get; } = new StemmerTokenFilterLanguage(TurkishValue); + /// Determines if two values are the same. + public static bool operator ==(StemmerTokenFilterLanguage left, StemmerTokenFilterLanguage right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(StemmerTokenFilterLanguage left, StemmerTokenFilterLanguage right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator StemmerTokenFilterLanguage(string value) => new StemmerTokenFilterLanguage(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is StemmerTokenFilterLanguage other && Equals(other); + /// + public bool Equals(StemmerTokenFilterLanguage other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StopAnalyzer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StopAnalyzer.Serialization.cs new file mode 100644 index 000000000000..892d07c2c99d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StopAnalyzer.Serialization.cs @@ -0,0 +1,157 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class StopAnalyzer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(StopAnalyzer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsCollectionDefined(Stopwords)) + { + writer.WritePropertyName("stopwords"u8); + writer.WriteStartArray(); + foreach (var item in Stopwords) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + } + + StopAnalyzer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(StopAnalyzer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeStopAnalyzer(document.RootElement, options); + } + + internal static StopAnalyzer DeserializeStopAnalyzer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList stopwords = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("stopwords"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + stopwords = array; + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new StopAnalyzer(odataType, name, serializedAdditionalRawData, stopwords ?? new ChangeTrackingList()); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(StopAnalyzer)} does not support writing '{options.Format}' format."); + } + } + + StopAnalyzer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeStopAnalyzer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(StopAnalyzer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new StopAnalyzer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeStopAnalyzer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StopAnalyzer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StopAnalyzer.cs new file mode 100644 index 000000000000..8e287143ae2e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StopAnalyzer.cs @@ -0,0 +1,56 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Divides text at non-letters; Applies the lowercase and stopword token filters. + /// This analyzer is implemented using Apache Lucene. + /// + public partial class StopAnalyzer : LexicalAnalyzer + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public StopAnalyzer(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.StopAnalyzer"; + Stopwords = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// A list of stopwords. + internal StopAnalyzer(string odataType, string name, IDictionary serializedAdditionalRawData, IList stopwords) : base(odataType, name, serializedAdditionalRawData) + { + Stopwords = stopwords; + } + + /// Initializes a new instance of for deserialization. + internal StopAnalyzer() + { + } + + /// A list of stopwords. + public IList Stopwords { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StopwordsList.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StopwordsList.cs new file mode 100644 index 000000000000..dab53ddbb3b5 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StopwordsList.cs @@ -0,0 +1,138 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Identifies a predefined list of language-specific stopwords. + public readonly partial struct StopwordsList : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public StopwordsList(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string ArabicValue = "arabic"; + private const string ArmenianValue = "armenian"; + private const string BasqueValue = "basque"; + private const string BrazilianValue = "brazilian"; + private const string BulgarianValue = "bulgarian"; + private const string CatalanValue = "catalan"; + private const string CzechValue = "czech"; + private const string DanishValue = "danish"; + private const string DutchValue = "dutch"; + private const string EnglishValue = "english"; + private const string FinnishValue = "finnish"; + private const string FrenchValue = "french"; + private const string GalicianValue = "galician"; + private const string GermanValue = "german"; + private const string GreekValue = "greek"; + private const string HindiValue = "hindi"; + private const string HungarianValue = "hungarian"; + private const string IndonesianValue = "indonesian"; + private const string IrishValue = "irish"; + private const string ItalianValue = "italian"; + private const string LatvianValue = "latvian"; + private const string NorwegianValue = "norwegian"; + private const string PersianValue = "persian"; + private const string PortugueseValue = "portuguese"; + private const string RomanianValue = "romanian"; + private const string RussianValue = "russian"; + private const string SoraniValue = "sorani"; + private const string SpanishValue = "spanish"; + private const string SwedishValue = "swedish"; + private const string ThaiValue = "thai"; + private const string TurkishValue = "turkish"; + + /// Selects the stopword list for Arabic. + public static StopwordsList Arabic { get; } = new StopwordsList(ArabicValue); + /// Selects the stopword list for Armenian. + public static StopwordsList Armenian { get; } = new StopwordsList(ArmenianValue); + /// Selects the stopword list for Basque. + public static StopwordsList Basque { get; } = new StopwordsList(BasqueValue); + /// Selects the stopword list for Portuguese (Brazil). + public static StopwordsList Brazilian { get; } = new StopwordsList(BrazilianValue); + /// Selects the stopword list for Bulgarian. + public static StopwordsList Bulgarian { get; } = new StopwordsList(BulgarianValue); + /// Selects the stopword list for Catalan. + public static StopwordsList Catalan { get; } = new StopwordsList(CatalanValue); + /// Selects the stopword list for Czech. + public static StopwordsList Czech { get; } = new StopwordsList(CzechValue); + /// Selects the stopword list for Danish. + public static StopwordsList Danish { get; } = new StopwordsList(DanishValue); + /// Selects the stopword list for Dutch. + public static StopwordsList Dutch { get; } = new StopwordsList(DutchValue); + /// Selects the stopword list for English. + public static StopwordsList English { get; } = new StopwordsList(EnglishValue); + /// Selects the stopword list for Finnish. + public static StopwordsList Finnish { get; } = new StopwordsList(FinnishValue); + /// Selects the stopword list for French. + public static StopwordsList French { get; } = new StopwordsList(FrenchValue); + /// Selects the stopword list for Galician. + public static StopwordsList Galician { get; } = new StopwordsList(GalicianValue); + /// Selects the stopword list for German. + public static StopwordsList German { get; } = new StopwordsList(GermanValue); + /// Selects the stopword list for Greek. + public static StopwordsList Greek { get; } = new StopwordsList(GreekValue); + /// Selects the stopword list for Hindi. + public static StopwordsList Hindi { get; } = new StopwordsList(HindiValue); + /// Selects the stopword list for Hungarian. + public static StopwordsList Hungarian { get; } = new StopwordsList(HungarianValue); + /// Selects the stopword list for Indonesian. + public static StopwordsList Indonesian { get; } = new StopwordsList(IndonesianValue); + /// Selects the stopword list for Irish. + public static StopwordsList Irish { get; } = new StopwordsList(IrishValue); + /// Selects the stopword list for Italian. + public static StopwordsList Italian { get; } = new StopwordsList(ItalianValue); + /// Selects the stopword list for Latvian. + public static StopwordsList Latvian { get; } = new StopwordsList(LatvianValue); + /// Selects the stopword list for Norwegian. + public static StopwordsList Norwegian { get; } = new StopwordsList(NorwegianValue); + /// Selects the stopword list for Persian. + public static StopwordsList Persian { get; } = new StopwordsList(PersianValue); + /// Selects the stopword list for Portuguese. + public static StopwordsList Portuguese { get; } = new StopwordsList(PortugueseValue); + /// Selects the stopword list for Romanian. + public static StopwordsList Romanian { get; } = new StopwordsList(RomanianValue); + /// Selects the stopword list for Russian. + public static StopwordsList Russian { get; } = new StopwordsList(RussianValue); + /// Selects the stopword list for Sorani. + public static StopwordsList Sorani { get; } = new StopwordsList(SoraniValue); + /// Selects the stopword list for Spanish. + public static StopwordsList Spanish { get; } = new StopwordsList(SpanishValue); + /// Selects the stopword list for Swedish. + public static StopwordsList Swedish { get; } = new StopwordsList(SwedishValue); + /// Selects the stopword list for Thai. + public static StopwordsList Thai { get; } = new StopwordsList(ThaiValue); + /// Selects the stopword list for Turkish. + public static StopwordsList Turkish { get; } = new StopwordsList(TurkishValue); + /// Determines if two values are the same. + public static bool operator ==(StopwordsList left, StopwordsList right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(StopwordsList left, StopwordsList right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator StopwordsList(string value) => new StopwordsList(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is StopwordsList other && Equals(other); + /// + public bool Equals(StopwordsList other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StopwordsTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StopwordsTokenFilter.Serialization.cs new file mode 100644 index 000000000000..6ea4e1510f21 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StopwordsTokenFilter.Serialization.cs @@ -0,0 +1,209 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class StopwordsTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(StopwordsTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsCollectionDefined(Stopwords)) + { + writer.WritePropertyName("stopwords"u8); + writer.WriteStartArray(); + foreach (var item in Stopwords) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + if (Optional.IsDefined(StopwordsList)) + { + writer.WritePropertyName("stopwordsList"u8); + writer.WriteStringValue(StopwordsList.Value.ToString()); + } + if (Optional.IsDefined(IgnoreCase)) + { + writer.WritePropertyName("ignoreCase"u8); + writer.WriteBooleanValue(IgnoreCase.Value); + } + if (Optional.IsDefined(RemoveTrailing)) + { + writer.WritePropertyName("removeTrailing"u8); + writer.WriteBooleanValue(RemoveTrailing.Value); + } + } + + StopwordsTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(StopwordsTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeStopwordsTokenFilter(document.RootElement, options); + } + + internal static StopwordsTokenFilter DeserializeStopwordsTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList stopwords = default; + StopwordsList? stopwordsList = default; + bool? ignoreCase = default; + bool? removeTrailing = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("stopwords"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + stopwords = array; + continue; + } + if (property.NameEquals("stopwordsList"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + stopwordsList = new StopwordsList(property.Value.GetString()); + continue; + } + if (property.NameEquals("ignoreCase"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + ignoreCase = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("removeTrailing"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + removeTrailing = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new StopwordsTokenFilter( + odataType, + name, + serializedAdditionalRawData, + stopwords ?? new ChangeTrackingList(), + stopwordsList, + ignoreCase, + removeTrailing); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(StopwordsTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + StopwordsTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeStopwordsTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(StopwordsTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new StopwordsTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeStopwordsTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StopwordsTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StopwordsTokenFilter.cs new file mode 100644 index 000000000000..7ac73715778b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/StopwordsTokenFilter.cs @@ -0,0 +1,92 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Removes stop words from a token stream. This token filter is implemented using + /// Apache Lucene. + /// + public partial class StopwordsTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public StopwordsTokenFilter(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.StopwordsTokenFilter"; + Stopwords = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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. + /// + /// + /// A value indicating whether to ignore case. If true, all words are converted to + /// lower case first. Default is false. + /// + /// + /// A value indicating whether to ignore the last search term if it's a stop word. + /// Default is true. + /// + internal StopwordsTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, IList stopwords, StopwordsList? stopwordsList, bool? ignoreCase, bool? removeTrailing) : base(odataType, name, serializedAdditionalRawData) + { + Stopwords = stopwords; + StopwordsList = stopwordsList; + IgnoreCase = ignoreCase; + RemoveTrailing = removeTrailing; + } + + /// Initializes a new instance of for deserialization. + internal StopwordsTokenFilter() + { + } + + /// + /// The list of stopwords. This property and the stopwords list property cannot + /// both be set. + /// + public IList Stopwords { get; } + /// + /// A predefined list of stopwords to use. This property and the stopwords property + /// cannot both be set. Default is English. + /// + public StopwordsList? StopwordsList { get; set; } + /// + /// A value indicating whether to ignore case. If true, all words are converted to + /// lower case first. Default is false. + /// + public bool? IgnoreCase { get; set; } + /// + /// A value indicating whether to ignore the last search term if it's a stop word. + /// Default is true. + /// + public bool? RemoveTrailing { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymMap.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymMap.Serialization.cs new file mode 100644 index 000000000000..df94dc7491fa --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymMap.Serialization.cs @@ -0,0 +1,190 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SynonymMap : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SynonymMap)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + writer.WritePropertyName("format"u8); + writer.WriteStringValue(Format.ToString()); + writer.WritePropertyName("synonyms"u8); + writer.WriteStringValue(Synonyms); + if (Optional.IsDefined(EncryptionKey)) + { + writer.WritePropertyName("encryptionKey"u8); + writer.WriteObjectValue(EncryptionKey, options); + } + if (Optional.IsDefined(ETag)) + { + writer.WritePropertyName("@odata.etag"u8); + writer.WriteStringValue(ETag); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SynonymMap IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SynonymMap)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSynonymMap(document.RootElement, options); + } + + internal static SynonymMap DeserializeSynonymMap(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + SynonymMapFormat format = default; + string synonyms = default; + SearchResourceEncryptionKey encryptionKey = default; + string odataEtag = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("format"u8)) + { + format = new SynonymMapFormat(property.Value.GetString()); + continue; + } + if (property.NameEquals("synonyms"u8)) + { + synonyms = property.Value.GetString(); + continue; + } + if (property.NameEquals("encryptionKey"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + encryptionKey = SearchResourceEncryptionKey.DeserializeSearchResourceEncryptionKey(property.Value, options); + continue; + } + if (property.NameEquals("@odata.etag"u8)) + { + odataEtag = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SynonymMap( + name, + format, + synonyms, + encryptionKey, + odataEtag, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SynonymMap)} does not support writing '{options.Format}' format."); + } + } + + SynonymMap IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSynonymMap(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SynonymMap)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SynonymMap FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSynonymMap(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymMap.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymMap.cs new file mode 100644 index 000000000000..9301a7702063 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymMap.cs @@ -0,0 +1,124 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents a synonym map definition. + public partial class SynonymMap + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name of the synonym map. + /// + /// A series of synonym rules in the specified synonym map format. The rules must + /// be separated by newlines. + /// + /// or is null. + public SynonymMap(string name, string synonyms) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(synonyms, nameof(synonyms)); + + Name = name; + Synonyms = synonyms; + } + + /// Initializes a new instance of . + /// 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. + /// 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. + /// Keeps track of any properties unknown to the library. + internal SynonymMap(string name, SynonymMapFormat format, string synonyms, SearchResourceEncryptionKey encryptionKey, string eTag, IDictionary serializedAdditionalRawData) + { + Name = name; + Format = format; + Synonyms = synonyms; + EncryptionKey = encryptionKey; + ETag = eTag; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SynonymMap() + { + } + + /// The name of the synonym map. + public string Name { get; set; } + /// The format of the synonym map. Only the 'solr' format is currently supported. + public SynonymMapFormat Format { get; } = SynonymMapFormat.Solr; + + /// + /// 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. + /// 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 ETag of the synonym map. + public string ETag { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymMapFormat.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymMapFormat.cs new file mode 100644 index 000000000000..ecc247c8c9a6 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymMapFormat.cs @@ -0,0 +1,48 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The SynonymMap_format. + public readonly partial struct SynonymMapFormat : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public SynonymMapFormat(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string SolrValue = "solr"; + + /// solr. + public static SynonymMapFormat Solr { get; } = new SynonymMapFormat(SolrValue); + /// Determines if two values are the same. + public static bool operator ==(SynonymMapFormat left, SynonymMapFormat right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(SynonymMapFormat left, SynonymMapFormat right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator SynonymMapFormat(string value) => new SynonymMapFormat(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is SynonymMapFormat other && Equals(other); + /// + public bool Equals(SynonymMapFormat other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymMaps.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymMaps.cs new file mode 100644 index 000000000000..e0a0ec7e72b5 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymMaps.cs @@ -0,0 +1,695 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading; +using System.Threading.Tasks; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Search.Documents.Indexes +{ + // Data plane generated sub-client. + /// The SynonymMaps sub-client. + public partial class SynonymMaps + { + private const string AuthorizationHeader = "api-key"; + private readonly AzureKeyCredential _keyCredential; + private static readonly string[] AuthorizationScopes = new string[] { "https://search.azure.com/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + private readonly string _apiVersion; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of SynonymMaps for mocking. + protected SynonymMaps() + { + } + + /// Initializes a new instance of SynonymMaps. + /// The handler for diagnostic messaging in the client. + /// The HTTP pipeline for sending and receiving REST requests and responses. + /// The key credential to copy. + /// The token credential to copy. + /// Service host. + /// The API version to use for this operation. + internal SynonymMaps(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, AzureKeyCredential keyCredential, TokenCredential tokenCredential, Uri endpoint, string apiVersion) + { + ClientDiagnostics = clientDiagnostics; + _pipeline = pipeline; + _keyCredential = keyCredential; + _tokenCredential = tokenCredential; + _endpoint = endpoint; + _apiVersion = apiVersion; + } + + /// Creates a new synonym map or updates a synonym map if it already exists. + /// The name of the synonym map. + /// The definition of the synonym map to create or update. + /// The content to send as the request conditions of the request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> CreateOrUpdateAsync(string synonymMapName, SynonymMap synonymMap, MatchConditions matchConditions = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(synonymMapName, nameof(synonymMapName)); + Argument.AssertNotNull(synonymMap, nameof(synonymMap)); + + using RequestContent content = synonymMap.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await CreateOrUpdateAsync(synonymMapName, content, matchConditions, context).ConfigureAwait(false); + return Response.FromValue(SynonymMap.FromResponse(response), response); + } + + /// Creates a new synonym map or updates a synonym map if it already exists. + /// The name of the synonym map. + /// The definition of the synonym map to create or update. + /// The content to send as the request conditions of the request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response CreateOrUpdate(string synonymMapName, SynonymMap synonymMap, MatchConditions matchConditions = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(synonymMapName, nameof(synonymMapName)); + Argument.AssertNotNull(synonymMap, nameof(synonymMap)); + + using RequestContent content = synonymMap.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = CreateOrUpdate(synonymMapName, content, matchConditions, context); + return Response.FromValue(SynonymMap.FromResponse(response), response); + } + + /// + /// [Protocol Method] Creates a new synonym map or updates a synonym map if it already exists. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the synonym map. + /// The content to send as the body of the request. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task CreateOrUpdateAsync(string synonymMapName, RequestContent content, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(synonymMapName, nameof(synonymMapName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("SynonymMaps.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(synonymMapName, content, matchConditions, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Creates a new synonym map or updates a synonym map if it already exists. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the synonym map. + /// The content to send as the body of the request. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response CreateOrUpdate(string synonymMapName, RequestContent content, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(synonymMapName, nameof(synonymMapName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("SynonymMaps.CreateOrUpdate"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateOrUpdateRequest(synonymMapName, content, matchConditions, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Deletes a synonym map. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the synonym map. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task DeleteAsync(string synonymMapName, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(synonymMapName, nameof(synonymMapName)); + + using var scope = ClientDiagnostics.CreateScope("SynonymMaps.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(synonymMapName, matchConditions, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + // The convenience method is omitted here because it has exactly the same parameter list as the corresponding protocol method + /// + /// [Protocol Method] Deletes a synonym map. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The name of the synonym map. + /// The content to send as the request conditions of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Delete(string synonymMapName, MatchConditions matchConditions = null, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(synonymMapName, nameof(synonymMapName)); + + using var scope = ClientDiagnostics.CreateScope("SynonymMaps.Delete"); + scope.Start(); + try + { + using HttpMessage message = CreateDeleteRequest(synonymMapName, matchConditions, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Retrieves a synonym map definition. + /// The name of the synonym map. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> GetSynonymMapAsync(string synonymMapName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(synonymMapName, nameof(synonymMapName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await GetSynonymMapAsync(synonymMapName, context).ConfigureAwait(false); + return Response.FromValue(SynonymMap.FromResponse(response), response); + } + + /// Retrieves a synonym map definition. + /// The name of the synonym map. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response GetSynonymMap(string synonymMapName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(synonymMapName, nameof(synonymMapName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = GetSynonymMap(synonymMapName, context); + return Response.FromValue(SynonymMap.FromResponse(response), response); + } + + /// + /// [Protocol Method] Retrieves a synonym map definition. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the synonym map. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task GetSynonymMapAsync(string synonymMapName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(synonymMapName, nameof(synonymMapName)); + + using var scope = ClientDiagnostics.CreateScope("SynonymMaps.GetSynonymMap"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSynonymMapRequest(synonymMapName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Retrieves a synonym map definition. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the synonym map. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response GetSynonymMap(string synonymMapName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(synonymMapName, nameof(synonymMapName)); + + using var scope = ClientDiagnostics.CreateScope("SynonymMaps.GetSynonymMap"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSynonymMapRequest(synonymMapName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Lists all synonym maps available for a search service. + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The cancellation token to use. + /// + public virtual async Task> GetSynonymMapsAsync(string select = null, CancellationToken cancellationToken = default) + { + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await GetSynonymMapsAsync(select, context).ConfigureAwait(false); + return Response.FromValue(ListSynonymMapsResult.FromResponse(response), response); + } + + /// Lists all synonym maps available for a search service. + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The cancellation token to use. + /// + public virtual Response GetSynonymMaps(string select = null, CancellationToken cancellationToken = default) + { + RequestContext context = FromCancellationToken(cancellationToken); + Response response = GetSynonymMaps(select, context); + return Response.FromValue(ListSynonymMapsResult.FromResponse(response), response); + } + + /// + /// [Protocol Method] Lists all synonym maps available for a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task GetSynonymMapsAsync(string select, RequestContext context) + { + using var scope = ClientDiagnostics.CreateScope("SynonymMaps.GetSynonymMaps"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSynonymMapsRequest(select, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Lists all synonym maps available for a search service. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// + /// Selects which top-level properties to retrieve. + /// Specified as a comma-separated list of JSON property names, + /// or '*' for all properties. The default is all properties. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response GetSynonymMaps(string select, RequestContext context) + { + using var scope = ClientDiagnostics.CreateScope("SynonymMaps.GetSynonymMaps"); + scope.Start(); + try + { + using HttpMessage message = CreateGetSynonymMapsRequest(select, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Creates a new synonym map. + /// The definition of the synonym map to create. + /// The cancellation token to use. + /// is null. + /// + public virtual async Task> CreateAsync(SynonymMap synonymMap, CancellationToken cancellationToken = default) + { + Argument.AssertNotNull(synonymMap, nameof(synonymMap)); + + using RequestContent content = synonymMap.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await CreateAsync(content, context).ConfigureAwait(false); + return Response.FromValue(SynonymMap.FromResponse(response), response); + } + + /// Creates a new synonym map. + /// The definition of the synonym map to create. + /// The cancellation token to use. + /// is null. + /// + public virtual Response Create(SynonymMap synonymMap, CancellationToken cancellationToken = default) + { + Argument.AssertNotNull(synonymMap, nameof(synonymMap)); + + using RequestContent content = synonymMap.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = Create(content, context); + return Response.FromValue(SynonymMap.FromResponse(response), response); + } + + /// + /// [Protocol Method] Creates a new synonym map. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task CreateAsync(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("SynonymMaps.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Creates a new synonym map. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Create(RequestContent content, RequestContext context = null) + { + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("SynonymMaps.Create"); + scope.Start(); + try + { + using HttpMessage message = CreateCreateRequest(content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateCreateOrUpdateRequest(string synonymMapName, RequestContent content, MatchConditions matchConditions, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200201); + var request = message.Request; + request.Method = RequestMethod.Put; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/synonymmaps('", false); + uri.AppendPath(synonymMapName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Prefer", "return=representation"); + request.Headers.Add("Accept", "application/json"); + if (matchConditions != null) + { + request.Headers.Add(matchConditions); + } + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateDeleteRequest(string synonymMapName, MatchConditions matchConditions, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier204404); + var request = message.Request; + request.Method = RequestMethod.Delete; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/synonymmaps('", false); + uri.AppendPath(synonymMapName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + if (matchConditions != null) + { + request.Headers.Add(matchConditions); + } + return message; + } + + internal HttpMessage CreateGetSynonymMapRequest(string synonymMapName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/synonymmaps('", false); + uri.AppendPath(synonymMapName, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateGetSynonymMapsRequest(string select, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/synonymmaps", false); + uri.AppendQuery("api-version", _apiVersion, true); + if (select != null) + { + uri.AppendQuery("$select", select, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateCreateRequest(RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier201); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/synonymmaps", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + private static RequestContext DefaultRequestContext = new RequestContext(); + internal static RequestContext FromCancellationToken(CancellationToken cancellationToken = default) + { + if (!cancellationToken.CanBeCanceled) + { + return DefaultRequestContext; + } + + return new RequestContext() { CancellationToken = cancellationToken }; + } + + private static ResponseClassifier _responseClassifier200201; + private static ResponseClassifier ResponseClassifier200201 => _responseClassifier200201 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 201 }); + private static ResponseClassifier _responseClassifier204404; + private static ResponseClassifier ResponseClassifier204404 => _responseClassifier204404 ??= new StatusCodeClassifier(stackalloc ushort[] { 204, 404 }); + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier201; + private static ResponseClassifier ResponseClassifier201 => _responseClassifier201 ??= new StatusCodeClassifier(stackalloc ushort[] { 201 }); + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymTokenFilter.Serialization.cs new file mode 100644 index 000000000000..3c9d828a3c89 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymTokenFilter.Serialization.cs @@ -0,0 +1,186 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class SynonymTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SynonymTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("synonyms"u8); + writer.WriteStartArray(); + foreach (var item in Synonyms) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + if (Optional.IsDefined(IgnoreCase)) + { + writer.WritePropertyName("ignoreCase"u8); + writer.WriteBooleanValue(IgnoreCase.Value); + } + if (Optional.IsDefined(Expand)) + { + writer.WritePropertyName("expand"u8); + writer.WriteBooleanValue(Expand.Value); + } + } + + SynonymTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SynonymTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSynonymTokenFilter(document.RootElement, options); + } + + internal static SynonymTokenFilter DeserializeSynonymTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList synonyms = default; + bool? ignoreCase = default; + bool? expand = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("synonyms"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + synonyms = array; + continue; + } + if (property.NameEquals("ignoreCase"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + ignoreCase = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("expand"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + expand = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SynonymTokenFilter( + odataType, + name, + serializedAdditionalRawData, + synonyms, + ignoreCase, + expand); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SynonymTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + SynonymTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSynonymTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SynonymTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new SynonymTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSynonymTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymTokenFilter.cs new file mode 100644 index 000000000000..2b2fd6106eba --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/SynonymTokenFilter.cs @@ -0,0 +1,103 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Matches single or multi-word synonyms in a token stream. This token filter is + /// implemented using Apache Lucene. + /// + public partial class SynonymTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// or is null. + public SynonymTokenFilter(string name, IEnumerable synonyms) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(synonyms, nameof(synonyms)); + + OdataType = "#Microsoft.Azure.Search.SynonymTokenFilter"; + Synonyms = synonyms.ToList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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. + /// + /// A value indicating whether all words in the list of synonyms (if => notation is + /// not used) will map to one another. If true, all words in the list of synonyms + /// (if => notation is not used) will map to one another. The following list: + /// incredible, unbelievable, fabulous, amazing is equivalent to: incredible, + /// unbelievable, fabulous, amazing => incredible, unbelievable, fabulous, amazing. + /// If false, the following list: incredible, unbelievable, fabulous, amazing will + /// be equivalent to: incredible, unbelievable, fabulous, amazing => incredible. + /// Default is true. + /// + internal SynonymTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, IList synonyms, bool? ignoreCase, bool? expand) : base(odataType, name, serializedAdditionalRawData) + { + Synonyms = synonyms; + IgnoreCase = ignoreCase; + Expand = expand; + } + + /// Initializes a new instance of for deserialization. + internal SynonymTokenFilter() + { + } + + /// + /// 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. + /// + public IList Synonyms { get; } + /// A value indicating whether to case-fold input for matching. Default is false. + public bool? IgnoreCase { get; set; } + /// + /// A value indicating whether all words in the list of synonyms (if => notation is + /// not used) will map to one another. If true, all words in the list of synonyms + /// (if => notation is not used) will map to one another. The following list: + /// incredible, unbelievable, fabulous, amazing is equivalent to: incredible, + /// unbelievable, fabulous, amazing => incredible, unbelievable, fabulous, amazing. + /// If false, the following list: incredible, unbelievable, fabulous, amazing will + /// be equivalent to: incredible, unbelievable, fabulous, amazing => incredible. + /// Default is true. + /// + public bool? Expand { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TagScoringFunction.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TagScoringFunction.Serialization.cs new file mode 100644 index 000000000000..d607ccf7edd1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TagScoringFunction.Serialization.cs @@ -0,0 +1,162 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class TagScoringFunction : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TagScoringFunction)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("tag"u8); + writer.WriteObjectValue(Tag, options); + } + + TagScoringFunction IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TagScoringFunction)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeTagScoringFunction(document.RootElement, options); + } + + internal static TagScoringFunction DeserializeTagScoringFunction(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + TagScoringParameters tag = default; + string fieldName = default; + double boost = default; + ScoringFunctionInterpolation? interpolation = default; + string type = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("tag"u8)) + { + tag = TagScoringParameters.DeserializeTagScoringParameters(property.Value, options); + continue; + } + if (property.NameEquals("fieldName"u8)) + { + fieldName = property.Value.GetString(); + continue; + } + if (property.NameEquals("boost"u8)) + { + boost = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("interpolation"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + interpolation = new ScoringFunctionInterpolation(property.Value.GetString()); + continue; + } + if (property.NameEquals("type"u8)) + { + type = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new TagScoringFunction( + fieldName, + boost, + interpolation, + type, + serializedAdditionalRawData, + tag); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(TagScoringFunction)} does not support writing '{options.Format}' format."); + } + } + + TagScoringFunction IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeTagScoringFunction(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(TagScoringFunction)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new TagScoringFunction FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeTagScoringFunction(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TagScoringFunction.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TagScoringFunction.cs new file mode 100644 index 000000000000..72b5ce6b73c9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TagScoringFunction.cs @@ -0,0 +1,56 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Defines a function that boosts scores of documents with string values matching + /// a given list of tags. + /// + public partial class TagScoringFunction : ScoringFunction + { + /// Initializes a new instance of . + /// The name of the field used as input to the scoring function. + /// A multiplier for the raw score. Must be a positive number not equal to 1.0. + /// Parameter values for the tag scoring function. + /// or is null. + public TagScoringFunction(string fieldName, double boost, TagScoringParameters tag) : base(fieldName, boost) + { + Argument.AssertNotNull(fieldName, nameof(fieldName)); + Argument.AssertNotNull(tag, nameof(tag)); + + Type = "tag"; + Tag = tag; + } + + /// Initializes a new instance of . + /// The name of the field used as input to the scoring function. + /// A multiplier for the raw score. Must be a positive number not equal to 1.0. + /// + /// A value indicating how boosting will be interpolated across document scores; + /// defaults to "Linear". + /// + /// Type of ScoringFunction. + /// Keeps track of any properties unknown to the library. + /// Parameter values for the tag scoring function. + internal TagScoringFunction(string fieldName, double boost, ScoringFunctionInterpolation? interpolation, string type, IDictionary serializedAdditionalRawData, TagScoringParameters tag) : base(fieldName, boost, interpolation, type, serializedAdditionalRawData) + { + Tag = tag; + } + + /// Initializes a new instance of for deserialization. + internal TagScoringFunction() + { + } + + /// Parameter values for the tag scoring function. + public TagScoringParameters Tag { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TagScoringParameters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TagScoringParameters.Serialization.cs new file mode 100644 index 000000000000..36fb91d486dc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TagScoringParameters.Serialization.cs @@ -0,0 +1,142 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class TagScoringParameters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TagScoringParameters)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("tagsParameter"u8); + writer.WriteStringValue(TagsParameter); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + TagScoringParameters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TagScoringParameters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeTagScoringParameters(document.RootElement, options); + } + + internal static TagScoringParameters DeserializeTagScoringParameters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string tagsParameter = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("tagsParameter"u8)) + { + tagsParameter = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new TagScoringParameters(tagsParameter, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(TagScoringParameters)} does not support writing '{options.Format}' format."); + } + } + + TagScoringParameters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeTagScoringParameters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(TagScoringParameters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static TagScoringParameters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeTagScoringParameters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TagScoringParameters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TagScoringParameters.cs new file mode 100644 index 000000000000..122da1461bfd --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TagScoringParameters.cs @@ -0,0 +1,84 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Provides parameter values to a tag scoring function. + public partial class TagScoringParameters + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// The name of the parameter passed in search queries to specify the list of tags + /// to compare against the target field. + /// + /// is null. + public TagScoringParameters(string tagsParameter) + { + Argument.AssertNotNull(tagsParameter, nameof(tagsParameter)); + + TagsParameter = tagsParameter; + } + + /// Initializes a new instance of . + /// + /// The name of the parameter passed in search queries to specify the list of tags + /// to compare against the target field. + /// + /// Keeps track of any properties unknown to the library. + internal TagScoringParameters(string tagsParameter, IDictionary serializedAdditionalRawData) + { + TagsParameter = tagsParameter; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal TagScoringParameters() + { + } + + /// + /// The name of the parameter passed in search queries to specify the list of tags + /// to compare against the target field. + /// + public string TagsParameter { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextSplitMode.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextSplitMode.cs new file mode 100644 index 000000000000..4b431abf7058 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextSplitMode.cs @@ -0,0 +1,51 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// A value indicating which split mode to perform. + public readonly partial struct TextSplitMode : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public TextSplitMode(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string PagesValue = "pages"; + private const string SentencesValue = "sentences"; + + /// Split the text into individual pages. + public static TextSplitMode Pages { get; } = new TextSplitMode(PagesValue); + /// Split the text into individual sentences. + public static TextSplitMode Sentences { get; } = new TextSplitMode(SentencesValue); + /// Determines if two values are the same. + public static bool operator ==(TextSplitMode left, TextSplitMode right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(TextSplitMode left, TextSplitMode right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator TextSplitMode(string value) => new TextSplitMode(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is TextSplitMode other && Equals(other); + /// + public bool Equals(TextSplitMode other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextTranslationSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextTranslationSkill.Serialization.cs new file mode 100644 index 000000000000..46239e2c12fc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextTranslationSkill.Serialization.cs @@ -0,0 +1,214 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class TextTranslationSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TextTranslationSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("defaultToLanguageCode"u8); + writer.WriteStringValue(DefaultToLanguageCode.ToString()); + if (Optional.IsDefined(DefaultFromLanguageCode)) + { + writer.WritePropertyName("defaultFromLanguageCode"u8); + writer.WriteStringValue(DefaultFromLanguageCode.Value.ToString()); + } + if (Optional.IsDefined(SuggestedFrom)) + { + writer.WritePropertyName("suggestedFrom"u8); + writer.WriteStringValue(SuggestedFrom.Value.ToString()); + } + } + + TextTranslationSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TextTranslationSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeTextTranslationSkill(document.RootElement, options); + } + + internal static TextTranslationSkill DeserializeTextTranslationSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + TextTranslationSkillLanguage defaultToLanguageCode = default; + TextTranslationSkillLanguage? defaultFromLanguageCode = default; + TextTranslationSkillLanguage? suggestedFrom = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("defaultToLanguageCode"u8)) + { + defaultToLanguageCode = new TextTranslationSkillLanguage(property.Value.GetString()); + continue; + } + if (property.NameEquals("defaultFromLanguageCode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + defaultFromLanguageCode = new TextTranslationSkillLanguage(property.Value.GetString()); + continue; + } + if (property.NameEquals("suggestedFrom"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + suggestedFrom = new TextTranslationSkillLanguage(property.Value.GetString()); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new TextTranslationSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + defaultToLanguageCode, + defaultFromLanguageCode, + suggestedFrom); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(TextTranslationSkill)} does not support writing '{options.Format}' format."); + } + } + + TextTranslationSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeTextTranslationSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(TextTranslationSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new TextTranslationSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeTextTranslationSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextTranslationSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextTranslationSkill.cs new file mode 100644 index 000000000000..e96b00e63cc2 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextTranslationSkill.cs @@ -0,0 +1,106 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// A skill to translate text from one language to another. + public partial class TextTranslationSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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 language code to translate documents into for documents that don't specify + /// the to language explicitly. + /// + /// or is null. + public TextTranslationSkill(IEnumerable inputs, IEnumerable outputs, TextTranslationSkillLanguage defaultToLanguageCode) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + + OdataType = "#Microsoft.Skills.Text.TranslationSkill"; + DefaultToLanguageCode = defaultToLanguageCode; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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`. + /// + internal TextTranslationSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData, TextTranslationSkillLanguage defaultToLanguageCode, TextTranslationSkillLanguage? defaultFromLanguageCode, TextTranslationSkillLanguage? suggestedFrom) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + DefaultToLanguageCode = defaultToLanguageCode; + DefaultFromLanguageCode = defaultFromLanguageCode; + SuggestedFrom = suggestedFrom; + } + + /// Initializes a new instance of for deserialization. + internal TextTranslationSkill() + { + } + + /// + /// The language code to translate documents into for documents that don't specify + /// the to language explicitly. + /// + 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`. + /// + public TextTranslationSkillLanguage? SuggestedFrom { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextTranslationSkillLanguage.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextTranslationSkillLanguage.cs new file mode 100644 index 000000000000..c82b4ffa5d9a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextTranslationSkillLanguage.cs @@ -0,0 +1,261 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The language codes supported for input text by TextTranslationSkill. + public readonly partial struct TextTranslationSkillLanguage : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public TextTranslationSkillLanguage(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string AfValue = "af"; + private const string ArValue = "ar"; + private const string BnValue = "bn"; + private const string BsValue = "bs"; + private const string BgValue = "bg"; + private const string YueValue = "yue"; + private const string CaValue = "ca"; + private const string ZhHansValue = "zh-Hans"; + private const string ZhHantValue = "zh-Hant"; + private const string HrValue = "hr"; + private const string CsValue = "cs"; + private const string DaValue = "da"; + private const string NlValue = "nl"; + private const string EnValue = "en"; + private const string EtValue = "et"; + private const string FjValue = "fj"; + private const string FilValue = "fil"; + private const string FiValue = "fi"; + private const string FrValue = "fr"; + private const string DeValue = "de"; + private const string ElValue = "el"; + private const string HtValue = "ht"; + private const string HeValue = "he"; + private const string HiValue = "hi"; + private const string MwwValue = "mww"; + private const string HuValue = "hu"; + private const string IsValue = "is"; + private const string IdValue = "id"; + private const string ItValue = "it"; + private const string JaValue = "ja"; + private const string SwValue = "sw"; + private const string TlhValue = "tlh"; + private const string TlhLatnValue = "tlh-Latn"; + private const string TlhPiqdValue = "tlh-Piqd"; + private const string KoValue = "ko"; + private const string LvValue = "lv"; + private const string LtValue = "lt"; + private const string MgValue = "mg"; + private const string MsValue = "ms"; + private const string MtValue = "mt"; + private const string NbValue = "nb"; + private const string FaValue = "fa"; + private const string PlValue = "pl"; + private const string PtValue = "pt"; + private const string PtBrValue = "pt-br"; + private const string PtPTValue = "pt-PT"; + private const string OtqValue = "otq"; + private const string RoValue = "ro"; + private const string RuValue = "ru"; + private const string SmValue = "sm"; + private const string SrCyrlValue = "sr-Cyrl"; + private const string SrLatnValue = "sr-Latn"; + private const string SkValue = "sk"; + private const string SlValue = "sl"; + private const string EsValue = "es"; + private const string SvValue = "sv"; + private const string TyValue = "ty"; + private const string TaValue = "ta"; + private const string TeValue = "te"; + private const string ThValue = "th"; + private const string ToValue = "to"; + private const string TrValue = "tr"; + private const string UkValue = "uk"; + private const string UrValue = "ur"; + private const string ViValue = "vi"; + private const string CyValue = "cy"; + private const string YuaValue = "yua"; + private const string GaValue = "ga"; + private const string KnValue = "kn"; + private const string MiValue = "mi"; + private const string MlValue = "ml"; + private const string PaValue = "pa"; + + /// Afrikaans. + public static TextTranslationSkillLanguage Af { get; } = new TextTranslationSkillLanguage(AfValue); + /// Arabic. + public static TextTranslationSkillLanguage Ar { get; } = new TextTranslationSkillLanguage(ArValue); + /// Bangla. + public static TextTranslationSkillLanguage Bn { get; } = new TextTranslationSkillLanguage(BnValue); + /// Bosnian (Latin). + public static TextTranslationSkillLanguage Bs { get; } = new TextTranslationSkillLanguage(BsValue); + /// Bulgarian. + public static TextTranslationSkillLanguage Bg { get; } = new TextTranslationSkillLanguage(BgValue); + /// Cantonese (Traditional). + public static TextTranslationSkillLanguage Yue { get; } = new TextTranslationSkillLanguage(YueValue); + /// Catalan. + public static TextTranslationSkillLanguage Ca { get; } = new TextTranslationSkillLanguage(CaValue); + /// Chinese Simplified. + public static TextTranslationSkillLanguage ZhHans { get; } = new TextTranslationSkillLanguage(ZhHansValue); + /// Chinese Traditional. + public static TextTranslationSkillLanguage ZhHant { get; } = new TextTranslationSkillLanguage(ZhHantValue); + /// Croatian. + public static TextTranslationSkillLanguage Hr { get; } = new TextTranslationSkillLanguage(HrValue); + /// Czech. + public static TextTranslationSkillLanguage Cs { get; } = new TextTranslationSkillLanguage(CsValue); + /// Danish. + public static TextTranslationSkillLanguage Da { get; } = new TextTranslationSkillLanguage(DaValue); + /// Dutch. + public static TextTranslationSkillLanguage Nl { get; } = new TextTranslationSkillLanguage(NlValue); + /// English. + public static TextTranslationSkillLanguage En { get; } = new TextTranslationSkillLanguage(EnValue); + /// Estonian. + public static TextTranslationSkillLanguage Et { get; } = new TextTranslationSkillLanguage(EtValue); + /// Fijian. + public static TextTranslationSkillLanguage Fj { get; } = new TextTranslationSkillLanguage(FjValue); + /// Filipino. + public static TextTranslationSkillLanguage Fil { get; } = new TextTranslationSkillLanguage(FilValue); + /// Finnish. + public static TextTranslationSkillLanguage Fi { get; } = new TextTranslationSkillLanguage(FiValue); + /// French. + public static TextTranslationSkillLanguage Fr { get; } = new TextTranslationSkillLanguage(FrValue); + /// German. + public static TextTranslationSkillLanguage De { get; } = new TextTranslationSkillLanguage(DeValue); + /// Greek. + public static TextTranslationSkillLanguage El { get; } = new TextTranslationSkillLanguage(ElValue); + /// Haitian Creole. + public static TextTranslationSkillLanguage Ht { get; } = new TextTranslationSkillLanguage(HtValue); + /// Hebrew. + public static TextTranslationSkillLanguage He { get; } = new TextTranslationSkillLanguage(HeValue); + /// Hindi. + public static TextTranslationSkillLanguage Hi { get; } = new TextTranslationSkillLanguage(HiValue); + /// Hmong Daw. + public static TextTranslationSkillLanguage Mww { get; } = new TextTranslationSkillLanguage(MwwValue); + /// Hungarian. + public static TextTranslationSkillLanguage Hu { get; } = new TextTranslationSkillLanguage(HuValue); + /// Icelandic. + public static TextTranslationSkillLanguage Is { get; } = new TextTranslationSkillLanguage(IsValue); + /// Indonesian. + public static TextTranslationSkillLanguage Id { get; } = new TextTranslationSkillLanguage(IdValue); + /// Italian. + public static TextTranslationSkillLanguage It { get; } = new TextTranslationSkillLanguage(ItValue); + /// Japanese. + public static TextTranslationSkillLanguage Ja { get; } = new TextTranslationSkillLanguage(JaValue); + /// Kiswahili. + public static TextTranslationSkillLanguage Sw { get; } = new TextTranslationSkillLanguage(SwValue); + /// Klingon. + public static TextTranslationSkillLanguage Tlh { get; } = new TextTranslationSkillLanguage(TlhValue); + /// Klingon (Latin script). + public static TextTranslationSkillLanguage TlhLatn { get; } = new TextTranslationSkillLanguage(TlhLatnValue); + /// Klingon (Klingon script). + public static TextTranslationSkillLanguage TlhPiqd { get; } = new TextTranslationSkillLanguage(TlhPiqdValue); + /// Korean. + public static TextTranslationSkillLanguage Ko { get; } = new TextTranslationSkillLanguage(KoValue); + /// Latvian. + public static TextTranslationSkillLanguage Lv { get; } = new TextTranslationSkillLanguage(LvValue); + /// Lithuanian. + public static TextTranslationSkillLanguage Lt { get; } = new TextTranslationSkillLanguage(LtValue); + /// Malagasy. + public static TextTranslationSkillLanguage Mg { get; } = new TextTranslationSkillLanguage(MgValue); + /// Malay. + public static TextTranslationSkillLanguage Ms { get; } = new TextTranslationSkillLanguage(MsValue); + /// Maltese. + public static TextTranslationSkillLanguage Mt { get; } = new TextTranslationSkillLanguage(MtValue); + /// Norwegian. + public static TextTranslationSkillLanguage Nb { get; } = new TextTranslationSkillLanguage(NbValue); + /// Persian. + public static TextTranslationSkillLanguage Fa { get; } = new TextTranslationSkillLanguage(FaValue); + /// Polish. + public static TextTranslationSkillLanguage Pl { get; } = new TextTranslationSkillLanguage(PlValue); + /// Portuguese. + public static TextTranslationSkillLanguage Pt { get; } = new TextTranslationSkillLanguage(PtValue); + /// Portuguese (Brazil). + public static TextTranslationSkillLanguage PtBr { get; } = new TextTranslationSkillLanguage(PtBrValue); + /// Portuguese (Portugal). + public static TextTranslationSkillLanguage PtPT { get; } = new TextTranslationSkillLanguage(PtPTValue); + /// Queretaro Otomi. + public static TextTranslationSkillLanguage Otq { get; } = new TextTranslationSkillLanguage(OtqValue); + /// Romanian. + public static TextTranslationSkillLanguage Ro { get; } = new TextTranslationSkillLanguage(RoValue); + /// Russian. + public static TextTranslationSkillLanguage Ru { get; } = new TextTranslationSkillLanguage(RuValue); + /// Samoan. + public static TextTranslationSkillLanguage Sm { get; } = new TextTranslationSkillLanguage(SmValue); + /// Serbian (Cyrillic). + public static TextTranslationSkillLanguage SrCyrl { get; } = new TextTranslationSkillLanguage(SrCyrlValue); + /// Serbian (Latin). + public static TextTranslationSkillLanguage SrLatn { get; } = new TextTranslationSkillLanguage(SrLatnValue); + /// Slovak. + public static TextTranslationSkillLanguage Sk { get; } = new TextTranslationSkillLanguage(SkValue); + /// Slovenian. + public static TextTranslationSkillLanguage Sl { get; } = new TextTranslationSkillLanguage(SlValue); + /// Spanish. + public static TextTranslationSkillLanguage Es { get; } = new TextTranslationSkillLanguage(EsValue); + /// Swedish. + public static TextTranslationSkillLanguage Sv { get; } = new TextTranslationSkillLanguage(SvValue); + /// Tahitian. + public static TextTranslationSkillLanguage Ty { get; } = new TextTranslationSkillLanguage(TyValue); + /// Tamil. + public static TextTranslationSkillLanguage Ta { get; } = new TextTranslationSkillLanguage(TaValue); + /// Telugu. + public static TextTranslationSkillLanguage Te { get; } = new TextTranslationSkillLanguage(TeValue); + /// Thai. + public static TextTranslationSkillLanguage Th { get; } = new TextTranslationSkillLanguage(ThValue); + /// Tongan. + public static TextTranslationSkillLanguage To { get; } = new TextTranslationSkillLanguage(ToValue); + /// Turkish. + public static TextTranslationSkillLanguage Tr { get; } = new TextTranslationSkillLanguage(TrValue); + /// Ukrainian. + public static TextTranslationSkillLanguage Uk { get; } = new TextTranslationSkillLanguage(UkValue); + /// Urdu. + public static TextTranslationSkillLanguage Ur { get; } = new TextTranslationSkillLanguage(UrValue); + /// Vietnamese. + public static TextTranslationSkillLanguage Vi { get; } = new TextTranslationSkillLanguage(ViValue); + /// Welsh. + public static TextTranslationSkillLanguage Cy { get; } = new TextTranslationSkillLanguage(CyValue); + /// Yucatec Maya. + public static TextTranslationSkillLanguage Yua { get; } = new TextTranslationSkillLanguage(YuaValue); + /// Irish. + public static TextTranslationSkillLanguage Ga { get; } = new TextTranslationSkillLanguage(GaValue); + /// Kannada. + public static TextTranslationSkillLanguage Kn { get; } = new TextTranslationSkillLanguage(KnValue); + /// Maori. + public static TextTranslationSkillLanguage Mi { get; } = new TextTranslationSkillLanguage(MiValue); + /// Malayalam. + public static TextTranslationSkillLanguage Ml { get; } = new TextTranslationSkillLanguage(MlValue); + /// Punjabi. + public static TextTranslationSkillLanguage Pa { get; } = new TextTranslationSkillLanguage(PaValue); + /// Determines if two values are the same. + public static bool operator ==(TextTranslationSkillLanguage left, TextTranslationSkillLanguage right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(TextTranslationSkillLanguage left, TextTranslationSkillLanguage right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator TextTranslationSkillLanguage(string value) => new TextTranslationSkillLanguage(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is TextTranslationSkillLanguage other && Equals(other); + /// + public bool Equals(TextTranslationSkillLanguage other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextWeights.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextWeights.Serialization.cs new file mode 100644 index 000000000000..3f156107c419 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextWeights.Serialization.cs @@ -0,0 +1,153 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class TextWeights : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TextWeights)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("weights"u8); + writer.WriteStartObject(); + foreach (var item in Weights) + { + writer.WritePropertyName(item.Key); + writer.WriteNumberValue(item.Value); + } + writer.WriteEndObject(); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + TextWeights IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TextWeights)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeTextWeights(document.RootElement, options); + } + + internal static TextWeights DeserializeTextWeights(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IDictionary weights = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("weights"u8)) + { + Dictionary dictionary = new Dictionary(); + foreach (var property0 in property.Value.EnumerateObject()) + { + dictionary.Add(property0.Name, property0.Value.GetDouble()); + } + weights = dictionary; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new TextWeights(weights, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(TextWeights)} does not support writing '{options.Format}' format."); + } + } + + TextWeights IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeTextWeights(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(TextWeights)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static TextWeights FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeTextWeights(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextWeights.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextWeights.cs new file mode 100644 index 000000000000..99c490f3505d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TextWeights.cs @@ -0,0 +1,87 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Defines weights on index fields for which matches should boost scoring in + /// search queries. + /// + public partial class TextWeights + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// The dictionary of per-field weights to boost document scoring. The keys are + /// field names and the values are the weights for each field. + /// + /// is null. + public TextWeights(IDictionary weights) + { + Argument.AssertNotNull(weights, nameof(weights)); + + Weights = weights; + } + + /// Initializes a new instance of . + /// + /// The dictionary of per-field weights to boost document scoring. The keys are + /// field names and the values are the weights for each field. + /// + /// Keeps track of any properties unknown to the library. + internal TextWeights(IDictionary weights, IDictionary serializedAdditionalRawData) + { + Weights = weights; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal TextWeights() + { + } + + /// + /// The dictionary of per-field weights to boost document scoring. The keys are + /// field names and the values are the weights for each field. + /// + public IDictionary Weights { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TokenCharacterKind.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TokenCharacterKind.cs new file mode 100644 index 000000000000..32da0871d76d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TokenCharacterKind.cs @@ -0,0 +1,60 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Represents classes of characters on which a token filter can operate. + public readonly partial struct TokenCharacterKind : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public TokenCharacterKind(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string LetterValue = "letter"; + private const string DigitValue = "digit"; + private const string WhitespaceValue = "whitespace"; + private const string PunctuationValue = "punctuation"; + private const string SymbolValue = "symbol"; + + /// Keeps letters in tokens. + public static TokenCharacterKind Letter { get; } = new TokenCharacterKind(LetterValue); + /// Keeps digits in tokens. + public static TokenCharacterKind Digit { get; } = new TokenCharacterKind(DigitValue); + /// Keeps whitespace in tokens. + public static TokenCharacterKind Whitespace { get; } = new TokenCharacterKind(WhitespaceValue); + /// Keeps punctuation in tokens. + public static TokenCharacterKind Punctuation { get; } = new TokenCharacterKind(PunctuationValue); + /// Keeps symbols in tokens. + public static TokenCharacterKind Symbol { get; } = new TokenCharacterKind(SymbolValue); + /// Determines if two values are the same. + public static bool operator ==(TokenCharacterKind left, TokenCharacterKind right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(TokenCharacterKind left, TokenCharacterKind right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator TokenCharacterKind(string value) => new TokenCharacterKind(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is TokenCharacterKind other && Equals(other); + /// + public bool Equals(TokenCharacterKind other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TokenFilter.Serialization.cs new file mode 100644 index 000000000000..2b98708b37fd --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TokenFilter.Serialization.cs @@ -0,0 +1,157 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + [PersistableModelProxy(typeof(UnknownTokenFilter))] + public partial class TokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TokenFilter)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("@odata.type"u8); + writer.WriteStringValue(OdataType); + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + TokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeTokenFilter(document.RootElement, options); + } + + internal static TokenFilter DeserializeTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("@odata.type", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "#Microsoft.Azure.Search.AsciiFoldingTokenFilter": return AsciiFoldingTokenFilter.DeserializeAsciiFoldingTokenFilter(element, options); + case "#Microsoft.Azure.Search.CjkBigramTokenFilter": return CjkBigramTokenFilter.DeserializeCjkBigramTokenFilter(element, options); + case "#Microsoft.Azure.Search.CommonGramTokenFilter": return CommonGramTokenFilter.DeserializeCommonGramTokenFilter(element, options); + case "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter": return DictionaryDecompounderTokenFilter.DeserializeDictionaryDecompounderTokenFilter(element, options); + case "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2": return EdgeNGramTokenFilterV2.DeserializeEdgeNGramTokenFilterV2(element, options); + case "#Microsoft.Azure.Search.ElisionTokenFilter": return ElisionTokenFilter.DeserializeElisionTokenFilter(element, options); + case "#Microsoft.Azure.Search.KeepTokenFilter": return KeepTokenFilter.DeserializeKeepTokenFilter(element, options); + case "#Microsoft.Azure.Search.KeywordMarkerTokenFilter": return KeywordMarkerTokenFilter.DeserializeKeywordMarkerTokenFilter(element, options); + case "#Microsoft.Azure.Search.LengthTokenFilter": return LengthTokenFilter.DeserializeLengthTokenFilter(element, options); + case "#Microsoft.Azure.Search.LimitTokenFilter": return LimitTokenFilter.DeserializeLimitTokenFilter(element, options); + case "#Microsoft.Azure.Search.NGramTokenFilterV2": return NGramTokenFilterV2.DeserializeNGramTokenFilterV2(element, options); + case "#Microsoft.Azure.Search.PatternCaptureTokenFilter": return PatternCaptureTokenFilter.DeserializePatternCaptureTokenFilter(element, options); + case "#Microsoft.Azure.Search.PatternReplaceTokenFilter": return PatternReplaceTokenFilter.DeserializePatternReplaceTokenFilter(element, options); + case "#Microsoft.Azure.Search.PhoneticTokenFilter": return PhoneticTokenFilter.DeserializePhoneticTokenFilter(element, options); + case "#Microsoft.Azure.Search.ShingleTokenFilter": return ShingleTokenFilter.DeserializeShingleTokenFilter(element, options); + case "#Microsoft.Azure.Search.SnowballTokenFilter": return SnowballTokenFilter.DeserializeSnowballTokenFilter(element, options); + case "#Microsoft.Azure.Search.StemmerOverrideTokenFilter": return StemmerOverrideTokenFilter.DeserializeStemmerOverrideTokenFilter(element, options); + case "#Microsoft.Azure.Search.StemmerTokenFilter": return StemmerTokenFilter.DeserializeStemmerTokenFilter(element, options); + case "#Microsoft.Azure.Search.StopwordsTokenFilter": return StopwordsTokenFilter.DeserializeStopwordsTokenFilter(element, options); + case "#Microsoft.Azure.Search.SynonymTokenFilter": return SynonymTokenFilter.DeserializeSynonymTokenFilter(element, options); + case "#Microsoft.Azure.Search.TruncateTokenFilter": return TruncateTokenFilter.DeserializeTruncateTokenFilter(element, options); + case "#Microsoft.Azure.Search.UniqueTokenFilter": return UniqueTokenFilter.DeserializeUniqueTokenFilter(element, options); + case "#Microsoft.Azure.Search.WordDelimiterTokenFilter": return WordDelimiterTokenFilter.DeserializeWordDelimiterTokenFilter(element, options); + } + } + return UnknownTokenFilter.DeserializeUnknownTokenFilter(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(TokenFilter)} does not support writing '{options.Format}' format."); + } + } + + TokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(TokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static TokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeTokenFilter(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TokenFilter.cs new file mode 100644 index 000000000000..0b43e69247af --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TokenFilter.cs @@ -0,0 +1,95 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Base type for token filters. + /// 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 abstract partial class TokenFilter + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + protected TokenFilter(string name) + { + Argument.AssertNotNull(name, nameof(name)); + + Name = name; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal TokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData) + { + OdataType = odataType; + Name = name; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal TokenFilter() + { + } + + /// The discriminator for derived types. + 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.Indexes/src/Generated/TokenFilterName.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TokenFilterName.cs new file mode 100644 index 000000000000..f5c99d9c3999 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TokenFilterName.cs @@ -0,0 +1,261 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// Defines the names of all token filters supported by the search engine. + public readonly partial struct TokenFilterName : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public TokenFilterName(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string ArabicNormalizationValue = "arabic_normalization"; + private const string ApostropheValue = "apostrophe"; + private const string AsciiFoldingValue = "asciifolding"; + private const string CjkBigramValue = "cjk_bigram"; + private const string CjkWidthValue = "cjk_width"; + private const string ClassicValue = "classic"; + private const string CommonGramValue = "common_grams"; + private const string EdgeNGramValue = "edgeNGram_v2"; + private const string ElisionValue = "elision"; + private const string GermanNormalizationValue = "german_normalization"; + private const string HindiNormalizationValue = "hindi_normalization"; + private const string IndicNormalizationValue = "indic_normalization"; + private const string KeywordRepeatValue = "keyword_repeat"; + private const string KStemValue = "kstem"; + private const string LengthValue = "length"; + private const string LimitValue = "limit"; + private const string LowercaseValue = "lowercase"; + private const string NGramValue = "nGram_v2"; + private const string PersianNormalizationValue = "persian_normalization"; + private const string PhoneticValue = "phonetic"; + private const string PorterStemValue = "porter_stem"; + private const string ReverseValue = "reverse"; + private const string ScandinavianNormalizationValue = "scandinavian_normalization"; + private const string ScandinavianFoldingNormalizationValue = "scandinavian_folding"; + private const string ShingleValue = "shingle"; + private const string SnowballValue = "snowball"; + private const string SoraniNormalizationValue = "sorani_normalization"; + private const string StemmerValue = "stemmer"; + private const string StopwordsValue = "stopwords"; + private const string TrimValue = "trim"; + private const string TruncateValue = "truncate"; + private const string UniqueValue = "unique"; + private const string UppercaseValue = "uppercase"; + private const string WordDelimiterValue = "word_delimiter"; + + /// + /// A token filter that applies the Arabic normalizer to normalize the orthography. + /// See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html + /// + public static TokenFilterName ArabicNormalization { get; } = new TokenFilterName(ArabicNormalizationValue); + /// + /// Strips all characters after an apostrophe (including the apostrophe itself). + /// See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/tr/ApostropheFilter.html + /// + public static TokenFilterName Apostrophe { get; } = new TokenFilterName(ApostropheValue); + /// + /// Converts alphabetic, numeric, and symbolic Unicode characters which are not in + /// the first 127 ASCII characters (the "Basic Latin" Unicode block) into their + /// ASCII equivalents, if such equivalents exist. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html + /// + public static TokenFilterName AsciiFolding { get; } = new TokenFilterName(AsciiFoldingValue); + /// + /// Forms bigrams of CJK terms that are generated from the standard tokenizer. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html + /// + public static TokenFilterName CjkBigram { get; } = new TokenFilterName(CjkBigramValue); + /// + /// Normalizes CJK width differences. Folds full-width ASCII variants into the + /// equivalent basic Latin, and half-width Katakana variants into the equivalent + /// Kana. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html + /// + public static TokenFilterName CjkWidth { get; } = new TokenFilterName(CjkWidthValue); + /// + /// Removes English possessives, and dots from acronyms. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html + /// + public static TokenFilterName Classic { get; } = new TokenFilterName(ClassicValue); + /// + /// Construct bigrams for frequently occurring terms while indexing. Single terms + /// are still indexed too, with bigrams overlaid. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html + /// + public static TokenFilterName CommonGram { get; } = new TokenFilterName(CommonGramValue); + /// + /// Generates n-grams of the given size(s) starting from the front or the back of + /// an input token. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html + /// + public static TokenFilterName EdgeNGram { get; } = new TokenFilterName(EdgeNGramValue); + /// + /// Removes elisions. For example, "l'avion" (the plane) will be converted to + /// "avion" (plane). See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html + /// + public static TokenFilterName Elision { get; } = new TokenFilterName(ElisionValue); + /// + /// Normalizes German characters according to the heuristics of the German2 + /// snowball algorithm. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html + /// + public static TokenFilterName GermanNormalization { get; } = new TokenFilterName(GermanNormalizationValue); + /// + /// Normalizes text in Hindi to remove some differences in spelling variations. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html + /// + public static TokenFilterName HindiNormalization { get; } = new TokenFilterName(HindiNormalizationValue); + /// + /// Normalizes the Unicode representation of text in Indian languages. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html + /// + public static TokenFilterName IndicNormalization { get; } = new TokenFilterName(IndicNormalizationValue); + /// + /// Emits each incoming token twice, once as keyword and once as non-keyword. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html + /// + public static TokenFilterName KeywordRepeat { get; } = new TokenFilterName(KeywordRepeatValue); + /// + /// A high-performance kstem filter for English. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html + /// + public static TokenFilterName KStem { get; } = new TokenFilterName(KStemValue); + /// + /// Removes words that are too long or too short. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html + /// + public static TokenFilterName Length { get; } = new TokenFilterName(LengthValue); + /// + /// Limits the number of tokens while indexing. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html + /// + public static TokenFilterName Limit { get; } = new TokenFilterName(LimitValue); + /// + /// Normalizes token text to lower case. See + /// https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html + /// + public static TokenFilterName Lowercase { get; } = new TokenFilterName(LowercaseValue); + /// + /// Generates n-grams of the given size(s). See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html + /// + public static TokenFilterName NGram { get; } = new TokenFilterName(NGramValue); + /// + /// Applies normalization for Persian. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html + /// + public static TokenFilterName PersianNormalization { get; } = new TokenFilterName(PersianNormalizationValue); + /// + /// Create tokens for phonetic matches. See + /// https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html + /// + public static TokenFilterName Phonetic { get; } = new TokenFilterName(PhoneticValue); + /// + /// Uses the Porter stemming algorithm to transform the token stream. See + /// http://tartarus.org/~martin/PorterStemmer + /// + public static TokenFilterName PorterStem { get; } = new TokenFilterName(PorterStemValue); + /// + /// Reverses the token string. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html + /// + public static TokenFilterName Reverse { get; } = new TokenFilterName(ReverseValue); + /// + /// Normalizes use of the interchangeable Scandinavian characters. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html + /// + public static TokenFilterName ScandinavianNormalization { get; } = new TokenFilterName(ScandinavianNormalizationValue); + /// + /// Folds Scandinavian characters åÅäæÄÆ->a and öÖøØ->o. It also + /// discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just + /// the first one. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html + /// + public static TokenFilterName ScandinavianFoldingNormalization { get; } = new TokenFilterName(ScandinavianFoldingNormalizationValue); + /// + /// Creates combinations of tokens as a single token. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html + /// + public static TokenFilterName Shingle { get; } = new TokenFilterName(ShingleValue); + /// + /// A filter that stems words using a Snowball-generated stemmer. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html + /// + public static TokenFilterName Snowball { get; } = new TokenFilterName(SnowballValue); + /// + /// Normalizes the Unicode representation of Sorani text. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html + /// + public static TokenFilterName SoraniNormalization { get; } = new TokenFilterName(SoraniNormalizationValue); + /// + /// Language specific stemming filter. See + /// https://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters + /// + public static TokenFilterName Stemmer { get; } = new TokenFilterName(StemmerValue); + /// + /// Removes stop words from a token stream. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html + /// + public static TokenFilterName Stopwords { get; } = new TokenFilterName(StopwordsValue); + /// + /// Trims leading and trailing whitespace from tokens. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html + /// + public static TokenFilterName Trim { get; } = new TokenFilterName(TrimValue); + /// + /// Truncates the terms to a specific length. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html + /// + public static TokenFilterName Truncate { get; } = new TokenFilterName(TruncateValue); + /// + /// Filters out tokens with same text as the previous token. See + /// http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html + /// + public static TokenFilterName Unique { get; } = new TokenFilterName(UniqueValue); + /// + /// Normalizes token text to upper case. See + /// https://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html + /// + public static TokenFilterName Uppercase { get; } = new TokenFilterName(UppercaseValue); + /// + /// Splits words into subwords and performs optional transformations on subword + /// groups. + /// + public static TokenFilterName WordDelimiter { get; } = new TokenFilterName(WordDelimiterValue); + /// Determines if two values are the same. + public static bool operator ==(TokenFilterName left, TokenFilterName right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(TokenFilterName left, TokenFilterName right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator TokenFilterName(string value) => new TokenFilterName(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is TokenFilterName other && Equals(other); + /// + public bool Equals(TokenFilterName other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TruncateTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TruncateTokenFilter.Serialization.cs new file mode 100644 index 000000000000..172aa843defa --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TruncateTokenFilter.Serialization.cs @@ -0,0 +1,147 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class TruncateTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TruncateTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(Length)) + { + writer.WritePropertyName("length"u8); + writer.WriteNumberValue(Length.Value); + } + } + + TruncateTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TruncateTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeTruncateTokenFilter(document.RootElement, options); + } + + internal static TruncateTokenFilter DeserializeTruncateTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? length = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("length"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + length = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new TruncateTokenFilter(odataType, name, serializedAdditionalRawData, length); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(TruncateTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + TruncateTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeTruncateTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(TruncateTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new TruncateTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeTruncateTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TruncateTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TruncateTokenFilter.cs new file mode 100644 index 000000000000..58ae37b8c7a5 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/TruncateTokenFilter.cs @@ -0,0 +1,55 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Truncates the terms to a specific length. This token filter is implemented + /// using Apache Lucene. + /// + public partial class TruncateTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public TruncateTokenFilter(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.TruncateTokenFilter"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// The length at which terms will be truncated. Default and maximum is 300. + internal TruncateTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, int? length) : base(odataType, name, serializedAdditionalRawData) + { + Length = length; + } + + /// Initializes a new instance of for deserialization. + internal TruncateTokenFilter() + { + } + + /// The length at which terms will be truncated. Default and maximum is 300. + public int? Length { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UaxUrlEmailTokenizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UaxUrlEmailTokenizer.Serialization.cs new file mode 100644 index 000000000000..9e275f7821d1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UaxUrlEmailTokenizer.Serialization.cs @@ -0,0 +1,147 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class UaxUrlEmailTokenizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(UaxUrlEmailTokenizer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(MaxTokenLength)) + { + writer.WritePropertyName("maxTokenLength"u8); + writer.WriteNumberValue(MaxTokenLength.Value); + } + } + + UaxUrlEmailTokenizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(UaxUrlEmailTokenizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeUaxUrlEmailTokenizer(document.RootElement, options); + } + + internal static UaxUrlEmailTokenizer DeserializeUaxUrlEmailTokenizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? maxTokenLength = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("maxTokenLength"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxTokenLength = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UaxUrlEmailTokenizer(odataType, name, serializedAdditionalRawData, maxTokenLength); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(UaxUrlEmailTokenizer)} does not support writing '{options.Format}' format."); + } + } + + UaxUrlEmailTokenizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUaxUrlEmailTokenizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(UaxUrlEmailTokenizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UaxUrlEmailTokenizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUaxUrlEmailTokenizer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UaxUrlEmailTokenizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UaxUrlEmailTokenizer.cs new file mode 100644 index 000000000000..d6b21d4335bf --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UaxUrlEmailTokenizer.cs @@ -0,0 +1,61 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Tokenizes urls and emails as one token. This tokenizer is implemented using + /// Apache Lucene. + /// + public partial class UaxUrlEmailTokenizer : LexicalTokenizer + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public UaxUrlEmailTokenizer(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.UaxUrlEmailTokenizer"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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, IDictionary serializedAdditionalRawData, int? maxTokenLength) : base(odataType, name, serializedAdditionalRawData) + { + MaxTokenLength = maxTokenLength; + } + + /// Initializes a new instance of for deserialization. + internal UaxUrlEmailTokenizer() + { + } + + /// + /// 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. + /// + public int? MaxTokenLength { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UniqueTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UniqueTokenFilter.Serialization.cs new file mode 100644 index 000000000000..624c414cb182 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UniqueTokenFilter.Serialization.cs @@ -0,0 +1,147 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class UniqueTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(UniqueTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(OnlyOnSamePosition)) + { + writer.WritePropertyName("onlyOnSamePosition"u8); + writer.WriteBooleanValue(OnlyOnSamePosition.Value); + } + } + + UniqueTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(UniqueTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeUniqueTokenFilter(document.RootElement, options); + } + + internal static UniqueTokenFilter DeserializeUniqueTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + bool? onlyOnSamePosition = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("onlyOnSamePosition"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + onlyOnSamePosition = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UniqueTokenFilter(odataType, name, serializedAdditionalRawData, onlyOnSamePosition); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(UniqueTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + UniqueTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUniqueTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(UniqueTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UniqueTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUniqueTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UniqueTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UniqueTokenFilter.cs new file mode 100644 index 000000000000..2a5396bc7735 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UniqueTokenFilter.cs @@ -0,0 +1,61 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Filters out tokens with same text as the previous token. This token filter is + /// implemented using Apache Lucene. + /// + public partial class UniqueTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public UniqueTokenFilter(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.UniqueTokenFilter"; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// A value indicating whether to remove duplicates only at the same position. + /// Default is false. + /// + internal UniqueTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, bool? onlyOnSamePosition) : base(odataType, name, serializedAdditionalRawData) + { + OnlyOnSamePosition = onlyOnSamePosition; + } + + /// Initializes a new instance of for deserialization. + internal UniqueTokenFilter() + { + } + + /// + /// A value indicating whether to remove duplicates only at the same position. + /// Default is false. + /// + public bool? OnlyOnSamePosition { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownCharFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownCharFilter.Serialization.cs new file mode 100644 index 000000000000..6bcf0f4c0c14 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownCharFilter.Serialization.cs @@ -0,0 +1,132 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal partial class UnknownCharFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CharFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + CharFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CharFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeCharFilter(document.RootElement, options); + } + + internal static UnknownCharFilter DeserializeUnknownCharFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = "Unknown"; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownCharFilter(odataType, name, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(CharFilter)} does not support writing '{options.Format}' format."); + } + } + + CharFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCharFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(CharFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownCharFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownCharFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownCharFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownCharFilter.cs new file mode 100644 index 000000000000..ae9257d9efcd --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownCharFilter.cs @@ -0,0 +1,33 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Unknown version of CharFilter. + internal partial class UnknownCharFilter : CharFilter + { + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal UnknownCharFilter(string odataType, string name, IDictionary serializedAdditionalRawData) : base(odataType, name, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownCharFilter() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownCognitiveServicesAccount.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownCognitiveServicesAccount.Serialization.cs new file mode 100644 index 000000000000..4a40f0fb3e39 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownCognitiveServicesAccount.Serialization.cs @@ -0,0 +1,132 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal partial class UnknownCognitiveServicesAccount : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CognitiveServicesAccount)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + CognitiveServicesAccount IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(CognitiveServicesAccount)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeCognitiveServicesAccount(document.RootElement, options); + } + + internal static UnknownCognitiveServicesAccount DeserializeUnknownCognitiveServicesAccount(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = "Unknown"; + string description = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownCognitiveServicesAccount(odataType, description, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(CognitiveServicesAccount)} does not support writing '{options.Format}' format."); + } + } + + CognitiveServicesAccount IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeCognitiveServicesAccount(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(CognitiveServicesAccount)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownCognitiveServicesAccount FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownCognitiveServicesAccount(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownCognitiveServicesAccount.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownCognitiveServicesAccount.cs new file mode 100644 index 000000000000..7c353ee4f7d1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownCognitiveServicesAccount.cs @@ -0,0 +1,29 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Unknown version of CognitiveServicesAccount. + internal partial class UnknownCognitiveServicesAccount : CognitiveServicesAccount + { + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Description of the Azure AI service resource attached to a skillset. + /// Keeps track of any properties unknown to the library. + internal UnknownCognitiveServicesAccount(string odataType, string description, IDictionary serializedAdditionalRawData) : base(odataType, description, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownCognitiveServicesAccount() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownDataChangeDetectionPolicy.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownDataChangeDetectionPolicy.Serialization.cs new file mode 100644 index 000000000000..a678038714ae --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownDataChangeDetectionPolicy.Serialization.cs @@ -0,0 +1,126 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal partial class UnknownDataChangeDetectionPolicy : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DataChangeDetectionPolicy)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + DataChangeDetectionPolicy IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DataChangeDetectionPolicy)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeDataChangeDetectionPolicy(document.RootElement, options); + } + + internal static UnknownDataChangeDetectionPolicy DeserializeUnknownDataChangeDetectionPolicy(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = "Unknown"; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownDataChangeDetectionPolicy(odataType, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(DataChangeDetectionPolicy)} does not support writing '{options.Format}' format."); + } + } + + DataChangeDetectionPolicy IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDataChangeDetectionPolicy(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(DataChangeDetectionPolicy)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownDataChangeDetectionPolicy FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownDataChangeDetectionPolicy(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownDataChangeDetectionPolicy.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownDataChangeDetectionPolicy.cs new file mode 100644 index 000000000000..29f79c50c9bc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownDataChangeDetectionPolicy.cs @@ -0,0 +1,28 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Unknown version of DataChangeDetectionPolicy. + internal partial class UnknownDataChangeDetectionPolicy : DataChangeDetectionPolicy + { + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Keeps track of any properties unknown to the library. + internal UnknownDataChangeDetectionPolicy(string odataType, IDictionary serializedAdditionalRawData) : base(odataType, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownDataChangeDetectionPolicy() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownDataDeletionDetectionPolicy.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownDataDeletionDetectionPolicy.Serialization.cs new file mode 100644 index 000000000000..a7bfdd248cbe --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownDataDeletionDetectionPolicy.Serialization.cs @@ -0,0 +1,126 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal partial class UnknownDataDeletionDetectionPolicy : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DataDeletionDetectionPolicy)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + DataDeletionDetectionPolicy IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DataDeletionDetectionPolicy)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeDataDeletionDetectionPolicy(document.RootElement, options); + } + + internal static UnknownDataDeletionDetectionPolicy DeserializeUnknownDataDeletionDetectionPolicy(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = "Unknown"; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownDataDeletionDetectionPolicy(odataType, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(DataDeletionDetectionPolicy)} does not support writing '{options.Format}' format."); + } + } + + DataDeletionDetectionPolicy IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDataDeletionDetectionPolicy(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(DataDeletionDetectionPolicy)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownDataDeletionDetectionPolicy FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownDataDeletionDetectionPolicy(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownDataDeletionDetectionPolicy.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownDataDeletionDetectionPolicy.cs new file mode 100644 index 000000000000..c92d71d6c567 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownDataDeletionDetectionPolicy.cs @@ -0,0 +1,28 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Unknown version of DataDeletionDetectionPolicy. + internal partial class UnknownDataDeletionDetectionPolicy : DataDeletionDetectionPolicy + { + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Keeps track of any properties unknown to the library. + internal UnknownDataDeletionDetectionPolicy(string odataType, IDictionary serializedAdditionalRawData) : base(odataType, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownDataDeletionDetectionPolicy() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalAnalyzer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalAnalyzer.Serialization.cs new file mode 100644 index 000000000000..2df425d40e83 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalAnalyzer.Serialization.cs @@ -0,0 +1,132 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal partial class UnknownLexicalAnalyzer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LexicalAnalyzer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + LexicalAnalyzer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LexicalAnalyzer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeLexicalAnalyzer(document.RootElement, options); + } + + internal static UnknownLexicalAnalyzer DeserializeUnknownLexicalAnalyzer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = "Unknown"; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownLexicalAnalyzer(odataType, name, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(LexicalAnalyzer)} does not support writing '{options.Format}' format."); + } + } + + LexicalAnalyzer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLexicalAnalyzer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(LexicalAnalyzer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownLexicalAnalyzer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownLexicalAnalyzer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalAnalyzer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalAnalyzer.cs new file mode 100644 index 000000000000..dbe0ff9dca3d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalAnalyzer.cs @@ -0,0 +1,33 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Unknown version of LexicalAnalyzer. + internal partial class UnknownLexicalAnalyzer : LexicalAnalyzer + { + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal UnknownLexicalAnalyzer(string odataType, string name, IDictionary serializedAdditionalRawData) : base(odataType, name, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownLexicalAnalyzer() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalNormalizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalNormalizer.Serialization.cs new file mode 100644 index 000000000000..33314b67689d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalNormalizer.Serialization.cs @@ -0,0 +1,132 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal partial class UnknownLexicalNormalizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LexicalNormalizer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + LexicalNormalizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LexicalNormalizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeLexicalNormalizer(document.RootElement, options); + } + + internal static UnknownLexicalNormalizer DeserializeUnknownLexicalNormalizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = "Unknown"; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownLexicalNormalizer(odataType, name, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(LexicalNormalizer)} does not support writing '{options.Format}' format."); + } + } + + LexicalNormalizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLexicalNormalizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(LexicalNormalizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownLexicalNormalizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownLexicalNormalizer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalNormalizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalNormalizer.cs new file mode 100644 index 000000000000..6542d90c187e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalNormalizer.cs @@ -0,0 +1,33 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Unknown version of LexicalNormalizer. + internal partial class UnknownLexicalNormalizer : LexicalNormalizer + { + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal UnknownLexicalNormalizer(string odataType, string name, IDictionary serializedAdditionalRawData) : base(odataType, name, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownLexicalNormalizer() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalTokenizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalTokenizer.Serialization.cs new file mode 100644 index 000000000000..646fcbd29d51 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalTokenizer.Serialization.cs @@ -0,0 +1,132 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal partial class UnknownLexicalTokenizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LexicalTokenizer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + LexicalTokenizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LexicalTokenizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeLexicalTokenizer(document.RootElement, options); + } + + internal static UnknownLexicalTokenizer DeserializeUnknownLexicalTokenizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = "Unknown"; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownLexicalTokenizer(odataType, name, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(LexicalTokenizer)} does not support writing '{options.Format}' format."); + } + } + + LexicalTokenizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLexicalTokenizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(LexicalTokenizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownLexicalTokenizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownLexicalTokenizer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalTokenizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalTokenizer.cs new file mode 100644 index 000000000000..b07047ed374f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownLexicalTokenizer.cs @@ -0,0 +1,33 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Unknown version of LexicalTokenizer. + internal partial class UnknownLexicalTokenizer : LexicalTokenizer + { + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal UnknownLexicalTokenizer(string odataType, string name, IDictionary serializedAdditionalRawData) : base(odataType, name, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownLexicalTokenizer() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownScoringFunction.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownScoringFunction.Serialization.cs new file mode 100644 index 000000000000..083744db60b4 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownScoringFunction.Serialization.cs @@ -0,0 +1,148 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal partial class UnknownScoringFunction : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ScoringFunction)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + ScoringFunction IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(ScoringFunction)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeScoringFunction(document.RootElement, options); + } + + internal static UnknownScoringFunction DeserializeUnknownScoringFunction(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string fieldName = default; + double boost = default; + ScoringFunctionInterpolation? interpolation = default; + string type = "Unknown"; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("fieldName"u8)) + { + fieldName = property.Value.GetString(); + continue; + } + if (property.NameEquals("boost"u8)) + { + boost = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("interpolation"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + interpolation = new ScoringFunctionInterpolation(property.Value.GetString()); + continue; + } + if (property.NameEquals("type"u8)) + { + type = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownScoringFunction(fieldName, boost, interpolation, type, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(ScoringFunction)} does not support writing '{options.Format}' format."); + } + } + + ScoringFunction IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeScoringFunction(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(ScoringFunction)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownScoringFunction FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownScoringFunction(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownScoringFunction.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownScoringFunction.cs new file mode 100644 index 000000000000..65118963667a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownScoringFunction.cs @@ -0,0 +1,34 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Unknown version of ScoringFunction. + internal partial class UnknownScoringFunction : ScoringFunction + { + /// Initializes a new instance of . + /// The name of the field used as input to the scoring function. + /// A multiplier for the raw score. Must be a positive number not equal to 1.0. + /// + /// A value indicating how boosting will be interpolated across document scores; + /// defaults to "Linear". + /// + /// Type of ScoringFunction. + /// Keeps track of any properties unknown to the library. + internal UnknownScoringFunction(string fieldName, double boost, ScoringFunctionInterpolation? interpolation, string type, IDictionary serializedAdditionalRawData) : base(fieldName, boost, interpolation, type, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownScoringFunction() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSearchIndexerDataIdentity.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSearchIndexerDataIdentity.Serialization.cs new file mode 100644 index 000000000000..242605419566 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSearchIndexerDataIdentity.Serialization.cs @@ -0,0 +1,126 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal partial class UnknownSearchIndexerDataIdentity : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerDataIdentity)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + SearchIndexerDataIdentity IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerDataIdentity)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerDataIdentity(document.RootElement, options); + } + + internal static UnknownSearchIndexerDataIdentity DeserializeUnknownSearchIndexerDataIdentity(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = "Unknown"; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownSearchIndexerDataIdentity(odataType, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerDataIdentity)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerDataIdentity IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerDataIdentity(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerDataIdentity)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownSearchIndexerDataIdentity FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownSearchIndexerDataIdentity(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSearchIndexerDataIdentity.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSearchIndexerDataIdentity.cs new file mode 100644 index 000000000000..6aac6469eb38 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSearchIndexerDataIdentity.cs @@ -0,0 +1,28 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Unknown version of SearchIndexerDataIdentity. + internal partial class UnknownSearchIndexerDataIdentity : SearchIndexerDataIdentity + { + /// Initializes a new instance of . + /// A URI fragment specifying the type of identity. + /// Keeps track of any properties unknown to the library. + internal UnknownSearchIndexerDataIdentity(string odataType, IDictionary serializedAdditionalRawData) : base(odataType, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownSearchIndexerDataIdentity() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSearchIndexerSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSearchIndexerSkill.Serialization.cs new file mode 100644 index 000000000000..0e911a1ee956 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSearchIndexerSkill.Serialization.cs @@ -0,0 +1,173 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal partial class UnknownSearchIndexerSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + SearchIndexerSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchIndexerSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchIndexerSkill(document.RootElement, options); + } + + internal static UnknownSearchIndexerSkill DeserializeUnknownSearchIndexerSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = "Unknown"; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownSearchIndexerSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchIndexerSkill)} does not support writing '{options.Format}' format."); + } + } + + SearchIndexerSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchIndexerSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchIndexerSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownSearchIndexerSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownSearchIndexerSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSearchIndexerSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSearchIndexerSkill.cs new file mode 100644 index 000000000000..16fa0bd734dc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSearchIndexerSkill.cs @@ -0,0 +1,50 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Unknown version of SearchIndexerSkill. + internal partial class UnknownSearchIndexerSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal UnknownSearchIndexerSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownSearchIndexerSkill() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSimilarityAlgorithm.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSimilarityAlgorithm.Serialization.cs new file mode 100644 index 000000000000..862cdeaf16b9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSimilarityAlgorithm.Serialization.cs @@ -0,0 +1,126 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal partial class UnknownSimilarityAlgorithm : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SimilarityAlgorithm)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + SimilarityAlgorithm IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SimilarityAlgorithm)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSimilarityAlgorithm(document.RootElement, options); + } + + internal static UnknownSimilarityAlgorithm DeserializeUnknownSimilarityAlgorithm(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = "Unknown"; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownSimilarityAlgorithm(odataType, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SimilarityAlgorithm)} does not support writing '{options.Format}' format."); + } + } + + SimilarityAlgorithm IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSimilarityAlgorithm(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SimilarityAlgorithm)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownSimilarityAlgorithm FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownSimilarityAlgorithm(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSimilarityAlgorithm.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSimilarityAlgorithm.cs new file mode 100644 index 000000000000..9845a2f223ce --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownSimilarityAlgorithm.cs @@ -0,0 +1,28 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Unknown version of SimilarityAlgorithm. + internal partial class UnknownSimilarityAlgorithm : SimilarityAlgorithm + { + /// Initializes a new instance of . + /// The discriminator for derived types. + /// Keeps track of any properties unknown to the library. + internal UnknownSimilarityAlgorithm(string odataType, IDictionary serializedAdditionalRawData) : base(odataType, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownSimilarityAlgorithm() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownTokenFilter.Serialization.cs new file mode 100644 index 000000000000..c140ed5da59d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownTokenFilter.Serialization.cs @@ -0,0 +1,132 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal partial class UnknownTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + TokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeTokenFilter(document.RootElement, options); + } + + internal static UnknownTokenFilter DeserializeUnknownTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string odataType = "Unknown"; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownTokenFilter(odataType, name, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(TokenFilter)} does not support writing '{options.Format}' format."); + } + } + + TokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(TokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownTokenFilter.cs new file mode 100644 index 000000000000..c80aafacb601 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownTokenFilter.cs @@ -0,0 +1,33 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Unknown version of TokenFilter. + internal partial class UnknownTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal UnknownTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData) : base(odataType, name, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownTokenFilter() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchAlgorithmConfiguration.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchAlgorithmConfiguration.Serialization.cs new file mode 100644 index 000000000000..527501391a7f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchAlgorithmConfiguration.Serialization.cs @@ -0,0 +1,132 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal partial class UnknownVectorSearchAlgorithmConfiguration : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearchAlgorithmConfiguration)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + VectorSearchAlgorithmConfiguration IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearchAlgorithmConfiguration)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorSearchAlgorithmConfiguration(document.RootElement, options); + } + + internal static UnknownVectorSearchAlgorithmConfiguration DeserializeUnknownVectorSearchAlgorithmConfiguration(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + VectorSearchAlgorithmKind kind = "Unknown"; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorSearchAlgorithmKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownVectorSearchAlgorithmConfiguration(name, kind, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorSearchAlgorithmConfiguration)} does not support writing '{options.Format}' format."); + } + } + + VectorSearchAlgorithmConfiguration IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorSearchAlgorithmConfiguration(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorSearchAlgorithmConfiguration)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownVectorSearchAlgorithmConfiguration FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownVectorSearchAlgorithmConfiguration(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchAlgorithmConfiguration.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchAlgorithmConfiguration.cs new file mode 100644 index 000000000000..2cdbb63a02ed --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchAlgorithmConfiguration.cs @@ -0,0 +1,29 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Unknown version of VectorSearchAlgorithmConfiguration. + internal partial class UnknownVectorSearchAlgorithmConfiguration : VectorSearchAlgorithmConfiguration + { + /// Initializes a new instance of . + /// The name to associate with this particular configuration. + /// Type of VectorSearchAlgorithmConfiguration. + /// Keeps track of any properties unknown to the library. + internal UnknownVectorSearchAlgorithmConfiguration(string name, VectorSearchAlgorithmKind kind, IDictionary serializedAdditionalRawData) : base(name, kind, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownVectorSearchAlgorithmConfiguration() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchCompression.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchCompression.Serialization.cs new file mode 100644 index 000000000000..8f0555d949b7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchCompression.Serialization.cs @@ -0,0 +1,179 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal partial class UnknownVectorSearchCompression : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearchCompression)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + VectorSearchCompression IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearchCompression)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorSearchCompression(document.RootElement, options); + } + + internal static UnknownVectorSearchCompression DeserializeUnknownVectorSearchCompression(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + bool? rerankWithOriginalVectors = default; + double? defaultOversampling = default; + RescoringOptions rescoringOptions = default; + int? truncationDimension = default; + VectorSearchCompressionKind kind = "Unknown"; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("rerankWithOriginalVectors"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + rerankWithOriginalVectors = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("defaultOversampling"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + defaultOversampling = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("rescoringOptions"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + rescoringOptions = RescoringOptions.DeserializeRescoringOptions(property.Value, options); + continue; + } + if (property.NameEquals("truncationDimension"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + truncationDimension = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorSearchCompressionKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownVectorSearchCompression( + name, + rerankWithOriginalVectors, + defaultOversampling, + rescoringOptions, + truncationDimension, + kind, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorSearchCompression)} does not support writing '{options.Format}' format."); + } + } + + VectorSearchCompression IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorSearchCompression(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorSearchCompression)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownVectorSearchCompression FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownVectorSearchCompression(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchCompression.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchCompression.cs new file mode 100644 index 000000000000..b019b319231c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchCompression.cs @@ -0,0 +1,53 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Unknown version of VectorSearchCompression. + internal partial class UnknownVectorSearchCompression : VectorSearchCompression + { + /// Initializes a new instance of . + /// The name to associate with this particular configuration. + /// + /// If set to true, once the ordered set of results calculated using compressed + /// vectors are obtained, they will be reranked again by recalculating the + /// full-precision similarity scores. This will improve recall at the expense of + /// latency. + /// + /// + /// Default oversampling factor. Oversampling will internally request more + /// documents (specified by this multiplier) in the initial search. This increases + /// the set of results that will be reranked using recomputed similarity scores + /// from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). + /// This parameter can only be set when rerankWithOriginalVectors is true. Higher + /// values improve recall at the expense of latency. + /// + /// Contains the options for rescoring. + /// + /// The number of dimensions to truncate the vectors to. Truncating the vectors + /// reduces the size of the vectors and the amount of data that needs to be + /// transferred during search. This can save storage cost and improve search + /// performance at the expense of recall. It should be only used for embeddings + /// trained with Matryoshka Representation Learning (MRL) such as OpenAI + /// text-embedding-3-large (small). The default value is null, which means no + /// truncation. + /// + /// Type of VectorSearchCompression. + /// Keeps track of any properties unknown to the library. + internal UnknownVectorSearchCompression(string name, bool? rerankWithOriginalVectors, double? defaultOversampling, RescoringOptions rescoringOptions, int? truncationDimension, VectorSearchCompressionKind kind, IDictionary serializedAdditionalRawData) : base(name, rerankWithOriginalVectors, defaultOversampling, rescoringOptions, truncationDimension, kind, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownVectorSearchCompression() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchVectorizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchVectorizer.Serialization.cs new file mode 100644 index 000000000000..12ac21e3227d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchVectorizer.Serialization.cs @@ -0,0 +1,132 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + internal partial class UnknownVectorSearchVectorizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearchVectorizer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + VectorSearchVectorizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearchVectorizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorSearchVectorizer(document.RootElement, options); + } + + internal static UnknownVectorSearchVectorizer DeserializeUnknownVectorSearchVectorizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + VectorSearchVectorizerKind kind = "Unknown"; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorSearchVectorizerKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownVectorSearchVectorizer(name, kind, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorSearchVectorizer)} does not support writing '{options.Format}' format."); + } + } + + VectorSearchVectorizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorSearchVectorizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorSearchVectorizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownVectorSearchVectorizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownVectorSearchVectorizer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchVectorizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchVectorizer.cs new file mode 100644 index 000000000000..177db3dd1d02 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/UnknownVectorSearchVectorizer.cs @@ -0,0 +1,29 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Unknown version of VectorSearchVectorizer. + internal partial class UnknownVectorSearchVectorizer : VectorSearchVectorizer + { + /// Initializes a new instance of . + /// The name to associate with this particular vectorization method. + /// Type of VectorSearchVectorizer. + /// Keeps track of any properties unknown to the library. + internal UnknownVectorSearchVectorizer(string name, VectorSearchVectorizerKind kind, IDictionary serializedAdditionalRawData) : base(name, kind, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownVectorSearchVectorizer() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorEncodingFormat.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorEncodingFormat.cs new file mode 100644 index 000000000000..27c3b90789c4 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorEncodingFormat.cs @@ -0,0 +1,48 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The encoding format for interpreting vector field contents. + public readonly partial struct VectorEncodingFormat : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public VectorEncodingFormat(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string PackedBitValue = "packedBit"; + + /// Encoding format representing bits packed into a wider data type. + public static VectorEncodingFormat PackedBit { get; } = new VectorEncodingFormat(PackedBitValue); + /// Determines if two values are the same. + public static bool operator ==(VectorEncodingFormat left, VectorEncodingFormat right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(VectorEncodingFormat left, VectorEncodingFormat right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator VectorEncodingFormat(string value) => new VectorEncodingFormat(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is VectorEncodingFormat other && Equals(other); + /// + public bool Equals(VectorEncodingFormat other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearch.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearch.Serialization.cs new file mode 100644 index 000000000000..9c77072a8d1a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearch.Serialization.cs @@ -0,0 +1,234 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class VectorSearch : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearch)} does not support writing '{format}' format."); + } + + if (Optional.IsCollectionDefined(Profiles)) + { + writer.WritePropertyName("profiles"u8); + writer.WriteStartArray(); + foreach (var item in Profiles) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(Algorithms)) + { + writer.WritePropertyName("algorithms"u8); + writer.WriteStartArray(); + foreach (var item in Algorithms) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(Vectorizers)) + { + writer.WritePropertyName("vectorizers"u8); + writer.WriteStartArray(); + foreach (var item in Vectorizers) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsCollectionDefined(Compressions)) + { + writer.WritePropertyName("compressions"u8); + writer.WriteStartArray(); + foreach (var item in Compressions) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + VectorSearch IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearch)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorSearch(document.RootElement, options); + } + + internal static VectorSearch DeserializeVectorSearch(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList profiles = default; + IList algorithms = default; + IList vectorizers = default; + IList compressions = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("profiles"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(VectorSearchProfile.DeserializeVectorSearchProfile(item, options)); + } + profiles = array; + continue; + } + if (property.NameEquals("algorithms"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(VectorSearchAlgorithmConfiguration.DeserializeVectorSearchAlgorithmConfiguration(item, options)); + } + algorithms = array; + continue; + } + if (property.NameEquals("vectorizers"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(VectorSearchVectorizer.DeserializeVectorSearchVectorizer(item, options)); + } + vectorizers = array; + continue; + } + if (property.NameEquals("compressions"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(VectorSearchCompression.DeserializeVectorSearchCompression(item, options)); + } + compressions = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new VectorSearch(profiles ?? new ChangeTrackingList(), algorithms ?? new ChangeTrackingList(), vectorizers ?? new ChangeTrackingList(), compressions ?? new ChangeTrackingList(), serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorSearch)} does not support writing '{options.Format}' format."); + } + } + + VectorSearch IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorSearch(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorSearch)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static VectorSearch FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorSearch(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearch.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearch.cs new file mode 100644 index 000000000000..993a3ebe1715 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearch.cs @@ -0,0 +1,109 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Contains configuration options related to vector search. + public partial class VectorSearch + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public VectorSearch() + { + Profiles = new ChangeTrackingList(); + Algorithms = new ChangeTrackingList(); + Vectorizers = new ChangeTrackingList(); + Compressions = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// Defines combinations of configurations to use with vector search. + /// + /// 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 . + /// + /// + /// Contains configuration options on how to vectorize text vector 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. + /// The available derived classes include , , and . + /// + /// + /// Contains configuration options specific to the compression method 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 . + /// + /// Keeps track of any properties unknown to the library. + internal VectorSearch(IList profiles, IList algorithms, IList vectorizers, IList compressions, IDictionary serializedAdditionalRawData) + { + Profiles = profiles; + Algorithms = algorithms; + Vectorizers = vectorizers; + Compressions = compressions; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Defines combinations of configurations to use with vector search. + public IList Profiles { get; } + /// + /// 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 . + /// + public IList Algorithms { get; } + /// + /// Contains configuration options on how to vectorize text vector 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. + /// The available derived classes include , , and . + /// + public IList Vectorizers { get; } + /// + /// Contains configuration options specific to the compression method 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 . + /// + public IList Compressions { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchAlgorithmConfiguration.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchAlgorithmConfiguration.Serialization.cs new file mode 100644 index 000000000000..6398fb4c1388 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchAlgorithmConfiguration.Serialization.cs @@ -0,0 +1,136 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + [PersistableModelProxy(typeof(UnknownVectorSearchAlgorithmConfiguration))] + public partial class VectorSearchAlgorithmConfiguration : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearchAlgorithmConfiguration)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + writer.WritePropertyName("kind"u8); + writer.WriteStringValue(Kind.ToString()); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + VectorSearchAlgorithmConfiguration IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearchAlgorithmConfiguration)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorSearchAlgorithmConfiguration(document.RootElement, options); + } + + internal static VectorSearchAlgorithmConfiguration DeserializeVectorSearchAlgorithmConfiguration(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("kind", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "exhaustiveKnn": return ExhaustiveKnnAlgorithmConfiguration.DeserializeExhaustiveKnnAlgorithmConfiguration(element, options); + case "hnsw": return HnswAlgorithmConfiguration.DeserializeHnswAlgorithmConfiguration(element, options); + } + } + return UnknownVectorSearchAlgorithmConfiguration.DeserializeUnknownVectorSearchAlgorithmConfiguration(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorSearchAlgorithmConfiguration)} does not support writing '{options.Format}' format."); + } + } + + VectorSearchAlgorithmConfiguration IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorSearchAlgorithmConfiguration(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorSearchAlgorithmConfiguration)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static VectorSearchAlgorithmConfiguration FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorSearchAlgorithmConfiguration(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchAlgorithmConfiguration.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchAlgorithmConfiguration.cs new file mode 100644 index 000000000000..7899095dd9b4 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchAlgorithmConfiguration.cs @@ -0,0 +1,84 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// 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 . + /// + public abstract partial class VectorSearchAlgorithmConfiguration + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name to associate with this particular configuration. + /// is null. + protected VectorSearchAlgorithmConfiguration(string name) + { + Argument.AssertNotNull(name, nameof(name)); + + Name = name; + } + + /// Initializes a new instance of . + /// The name to associate with this particular configuration. + /// Type of VectorSearchAlgorithmConfiguration. + /// Keeps track of any properties unknown to the library. + internal VectorSearchAlgorithmConfiguration(string name, VectorSearchAlgorithmKind kind, IDictionary serializedAdditionalRawData) + { + Name = name; + Kind = kind; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal VectorSearchAlgorithmConfiguration() + { + } + + /// The name to associate with this particular configuration. + public string Name { get; set; } + /// Type of VectorSearchAlgorithmConfiguration. + internal VectorSearchAlgorithmKind Kind { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchAlgorithmKind.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchAlgorithmKind.cs new file mode 100644 index 000000000000..65411901900b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchAlgorithmKind.cs @@ -0,0 +1,54 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The algorithm used for indexing and querying. + internal readonly partial struct VectorSearchAlgorithmKind : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public VectorSearchAlgorithmKind(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string HnswValue = "hnsw"; + private const string ExhaustiveKnnValue = "exhaustiveKnn"; + + /// + /// 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); + /// Determines if two values are the same. + public static bool operator ==(VectorSearchAlgorithmKind left, VectorSearchAlgorithmKind right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(VectorSearchAlgorithmKind left, VectorSearchAlgorithmKind right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator VectorSearchAlgorithmKind(string value) => new VectorSearchAlgorithmKind(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is VectorSearchAlgorithmKind other && Equals(other); + /// + public bool Equals(VectorSearchAlgorithmKind other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchAlgorithmMetric.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchAlgorithmMetric.cs new file mode 100644 index 000000000000..938fa67d4146 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchAlgorithmMetric.cs @@ -0,0 +1,73 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// The similarity metric to use for vector comparisons. It is recommended to + /// choose the same similarity metric as the embedding model was trained on. + /// + public readonly partial struct VectorSearchAlgorithmMetric : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public VectorSearchAlgorithmMetric(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string CosineValue = "cosine"; + private const string EuclideanValue = "euclidean"; + private const string DotProductValue = "dotProduct"; + private const string HammingValue = "hamming"; + + /// + /// Measures the angle between vectors to quantify their similarity, disregarding + /// magnitude. The smaller the angle, the closer the similarity. + /// + public static VectorSearchAlgorithmMetric Cosine { get; } = new VectorSearchAlgorithmMetric(CosineValue); + /// + /// Computes the straight-line distance between vectors in a multi-dimensional + /// space. The smaller the distance, the closer the similarity. + /// + public static VectorSearchAlgorithmMetric Euclidean { get; } = new VectorSearchAlgorithmMetric(EuclideanValue); + /// + /// Calculates the sum of element-wise products to gauge alignment and magnitude + /// similarity. The larger and more positive, the closer the similarity. + /// + public static VectorSearchAlgorithmMetric DotProduct { get; } = new VectorSearchAlgorithmMetric(DotProductValue); + /// + /// Only applicable to bit-packed binary data types. Determines dissimilarity by + /// counting differing positions in binary vectors. The fewer differences, the + /// closer the similarity. + /// + public static VectorSearchAlgorithmMetric Hamming { get; } = new VectorSearchAlgorithmMetric(HammingValue); + /// Determines if two values are the same. + public static bool operator ==(VectorSearchAlgorithmMetric left, VectorSearchAlgorithmMetric right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(VectorSearchAlgorithmMetric left, VectorSearchAlgorithmMetric right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator VectorSearchAlgorithmMetric(string value) => new VectorSearchAlgorithmMetric(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is VectorSearchAlgorithmMetric other && Equals(other); + /// + public bool Equals(VectorSearchAlgorithmMetric other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchCompression.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchCompression.Serialization.cs new file mode 100644 index 000000000000..56343bdd0783 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchCompression.Serialization.cs @@ -0,0 +1,156 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + [PersistableModelProxy(typeof(UnknownVectorSearchCompression))] + public partial class VectorSearchCompression : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearchCompression)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + if (Optional.IsDefined(RerankWithOriginalVectors)) + { + writer.WritePropertyName("rerankWithOriginalVectors"u8); + writer.WriteBooleanValue(RerankWithOriginalVectors.Value); + } + if (Optional.IsDefined(DefaultOversampling)) + { + writer.WritePropertyName("defaultOversampling"u8); + writer.WriteNumberValue(DefaultOversampling.Value); + } + if (Optional.IsDefined(RescoringOptions)) + { + writer.WritePropertyName("rescoringOptions"u8); + writer.WriteObjectValue(RescoringOptions, options); + } + if (Optional.IsDefined(TruncationDimension)) + { + writer.WritePropertyName("truncationDimension"u8); + writer.WriteNumberValue(TruncationDimension.Value); + } + writer.WritePropertyName("kind"u8); + writer.WriteStringValue(Kind.ToString()); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + VectorSearchCompression IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearchCompression)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorSearchCompression(document.RootElement, options); + } + + internal static VectorSearchCompression DeserializeVectorSearchCompression(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("kind", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "binaryQuantization": return BinaryQuantizationCompression.DeserializeBinaryQuantizationCompression(element, options); + case "scalarQuantization": return ScalarQuantizationCompression.DeserializeScalarQuantizationCompression(element, options); + } + } + return UnknownVectorSearchCompression.DeserializeUnknownVectorSearchCompression(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorSearchCompression)} does not support writing '{options.Format}' format."); + } + } + + VectorSearchCompression IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorSearchCompression(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorSearchCompression)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static VectorSearchCompression FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorSearchCompression(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchCompression.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchCompression.cs new file mode 100644 index 000000000000..89a74a90d07d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchCompression.cs @@ -0,0 +1,140 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Contains configuration options specific to the compression method 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 . + /// + public abstract partial class VectorSearchCompression + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name to associate with this particular configuration. + /// is null. + protected VectorSearchCompression(string name) + { + Argument.AssertNotNull(name, nameof(name)); + + Name = name; + } + + /// Initializes a new instance of . + /// The name to associate with this particular configuration. + /// + /// If set to true, once the ordered set of results calculated using compressed + /// vectors are obtained, they will be reranked again by recalculating the + /// full-precision similarity scores. This will improve recall at the expense of + /// latency. + /// + /// + /// Default oversampling factor. Oversampling will internally request more + /// documents (specified by this multiplier) in the initial search. This increases + /// the set of results that will be reranked using recomputed similarity scores + /// from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). + /// This parameter can only be set when rerankWithOriginalVectors is true. Higher + /// values improve recall at the expense of latency. + /// + /// Contains the options for rescoring. + /// + /// The number of dimensions to truncate the vectors to. Truncating the vectors + /// reduces the size of the vectors and the amount of data that needs to be + /// transferred during search. This can save storage cost and improve search + /// performance at the expense of recall. It should be only used for embeddings + /// trained with Matryoshka Representation Learning (MRL) such as OpenAI + /// text-embedding-3-large (small). The default value is null, which means no + /// truncation. + /// + /// Type of VectorSearchCompression. + /// Keeps track of any properties unknown to the library. + internal VectorSearchCompression(string name, bool? rerankWithOriginalVectors, double? defaultOversampling, RescoringOptions rescoringOptions, int? truncationDimension, VectorSearchCompressionKind kind, IDictionary serializedAdditionalRawData) + { + Name = name; + RerankWithOriginalVectors = rerankWithOriginalVectors; + DefaultOversampling = defaultOversampling; + RescoringOptions = rescoringOptions; + TruncationDimension = truncationDimension; + Kind = kind; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal VectorSearchCompression() + { + } + + /// The name to associate with this particular configuration. + public string Name { get; set; } + /// + /// If set to true, once the ordered set of results calculated using compressed + /// vectors are obtained, they will be reranked again by recalculating the + /// full-precision similarity scores. This will improve recall at the expense of + /// latency. + /// + public bool? RerankWithOriginalVectors { get; set; } + /// + /// Default oversampling factor. Oversampling will internally request more + /// documents (specified by this multiplier) in the initial search. This increases + /// the set of results that will be reranked using recomputed similarity scores + /// from full-precision vectors. Minimum value is 1, meaning no oversampling (1x). + /// This parameter can only be set when rerankWithOriginalVectors is true. Higher + /// values improve recall at the expense of latency. + /// + public double? DefaultOversampling { get; set; } + /// Contains the options for rescoring. + public RescoringOptions RescoringOptions { get; set; } + /// + /// The number of dimensions to truncate the vectors to. Truncating the vectors + /// reduces the size of the vectors and the amount of data that needs to be + /// transferred during search. This can save storage cost and improve search + /// performance at the expense of recall. It should be only used for embeddings + /// trained with Matryoshka Representation Learning (MRL) such as OpenAI + /// text-embedding-3-large (small). The default value is null, which means no + /// truncation. + /// + public int? TruncationDimension { get; set; } + /// Type of VectorSearchCompression. + internal VectorSearchCompressionKind Kind { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchCompressionKind.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchCompressionKind.cs new file mode 100644 index 000000000000..5ef54b7c12f4 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchCompressionKind.cs @@ -0,0 +1,61 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The compression method used for indexing and querying. + internal readonly partial struct VectorSearchCompressionKind : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public VectorSearchCompressionKind(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string ScalarQuantizationValue = "scalarQuantization"; + private const string BinaryQuantizationValue = "binaryQuantization"; + + /// + /// Scalar Quantization, a type of compression method. In scalar quantization, the + /// original vectors values are compressed to a narrower type by discretizing and + /// representing each component of a vector using a reduced set of quantized + /// values, thereby reducing the overall data size. + /// + public static VectorSearchCompressionKind ScalarQuantization { get; } = new VectorSearchCompressionKind(ScalarQuantizationValue); + /// + /// Binary Quantization, a type of compression method. In binary quantization, the + /// original vectors values are compressed to the narrower binary type by discretizing + /// and representing each component of a vector using binary values, + /// thereby reducing the overall data size. + /// + public static VectorSearchCompressionKind BinaryQuantization { get; } = new VectorSearchCompressionKind(BinaryQuantizationValue); + /// Determines if two values are the same. + public static bool operator ==(VectorSearchCompressionKind left, VectorSearchCompressionKind right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(VectorSearchCompressionKind left, VectorSearchCompressionKind right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator VectorSearchCompressionKind(string value) => new VectorSearchCompressionKind(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is VectorSearchCompressionKind other && Equals(other); + /// + public bool Equals(VectorSearchCompressionKind other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchCompressionRescoreStorageMethod.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchCompressionRescoreStorageMethod.cs new file mode 100644 index 000000000000..41b317dad6f4 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchCompressionRescoreStorageMethod.cs @@ -0,0 +1,62 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// The storage method for the original full-precision vectors used for rescoring + /// and internal index operations. + /// + public readonly partial struct VectorSearchCompressionRescoreStorageMethod : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public VectorSearchCompressionRescoreStorageMethod(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string PreserveOriginalsValue = "preserveOriginals"; + private const string DiscardOriginalsValue = "discardOriginals"; + + /// + /// This option preserves the original full-precision vectors. Choose this option + /// for maximum flexibility and highest quality of compressed search results. This + /// consumes more storage but allows for rescoring and oversampling. + /// + public static VectorSearchCompressionRescoreStorageMethod PreserveOriginals { get; } = new VectorSearchCompressionRescoreStorageMethod(PreserveOriginalsValue); + /// + /// This option discards the original full-precision vectors. Choose this option + /// for maximum storage savings. Since this option does not allow for rescoring and + /// oversampling, it will often cause slight to moderate reductions in quality. + /// + public static VectorSearchCompressionRescoreStorageMethod DiscardOriginals { get; } = new VectorSearchCompressionRescoreStorageMethod(DiscardOriginalsValue); + /// Determines if two values are the same. + public static bool operator ==(VectorSearchCompressionRescoreStorageMethod left, VectorSearchCompressionRescoreStorageMethod right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(VectorSearchCompressionRescoreStorageMethod left, VectorSearchCompressionRescoreStorageMethod right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator VectorSearchCompressionRescoreStorageMethod(string value) => new VectorSearchCompressionRescoreStorageMethod(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is VectorSearchCompressionRescoreStorageMethod other && Equals(other); + /// + public bool Equals(VectorSearchCompressionRescoreStorageMethod other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchCompressionTarget.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchCompressionTarget.cs new file mode 100644 index 000000000000..70899023437e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchCompressionTarget.cs @@ -0,0 +1,48 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The quantized data type of compressed vector values. + public readonly partial struct VectorSearchCompressionTarget : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public VectorSearchCompressionTarget(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string Int8Value = "int8"; + + /// 8-bit signed integer. + public static VectorSearchCompressionTarget Int8 { get; } = new VectorSearchCompressionTarget(Int8Value); + /// Determines if two values are the same. + public static bool operator ==(VectorSearchCompressionTarget left, VectorSearchCompressionTarget right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(VectorSearchCompressionTarget left, VectorSearchCompressionTarget right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator VectorSearchCompressionTarget(string value) => new VectorSearchCompressionTarget(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is VectorSearchCompressionTarget other && Equals(other); + /// + public bool Equals(VectorSearchCompressionTarget other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchProfile.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchProfile.Serialization.cs new file mode 100644 index 000000000000..b0678c7996dc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchProfile.Serialization.cs @@ -0,0 +1,172 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class VectorSearchProfile : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearchProfile)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + writer.WritePropertyName("algorithm"u8); + writer.WriteStringValue(Algorithm); + if (Optional.IsDefined(Vectorizer)) + { + writer.WritePropertyName("vectorizer"u8); + writer.WriteStringValue(Vectorizer); + } + if (Optional.IsDefined(Compression)) + { + writer.WritePropertyName("compression"u8); + writer.WriteStringValue(Compression); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + VectorSearchProfile IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearchProfile)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorSearchProfile(document.RootElement, options); + } + + internal static VectorSearchProfile DeserializeVectorSearchProfile(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + string algorithm = default; + string vectorizer = default; + string compression = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("algorithm"u8)) + { + algorithm = property.Value.GetString(); + continue; + } + if (property.NameEquals("vectorizer"u8)) + { + vectorizer = property.Value.GetString(); + continue; + } + if (property.NameEquals("compression"u8)) + { + compression = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new VectorSearchProfile(name, algorithm, vectorizer, compression, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorSearchProfile)} does not support writing '{options.Format}' format."); + } + } + + VectorSearchProfile IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorSearchProfile(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorSearchProfile)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static VectorSearchProfile FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorSearchProfile(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchProfile.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchProfile.cs new file mode 100644 index 000000000000..fa8984b3a948 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchProfile.cs @@ -0,0 +1,105 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Defines a combination of configurations to use with vector search. + public partial class VectorSearchProfile + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name to associate with this particular vector search profile. + /// + /// The name of the vector search algorithm configuration that specifies the + /// algorithm and optional parameters. + /// + /// or is null. + public VectorSearchProfile(string name, string algorithm) + { + Argument.AssertNotNull(name, nameof(name)); + Argument.AssertNotNull(algorithm, nameof(algorithm)); + + Name = name; + Algorithm = algorithm; + } + + /// Initializes a new instance of . + /// The name to associate with this particular vector search profile. + /// + /// The name of the vector search algorithm configuration that specifies the + /// algorithm and optional parameters. + /// + /// The name of the vectorization being configured for use with vector search. + /// + /// The name of the compression method configuration that specifies the compression + /// method and optional parameters. + /// + /// Keeps track of any properties unknown to the library. + internal VectorSearchProfile(string name, string algorithm, string vectorizer, string compression, IDictionary serializedAdditionalRawData) + { + Name = name; + Algorithm = algorithm; + Vectorizer = vectorizer; + Compression = compression; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal VectorSearchProfile() + { + } + + /// The name to associate with this particular vector search profile. + public string Name { get; set; } + /// + /// The name of the vector search algorithm configuration that specifies the + /// algorithm and optional parameters. + /// + public string Algorithm { get; set; } + /// The name of the vectorization being configured for use with vector search. + public string Vectorizer { get; set; } + /// + /// The name of the compression method configuration that specifies the compression + /// method and optional parameters. + /// + public string Compression { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchVectorizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchVectorizer.Serialization.cs new file mode 100644 index 000000000000..534b98ede236 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchVectorizer.Serialization.cs @@ -0,0 +1,138 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + [PersistableModelProxy(typeof(UnknownVectorSearchVectorizer))] + public partial class VectorSearchVectorizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearchVectorizer)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + writer.WritePropertyName("kind"u8); + writer.WriteStringValue(Kind.ToString()); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + VectorSearchVectorizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSearchVectorizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorSearchVectorizer(document.RootElement, options); + } + + internal static VectorSearchVectorizer DeserializeVectorSearchVectorizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("kind", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "aiServicesVision": return AIServicesVisionVectorizer.DeserializeAIServicesVisionVectorizer(element, options); + case "aml": return AMLVectorizer.DeserializeAMLVectorizer(element, options); + case "azureOpenAI": return AzureOpenAIVectorizer.DeserializeAzureOpenAIVectorizer(element, options); + case "customWebApi": return WebApiVectorizer.DeserializeWebApiVectorizer(element, options); + } + } + return UnknownVectorSearchVectorizer.DeserializeUnknownVectorSearchVectorizer(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorSearchVectorizer)} does not support writing '{options.Format}' format."); + } + } + + VectorSearchVectorizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorSearchVectorizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorSearchVectorizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static VectorSearchVectorizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorSearchVectorizer(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchVectorizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchVectorizer.cs new file mode 100644 index 000000000000..81d933cbac96 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchVectorizer.cs @@ -0,0 +1,83 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// 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 . + /// + public abstract partial class VectorSearchVectorizer + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The name to associate with this particular vectorization method. + /// is null. + protected VectorSearchVectorizer(string name) + { + Argument.AssertNotNull(name, nameof(name)); + + Name = name; + } + + /// Initializes a new instance of . + /// The name to associate with this particular vectorization method. + /// Type of VectorSearchVectorizer. + /// Keeps track of any properties unknown to the library. + internal VectorSearchVectorizer(string name, VectorSearchVectorizerKind kind, IDictionary serializedAdditionalRawData) + { + Name = name; + Kind = kind; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal VectorSearchVectorizer() + { + } + + /// The name to associate with this particular vectorization method. + public string Name { get; set; } + /// Type of VectorSearchVectorizer. + internal VectorSearchVectorizerKind Kind { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchVectorizerKind.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchVectorizerKind.cs new file mode 100644 index 000000000000..ca1331a13e15 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VectorSearchVectorizerKind.cs @@ -0,0 +1,63 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The vectorization method to be used during query time. + internal readonly partial struct VectorSearchVectorizerKind : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public VectorSearchVectorizerKind(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string AzureOpenAIValue = "azureOpenAI"; + private const string CustomWebApiValue = "customWebApi"; + private const string AIServicesVisionValue = "aiServicesVision"; + private const string AMLValue = "aml"; + + /// 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); + /// + /// Generate embeddings for an image or text input at query time using the Azure AI + /// Services Vision Vectorize API. + /// + public static VectorSearchVectorizerKind AIServicesVision { get; } = new VectorSearchVectorizerKind(AIServicesVisionValue); + /// + /// Generate embeddings using an Azure Machine Learning endpoint deployed via the + /// Azure AI Foundry Model Catalog at query time. + /// + public static VectorSearchVectorizerKind AML { get; } = new VectorSearchVectorizerKind(AMLValue); + /// Determines if two values are the same. + public static bool operator ==(VectorSearchVectorizerKind left, VectorSearchVectorizerKind right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(VectorSearchVectorizerKind left, VectorSearchVectorizerKind right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator VectorSearchVectorizerKind(string value) => new VectorSearchVectorizerKind(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is VectorSearchVectorizerKind other && Equals(other); + /// + public bool Equals(VectorSearchVectorizerKind other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VisionVectorizeSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VisionVectorizeSkill.Serialization.cs new file mode 100644 index 000000000000..8a39157c0077 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VisionVectorizeSkill.Serialization.cs @@ -0,0 +1,182 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class VisionVectorizeSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VisionVectorizeSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("modelVersion"u8); + writer.WriteStringValue(ModelVersion); + } + + VisionVectorizeSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VisionVectorizeSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVisionVectorizeSkill(document.RootElement, options); + } + + internal static VisionVectorizeSkill DeserializeVisionVectorizeSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string modelVersion = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("modelVersion"u8)) + { + modelVersion = property.Value.GetString(); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new VisionVectorizeSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + modelVersion); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VisionVectorizeSkill)} does not support writing '{options.Format}' format."); + } + } + + VisionVectorizeSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVisionVectorizeSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VisionVectorizeSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new VisionVectorizeSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVisionVectorizeSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VisionVectorizeSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VisionVectorizeSkill.cs new file mode 100644 index 000000000000..634b1fb94ea0 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VisionVectorizeSkill.cs @@ -0,0 +1,88 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Allows you to generate a vector embedding for a given image or text input using + /// the Azure AI Services Vision Vectorize API. + /// + public partial class VisionVectorizeSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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 version of the model to use when calling the AI Services Vision service. It + /// will default to the latest available when not specified. + /// + /// , or is null. + public VisionVectorizeSkill(IEnumerable inputs, IEnumerable outputs, string modelVersion) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + Argument.AssertNotNull(modelVersion, nameof(modelVersion)); + + OdataType = "#Microsoft.Skills.Vision.VectorizeSkill"; + ModelVersion = modelVersion; + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// The version of the model to use when calling the AI Services Vision service. It + /// will default to the latest available when not specified. + /// + internal VisionVectorizeSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData, string modelVersion) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + ModelVersion = modelVersion; + } + + /// Initializes a new instance of for deserialization. + internal VisionVectorizeSkill() + { + } + + /// + /// The version of the model to use when calling the AI Services Vision service. It + /// will default to the latest available when not specified. + /// + public string ModelVersion { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VisualFeature.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VisualFeature.cs new file mode 100644 index 000000000000..7fc3497ca460 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/VisualFeature.cs @@ -0,0 +1,66 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Indexes +{ + /// The strings indicating what visual feature types to return. + public readonly partial struct VisualFeature : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public VisualFeature(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string AdultValue = "adult"; + private const string BrandsValue = "brands"; + private const string CategoriesValue = "categories"; + private const string DescriptionValue = "description"; + private const string FacesValue = "faces"; + private const string ObjectsValue = "objects"; + private const string TagsValue = "tags"; + + /// Visual features recognized as adult persons. + public static VisualFeature Adult { get; } = new VisualFeature(AdultValue); + /// Visual features recognized as commercial brands. + public static VisualFeature Brands { get; } = new VisualFeature(BrandsValue); + /// Categories. + public static VisualFeature Categories { get; } = new VisualFeature(CategoriesValue); + /// Description. + public static VisualFeature Description { get; } = new VisualFeature(DescriptionValue); + /// Visual features recognized as people faces. + public static VisualFeature Faces { get; } = new VisualFeature(FacesValue); + /// Visual features recognized as objects. + public static VisualFeature Objects { get; } = new VisualFeature(ObjectsValue); + /// Tags. + public static VisualFeature Tags { get; } = new VisualFeature(TagsValue); + /// Determines if two values are the same. + public static bool operator ==(VisualFeature left, VisualFeature right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(VisualFeature left, VisualFeature right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator VisualFeature(string value) => new VisualFeature(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is VisualFeature other && Equals(other); + /// + public bool Equals(VisualFeature other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiSkill.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiSkill.Serialization.cs new file mode 100644 index 000000000000..eac8f01de5b4 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiSkill.Serialization.cs @@ -0,0 +1,297 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class WebApiSkill : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(WebApiSkill)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("uri"u8); + writer.WriteStringValue(Uri); + if (Optional.IsCollectionDefined(HttpHeaders)) + { + writer.WritePropertyName("httpHeaders"u8); + writer.WriteStartObject(); + foreach (var item in HttpHeaders) + { + writer.WritePropertyName(item.Key); + writer.WriteStringValue(item.Value); + } + writer.WriteEndObject(); + } + if (Optional.IsDefined(HttpMethod)) + { + writer.WritePropertyName("httpMethod"u8); + writer.WriteStringValue(HttpMethod); + } + if (Optional.IsDefined(Timeout)) + { + writer.WritePropertyName("timeout"u8); + writer.WriteStringValue(Timeout.Value, "P"); + } + if (Optional.IsDefined(BatchSize)) + { + writer.WritePropertyName("batchSize"u8); + writer.WriteNumberValue(BatchSize.Value); + } + if (Optional.IsDefined(DegreeOfParallelism)) + { + writer.WritePropertyName("degreeOfParallelism"u8); + writer.WriteNumberValue(DegreeOfParallelism.Value); + } + if (Optional.IsDefined(AuthResourceId)) + { + writer.WritePropertyName("authResourceId"u8); + writer.WriteStringValue(AuthResourceId); + } + if (Optional.IsDefined(AuthIdentity)) + { + writer.WritePropertyName("authIdentity"u8); + writer.WriteObjectValue(AuthIdentity, options); + } + } + + WebApiSkill IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(WebApiSkill)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeWebApiSkill(document.RootElement, options); + } + + internal static WebApiSkill DeserializeWebApiSkill(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string uri = default; + IDictionary httpHeaders = default; + string httpMethod = default; + TimeSpan? timeout = default; + int? batchSize = default; + int? degreeOfParallelism = default; + string authResourceId = default; + SearchIndexerDataIdentity authIdentity = default; + string odataType = default; + string name = default; + string description = default; + string context = default; + IList inputs = default; + IList outputs = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("uri"u8)) + { + uri = property.Value.GetString(); + continue; + } + if (property.NameEquals("httpHeaders"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + Dictionary dictionary = new Dictionary(); + foreach (var property0 in property.Value.EnumerateObject()) + { + dictionary.Add(property0.Name, property0.Value.GetString()); + } + httpHeaders = dictionary; + continue; + } + if (property.NameEquals("httpMethod"u8)) + { + httpMethod = property.Value.GetString(); + continue; + } + if (property.NameEquals("timeout"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + timeout = property.Value.GetTimeSpan("P"); + continue; + } + if (property.NameEquals("batchSize"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + batchSize = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("degreeOfParallelism"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + degreeOfParallelism = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("authResourceId"u8)) + { + authResourceId = property.Value.GetString(); + continue; + } + if (property.NameEquals("authIdentity"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + authIdentity = SearchIndexerDataIdentity.DeserializeSearchIndexerDataIdentity(property.Value, options); + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("description"u8)) + { + description = property.Value.GetString(); + continue; + } + if (property.NameEquals("context"u8)) + { + context = property.Value.GetString(); + continue; + } + if (property.NameEquals("inputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(InputFieldMappingEntry.DeserializeInputFieldMappingEntry(item, options)); + } + inputs = array; + continue; + } + if (property.NameEquals("outputs"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(OutputFieldMappingEntry.DeserializeOutputFieldMappingEntry(item, options)); + } + outputs = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new WebApiSkill( + odataType, + name, + description, + context, + inputs, + outputs, + serializedAdditionalRawData, + uri, + httpHeaders ?? new ChangeTrackingDictionary(), + httpMethod, + timeout, + batchSize, + degreeOfParallelism, + authResourceId, + authIdentity); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(WebApiSkill)} does not support writing '{options.Format}' format."); + } + } + + WebApiSkill IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeWebApiSkill(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(WebApiSkill)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new WebApiSkill FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeWebApiSkill(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiSkill.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiSkill.cs new file mode 100644 index 000000000000..6737dd57a9a9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiSkill.cs @@ -0,0 +1,140 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// A skill that can call a Web API endpoint, allowing you to extend a skillset by + /// having it call your custom code. + /// + public partial class WebApiSkill : SearchIndexerSkill + { + /// Initializes a new instance of . + /// + /// 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 url for the Web API. + /// , or is null. + public WebApiSkill(IEnumerable inputs, IEnumerable outputs, string uri) : base(inputs, outputs) + { + Argument.AssertNotNull(inputs, nameof(inputs)); + Argument.AssertNotNull(outputs, nameof(outputs)); + Argument.AssertNotNull(uri, nameof(uri)); + + OdataType = "#Microsoft.Skills.Custom.WebApiSkill"; + Uri = uri; + HttpHeaders = new ChangeTrackingDictionary(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// The url for the Web API. + /// The headers required to make the http request. + /// The method for the http request. + /// The desired timeout for the request. Default is 30 seconds. + /// The desired batch size which indicates number of documents. + /// If set, the number of parallel calls that can be made to the Web API. + /// + /// Applies to custom skills 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 custom skill 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. + /// + /// + /// The user-assigned managed identity used for outbound connections. If an + /// authResourceId is provided and it's not specified, the system-assigned managed + /// identity is used. On updates to the indexer, if the identity is unspecified, + /// the value remains unchanged. If set to "none", the value of this property is + /// cleared. + /// 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 . + /// + internal WebApiSkill(string odataType, string name, string description, string context, IList inputs, IList outputs, IDictionary serializedAdditionalRawData, string uri, IDictionary httpHeaders, string httpMethod, TimeSpan? timeout, int? batchSize, int? degreeOfParallelism, string authResourceId, SearchIndexerDataIdentity authIdentity) : base(odataType, name, description, context, inputs, outputs, serializedAdditionalRawData) + { + Uri = uri; + HttpHeaders = httpHeaders; + HttpMethod = httpMethod; + Timeout = timeout; + BatchSize = batchSize; + DegreeOfParallelism = degreeOfParallelism; + AuthResourceId = authResourceId; + AuthIdentity = authIdentity; + } + + /// Initializes a new instance of for deserialization. + internal WebApiSkill() + { + } + + /// The url for the Web API. + public string Uri { get; set; } + /// The headers required to make the http request. + public IDictionary HttpHeaders { get; } + /// 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; } + /// The desired batch size which indicates number of documents. + public int? BatchSize { get; set; } + /// If set, the number of parallel calls that can be made to the Web API. + public int? DegreeOfParallelism { get; set; } + /// + /// Applies to custom skills 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 custom skill 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. + /// + public string AuthResourceId { get; set; } + /// + /// The user-assigned managed identity used for outbound connections. If an + /// authResourceId is provided and it's not specified, the system-assigned managed + /// identity is used. On updates to the indexer, if the identity is unspecified, + /// the value remains unchanged. If set to "none", the value of this property is + /// cleared. + /// 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 SearchIndexerDataIdentity AuthIdentity { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiVectorizer.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiVectorizer.Serialization.cs new file mode 100644 index 000000000000..82e7ef8570c1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiVectorizer.Serialization.cs @@ -0,0 +1,147 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class WebApiVectorizer : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(WebApiVectorizer)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(CustomWebApiParameters)) + { + writer.WritePropertyName("customWebApiParameters"u8); + writer.WriteObjectValue(CustomWebApiParameters, options); + } + } + + WebApiVectorizer IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(WebApiVectorizer)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeWebApiVectorizer(document.RootElement, options); + } + + internal static WebApiVectorizer DeserializeWebApiVectorizer(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + WebApiVectorizerParameters customWebApiParameters = default; + string name = default; + VectorSearchVectorizerKind kind = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("customWebApiParameters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + customWebApiParameters = WebApiVectorizerParameters.DeserializeWebApiVectorizerParameters(property.Value, options); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorSearchVectorizerKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new WebApiVectorizer(name, kind, serializedAdditionalRawData, customWebApiParameters); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(WebApiVectorizer)} does not support writing '{options.Format}' format."); + } + } + + WebApiVectorizer IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeWebApiVectorizer(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(WebApiVectorizer)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new WebApiVectorizer FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeWebApiVectorizer(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiVectorizer.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiVectorizer.cs new file mode 100644 index 000000000000..78d920daaf32 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiVectorizer.cs @@ -0,0 +1,48 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// 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 WebApiVectorizer : VectorSearchVectorizer + { + /// Initializes a new instance of . + /// The name to associate with this particular vectorization method. + /// is null. + public WebApiVectorizer(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + Kind = VectorSearchVectorizerKind.CustomWebApi; + } + + /// Initializes a new instance of . + /// The name to associate with this particular vectorization method. + /// Type of VectorSearchVectorizer. + /// Keeps track of any properties unknown to the library. + /// Specifies the properties of the user-defined vectorizer. + internal WebApiVectorizer(string name, VectorSearchVectorizerKind kind, IDictionary serializedAdditionalRawData, WebApiVectorizerParameters customWebApiParameters) : base(name, kind, serializedAdditionalRawData) + { + CustomWebApiParameters = customWebApiParameters; + } + + /// Initializes a new instance of for deserialization. + internal WebApiVectorizer() + { + } + + /// Specifies the properties of the user-defined vectorizer. + public WebApiVectorizerParameters CustomWebApiParameters { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiVectorizerParameters.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiVectorizerParameters.Serialization.cs new file mode 100644 index 000000000000..58f6248114dd --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiVectorizerParameters.Serialization.cs @@ -0,0 +1,234 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class WebApiVectorizerParameters : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(WebApiVectorizerParameters)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(Uri)) + { + writer.WritePropertyName("uri"u8); + writer.WriteStringValue(Uri.AbsoluteUri); + } + if (Optional.IsCollectionDefined(HttpHeaders)) + { + writer.WritePropertyName("httpHeaders"u8); + writer.WriteStartObject(); + foreach (var item in HttpHeaders) + { + writer.WritePropertyName(item.Key); + writer.WriteStringValue(item.Value); + } + writer.WriteEndObject(); + } + if (Optional.IsDefined(HttpMethod)) + { + writer.WritePropertyName("httpMethod"u8); + writer.WriteStringValue(HttpMethod); + } + if (Optional.IsDefined(Timeout)) + { + writer.WritePropertyName("timeout"u8); + writer.WriteStringValue(Timeout.Value, "P"); + } + if (Optional.IsDefined(AuthResourceId)) + { + writer.WritePropertyName("authResourceId"u8); + writer.WriteStringValue(AuthResourceId); + } + if (Optional.IsDefined(AuthIdentity)) + { + writer.WritePropertyName("authIdentity"u8); + writer.WriteObjectValue(AuthIdentity, options); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + WebApiVectorizerParameters IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(WebApiVectorizerParameters)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeWebApiVectorizerParameters(document.RootElement, options); + } + + internal static WebApiVectorizerParameters DeserializeWebApiVectorizerParameters(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + Uri uri = default; + IDictionary httpHeaders = default; + string httpMethod = default; + TimeSpan? timeout = default; + string authResourceId = default; + SearchIndexerDataIdentity authIdentity = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("uri"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + uri = new Uri(property.Value.GetString()); + continue; + } + if (property.NameEquals("httpHeaders"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + Dictionary dictionary = new Dictionary(); + foreach (var property0 in property.Value.EnumerateObject()) + { + dictionary.Add(property0.Name, property0.Value.GetString()); + } + httpHeaders = dictionary; + continue; + } + if (property.NameEquals("httpMethod"u8)) + { + httpMethod = property.Value.GetString(); + continue; + } + if (property.NameEquals("timeout"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + timeout = property.Value.GetTimeSpan("P"); + continue; + } + if (property.NameEquals("authResourceId"u8)) + { + authResourceId = property.Value.GetString(); + continue; + } + if (property.NameEquals("authIdentity"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + authIdentity = SearchIndexerDataIdentity.DeserializeSearchIndexerDataIdentity(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new WebApiVectorizerParameters( + uri, + httpHeaders ?? new ChangeTrackingDictionary(), + httpMethod, + timeout, + authResourceId, + authIdentity, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(WebApiVectorizerParameters)} does not support writing '{options.Format}' format."); + } + } + + WebApiVectorizerParameters IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeWebApiVectorizerParameters(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(WebApiVectorizerParameters)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static WebApiVectorizerParameters FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeWebApiVectorizerParameters(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiVectorizerParameters.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiVectorizerParameters.cs new file mode 100644 index 000000000000..8e1baad6f184 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WebApiVectorizerParameters.cs @@ -0,0 +1,118 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// Specifies the properties for connecting to a user-defined vectorizer. + public partial class WebApiVectorizerParameters + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public WebApiVectorizerParameters() + { + HttpHeaders = new ChangeTrackingDictionary(); + } + + /// Initializes a new instance of . + /// 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. + /// + /// + /// The user-assigned managed identity used for outbound connections. If an + /// authResourceId is provided and it's not specified, the system-assigned managed + /// identity is used. On updates to the indexer, if the identity is unspecified, + /// the value remains unchanged. If set to "none", the value of this property is + /// cleared. + /// 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 . + /// + /// Keeps track of any properties unknown to the library. + internal WebApiVectorizerParameters(Uri uri, IDictionary httpHeaders, string httpMethod, TimeSpan? timeout, string authResourceId, SearchIndexerDataIdentity authIdentity, IDictionary serializedAdditionalRawData) + { + Uri = uri; + HttpHeaders = httpHeaders; + HttpMethod = httpMethod; + Timeout = timeout; + AuthResourceId = authResourceId; + AuthIdentity = authIdentity; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The URI of the Web API providing the vectorizer. + public Uri Uri { get; set; } + /// The headers required to make the HTTP request. + public IDictionary HttpHeaders { get; } + /// 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; } + /// + /// 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. + /// + public string AuthResourceId { get; set; } + /// + /// The user-assigned managed identity used for outbound connections. If an + /// authResourceId is provided and it's not specified, the system-assigned managed + /// identity is used. On updates to the indexer, if the identity is unspecified, + /// the value remains unchanged. If set to "none", the value of this property is + /// cleared. + /// 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 SearchIndexerDataIdentity AuthIdentity { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WordDelimiterTokenFilter.Serialization.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WordDelimiterTokenFilter.Serialization.cs new file mode 100644 index 000000000000..dd747b671613 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WordDelimiterTokenFilter.Serialization.cs @@ -0,0 +1,305 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Indexes +{ + public partial class WordDelimiterTokenFilter : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(WordDelimiterTokenFilter)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(GenerateWordParts)) + { + writer.WritePropertyName("generateWordParts"u8); + writer.WriteBooleanValue(GenerateWordParts.Value); + } + if (Optional.IsDefined(GenerateNumberParts)) + { + writer.WritePropertyName("generateNumberParts"u8); + writer.WriteBooleanValue(GenerateNumberParts.Value); + } + if (Optional.IsDefined(CatenateWords)) + { + writer.WritePropertyName("catenateWords"u8); + writer.WriteBooleanValue(CatenateWords.Value); + } + if (Optional.IsDefined(CatenateNumbers)) + { + writer.WritePropertyName("catenateNumbers"u8); + writer.WriteBooleanValue(CatenateNumbers.Value); + } + if (Optional.IsDefined(CatenateAll)) + { + writer.WritePropertyName("catenateAll"u8); + writer.WriteBooleanValue(CatenateAll.Value); + } + if (Optional.IsDefined(SplitOnCaseChange)) + { + writer.WritePropertyName("splitOnCaseChange"u8); + writer.WriteBooleanValue(SplitOnCaseChange.Value); + } + if (Optional.IsDefined(PreserveOriginal)) + { + writer.WritePropertyName("preserveOriginal"u8); + writer.WriteBooleanValue(PreserveOriginal.Value); + } + if (Optional.IsDefined(SplitOnNumerics)) + { + writer.WritePropertyName("splitOnNumerics"u8); + writer.WriteBooleanValue(SplitOnNumerics.Value); + } + if (Optional.IsDefined(StemEnglishPossessive)) + { + writer.WritePropertyName("stemEnglishPossessive"u8); + writer.WriteBooleanValue(StemEnglishPossessive.Value); + } + if (Optional.IsCollectionDefined(ProtectedWords)) + { + writer.WritePropertyName("protectedWords"u8); + writer.WriteStartArray(); + foreach (var item in ProtectedWords) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + } + + WordDelimiterTokenFilter IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(WordDelimiterTokenFilter)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeWordDelimiterTokenFilter(document.RootElement, options); + } + + internal static WordDelimiterTokenFilter DeserializeWordDelimiterTokenFilter(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + bool? generateWordParts = default; + bool? generateNumberParts = default; + bool? catenateWords = default; + bool? catenateNumbers = default; + bool? catenateAll = default; + bool? splitOnCaseChange = default; + bool? preserveOriginal = default; + bool? splitOnNumerics = default; + bool? stemEnglishPossessive = default; + IList protectedWords = default; + string odataType = default; + string name = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("generateWordParts"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + generateWordParts = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("generateNumberParts"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + generateNumberParts = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("catenateWords"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + catenateWords = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("catenateNumbers"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + catenateNumbers = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("catenateAll"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + catenateAll = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("splitOnCaseChange"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + splitOnCaseChange = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("preserveOriginal"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + preserveOriginal = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("splitOnNumerics"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + splitOnNumerics = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("stemEnglishPossessive"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + stemEnglishPossessive = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("protectedWords"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + protectedWords = array; + continue; + } + if (property.NameEquals("@odata.type"u8)) + { + odataType = property.Value.GetString(); + continue; + } + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new WordDelimiterTokenFilter( + odataType, + name, + serializedAdditionalRawData, + generateWordParts, + generateNumberParts, + catenateWords, + catenateNumbers, + catenateAll, + splitOnCaseChange, + preserveOriginal, + splitOnNumerics, + stemEnglishPossessive, + protectedWords ?? new ChangeTrackingList()); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(WordDelimiterTokenFilter)} does not support writing '{options.Format}' format."); + } + } + + WordDelimiterTokenFilter IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeWordDelimiterTokenFilter(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(WordDelimiterTokenFilter)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new WordDelimiterTokenFilter FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeWordDelimiterTokenFilter(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WordDelimiterTokenFilter.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WordDelimiterTokenFilter.cs new file mode 100644 index 000000000000..16208a88e781 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Generated/WordDelimiterTokenFilter.cs @@ -0,0 +1,144 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Indexes +{ + /// + /// Splits words into subwords and performs optional transformations on subword + /// groups. This token filter is implemented using Apache Lucene. + /// + public partial class WordDelimiterTokenFilter : TokenFilter + { + /// Initializes a new instance of . + /// + /// 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. + /// + /// is null. + public WordDelimiterTokenFilter(string name) : base(name) + { + Argument.AssertNotNull(name, nameof(name)); + + OdataType = "#Microsoft.Azure.Search.WordDelimiterTokenFilter"; + ProtectedWords = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// The discriminator for derived types. + /// + /// 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. + /// + /// Keeps track of any properties unknown to the library. + /// + /// 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. + /// + /// A value indicating whether maximum runs of word parts will be catenated. For + /// example, if this is set to true, "Azure-Search" becomes "AzureSearch". Default + /// is false. + /// + /// + /// A value indicating whether maximum runs of number parts will be catenated. For + /// example, if this is set to true, "1-2" becomes "12". Default is false. + /// + /// + /// A value indicating whether all subword parts will be catenated. For example, if + /// this is set to true, "Azure-Search-1" becomes "AzureSearch1". Default is false. + /// + /// + /// A value indicating whether to split words on caseChange. For example, if this + /// is set to true, "AzureSearch" becomes "Azure" "Search". Default is true. + /// + /// + /// A value indicating whether original words will be preserved and added to the + /// subword list. Default is false. + /// + /// + /// A value indicating whether to split on numbers. For example, if this is set to + /// true, "Azure1Search" becomes "Azure" "1" "Search". Default is true. + /// + /// + /// A value indicating whether to remove trailing "'s" for each subword. Default is + /// true. + /// + /// A list of tokens to protect from being delimited. + internal WordDelimiterTokenFilter(string odataType, string name, IDictionary serializedAdditionalRawData, bool? generateWordParts, bool? generateNumberParts, bool? catenateWords, bool? catenateNumbers, bool? catenateAll, bool? splitOnCaseChange, bool? preserveOriginal, bool? splitOnNumerics, bool? stemEnglishPossessive, IList protectedWords) : base(odataType, name, serializedAdditionalRawData) + { + GenerateWordParts = generateWordParts; + GenerateNumberParts = generateNumberParts; + CatenateWords = catenateWords; + CatenateNumbers = catenateNumbers; + CatenateAll = catenateAll; + SplitOnCaseChange = splitOnCaseChange; + PreserveOriginal = preserveOriginal; + SplitOnNumerics = splitOnNumerics; + StemEnglishPossessive = stemEnglishPossessive; + ProtectedWords = protectedWords; + } + + /// Initializes a new instance of for deserialization. + internal WordDelimiterTokenFilter() + { + } + + /// + /// 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. + /// + public bool? GenerateWordParts { get; set; } + /// A value indicating whether to generate number subwords. Default is true. + public bool? GenerateNumberParts { get; set; } + /// + /// A value indicating whether maximum runs of word parts will be catenated. For + /// example, if this is set to true, "Azure-Search" becomes "AzureSearch". Default + /// is false. + /// + public bool? CatenateWords { get; set; } + /// + /// A value indicating whether maximum runs of number parts will be catenated. For + /// example, if this is set to true, "1-2" becomes "12". Default is false. + /// + public bool? CatenateNumbers { get; set; } + /// + /// A value indicating whether all subword parts will be catenated. For example, if + /// this is set to true, "Azure-Search-1" becomes "AzureSearch1". Default is false. + /// + public bool? CatenateAll { get; set; } + /// + /// A value indicating whether to split words on caseChange. For example, if this + /// is set to true, "AzureSearch" becomes "Azure" "Search". Default is true. + /// + public bool? SplitOnCaseChange { get; set; } + /// + /// A value indicating whether original words will be preserved and added to the + /// subword list. Default is false. + /// + public bool? PreserveOriginal { get; set; } + /// + /// A value indicating whether to split on numbers. For example, if this is set to + /// true, "Azure1Search" becomes "Azure" "1" "Search". Default is true. + /// + public bool? SplitOnNumerics { get; set; } + /// + /// A value indicating whether to remove trailing "'s" for each subword. Default is + /// true. + /// + public bool? StemEnglishPossessive { get; set; } + /// A list of tokens to protect from being delimited. + public IList ProtectedWords { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/src/Properties/AssemblyInfo.cs b/sdk/search/Azure.Search.Documents.Indexes/src/Properties/AssemblyInfo.cs new file mode 100644 index 000000000000..e75b229b6c18 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/src/Properties/AssemblyInfo.cs @@ -0,0 +1,11 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System.Runtime.CompilerServices; + +[assembly: InternalsVisibleTo("Azure.Search.Documents.Indexes.Tests, PublicKey = 0024000004800000940000000602000000240000525341310004000001000100d15ddcb29688295338af4b7686603fe614abd555e09efba8fb88ee09e1f7b1ccaeed2e8f823fa9eef3fdd60217fc012ea67d2479751a0b8c087a4185541b851bd8b16f8d91b840e51b1cb0ba6fe647997e57429265e85ef62d565db50a69ae1647d54d7bd855e4db3d8a91510e5bcbd0edfbbecaa20a7bd9ae74593daa7b11b4")] + +// Replace Microsoft.Test with the correct resource provider namepace for your service and uncomment. +// See https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-services-resource-providers +// for the list of possible values. +[assembly: Azure.Core.AzureResourceProviderNamespace("Microsoft.Template")] diff --git a/sdk/search/Azure.Search.Documents.Indexes/tests/Azure.Search.Documents.Indexes.Tests.csproj b/sdk/search/Azure.Search.Documents.Indexes/tests/Azure.Search.Documents.Indexes.Tests.csproj new file mode 100644 index 000000000000..0d7e156dbbbe --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/tests/Azure.Search.Documents.Indexes.Tests.csproj @@ -0,0 +1,20 @@ + + + $(RequiredTargetFrameworks) + + $(NoWarn);CS1591 + + + + + + + + + + + + + + + diff --git a/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_Aliases.cs b/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_Aliases.cs new file mode 100644 index 000000000000..83837d435040 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_Aliases.cs @@ -0,0 +1,312 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Text.Json; +using System.Threading.Tasks; +using Azure.Core; +using Azure.Identity; +using NUnit.Framework; + +namespace Azure.Search.Documents.Indexes.Samples +{ + public partial class Samples_Aliases + { + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Aliases_Create_SearchServiceCreateAlias() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "tempalias", + ["indexes"] = new object[] + { +"preview-test" + }, + ["@odata.etag"] = "0x1234568AE7E58A1" + }); + Response response = client.Create(content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("indexes")[0].ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Aliases_Create_SearchServiceCreateAlias_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "tempalias", + ["indexes"] = new object[] + { +"preview-test" + }, + ["@odata.etag"] = "0x1234568AE7E58A1" + }); + Response response = await client.CreateAsync(content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("indexes")[0].ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Aliases_Create_SearchServiceCreateAlias_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + SearchAlias @alias = new SearchAlias("tempalias", new string[] { "preview-test" }) + { + ETag = "0x1234568AE7E58A1", + }; + Response response = client.Create(@alias); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Aliases_Create_SearchServiceCreateAlias_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + SearchAlias @alias = new SearchAlias("tempalias", new string[] { "preview-test" }) + { + ETag = "0x1234568AE7E58A1", + }; + Response response = await client.CreateAsync(@alias); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Aliases_CreateOrUpdate_SearchServiceCreateOrUpdateAlias() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "myalias", + ["indexes"] = new object[] + { +"preview-test" + }, + ["@odata.etag"] = "0x1234568AE7E58A1" + }); + Response response = client.CreateOrUpdate("myalias", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("indexes")[0].ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Aliases_CreateOrUpdate_SearchServiceCreateOrUpdateAlias_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "myalias", + ["indexes"] = new object[] + { +"preview-test" + }, + ["@odata.etag"] = "0x1234568AE7E58A1" + }); + Response response = await client.CreateOrUpdateAsync("myalias", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("indexes")[0].ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Aliases_CreateOrUpdate_SearchServiceCreateOrUpdateAlias_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + SearchAlias @alias = new SearchAlias("myalias", new string[] { "preview-test" }) + { + ETag = "0x1234568AE7E58A1", + }; + Response response = client.CreateOrUpdate("myalias", @alias); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Aliases_CreateOrUpdate_SearchServiceCreateOrUpdateAlias_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + SearchAlias @alias = new SearchAlias("myalias", new string[] { "preview-test" }) + { + ETag = "0x1234568AE7E58A1", + }; + Response response = await client.CreateOrUpdateAsync("myalias", @alias); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Aliases_Delete_SearchServiceDeleteAlias() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + Response response = client.Delete("tempalias"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Aliases_Delete_SearchServiceDeleteAlias_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + Response response = await client.DeleteAsync("tempalias"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Aliases_GetAlias_SearchServiceGetAlias() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + Response response = client.GetAlias("myalias", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("indexes")[0].ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Aliases_GetAlias_SearchServiceGetAlias_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + Response response = await client.GetAliasAsync("myalias", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("indexes")[0].ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Aliases_GetAlias_SearchServiceGetAlias_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + Response response = client.GetAlias("myalias"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Aliases_GetAlias_SearchServiceGetAlias_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + Response response = await client.GetAliasAsync("myalias"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Aliases_GetAliases_SearchServiceListAliases() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + foreach (BinaryData item in client.GetAliases(null)) + { + JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("indexes")[0].ToString()); + } + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Aliases_GetAliases_SearchServiceListAliases_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + await foreach (BinaryData item in client.GetAliasesAsync(null)) + { + JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("indexes")[0].ToString()); + } + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Aliases_GetAliases_SearchServiceListAliases_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + foreach (SearchAlias item in client.GetAliases()) + { + } + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Aliases_GetAliases_SearchServiceListAliases_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Aliases client = new SearchClient(endpoint, credential).GetAliasesClient(); + + await foreach (SearchAlias item in client.GetAliasesAsync()) + { + } + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_DataSources.cs b/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_DataSources.cs new file mode 100644 index 000000000000..b693b8377da8 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_DataSources.cs @@ -0,0 +1,542 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Text.Json; +using System.Threading.Tasks; +using Azure.Core; +using Azure.Identity; +using NUnit.Framework; + +namespace Azure.Search.Documents.Indexes.Samples +{ + public partial class Samples_DataSources + { + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_DataSources_CreateOrUpdate_SearchServiceCreateOrUpdateDataSource() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "tempdatasource", + ["description"] = "My Azure Blob data source.", + ["type"] = "azureblob", + ["credentials"] = new + { + connectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + }, + ["container"] = new + { + name = "doc-extraction-skillset", + query = "E2E_Dsat", + }, + ["identity"] = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + ["dataChangeDetectionPolicy"] = new Dictionary + { + ["highWaterMarkColumnName"] = "metadata_storage_last_modified", + ["@odata.type"] = "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy" + }, + ["dataDeletionDetectionPolicy"] = new Dictionary + { + ["softDeleteColumnName"] = "isDeleted", + ["softDeleteMarkerValue"] = "true", + ["@odata.type"] = "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } + }); + Response response = client.CreateOrUpdate("tempdatasource", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); + Console.WriteLine(result.GetProperty("credentials").ToString()); + Console.WriteLine(result.GetProperty("container").GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_DataSources_CreateOrUpdate_SearchServiceCreateOrUpdateDataSource_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "tempdatasource", + ["description"] = "My Azure Blob data source.", + ["type"] = "azureblob", + ["credentials"] = new + { + connectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + }, + ["container"] = new + { + name = "doc-extraction-skillset", + query = "E2E_Dsat", + }, + ["identity"] = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + ["dataChangeDetectionPolicy"] = new Dictionary + { + ["highWaterMarkColumnName"] = "metadata_storage_last_modified", + ["@odata.type"] = "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy" + }, + ["dataDeletionDetectionPolicy"] = new Dictionary + { + ["softDeleteColumnName"] = "isDeleted", + ["softDeleteMarkerValue"] = "true", + ["@odata.type"] = "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } + }); + Response response = await client.CreateOrUpdateAsync("tempdatasource", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); + Console.WriteLine(result.GetProperty("credentials").ToString()); + Console.WriteLine(result.GetProperty("container").GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_DataSources_CreateOrUpdate_SearchServiceCreateOrUpdateDataSource_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + SearchIndexerDataSource dataSource = new SearchIndexerDataSource("tempdatasource", SearchIndexerDataSourceType.AzureBlob, new DataSourceCredentials + { + ConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + }, new SearchIndexerDataContainer("doc-extraction-skillset") + { + Query = "E2E_Dsat", + }) + { + Description = "My Azure Blob data source.", + Identity = new SearchIndexerDataNoneIdentity(), + DataChangeDetectionPolicy = new HighWaterMarkChangeDetectionPolicy("metadata_storage_last_modified"), + DataDeletionDetectionPolicy = new SoftDeleteColumnDeletionDetectionPolicy + { + SoftDeleteColumnName = "isDeleted", + SoftDeleteMarkerValue = "true", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + }; + Response response = client.CreateOrUpdate("tempdatasource", dataSource); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_DataSources_CreateOrUpdate_SearchServiceCreateOrUpdateDataSource_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + SearchIndexerDataSource dataSource = new SearchIndexerDataSource("tempdatasource", SearchIndexerDataSourceType.AzureBlob, new DataSourceCredentials + { + ConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + }, new SearchIndexerDataContainer("doc-extraction-skillset") + { + Query = "E2E_Dsat", + }) + { + Description = "My Azure Blob data source.", + Identity = new SearchIndexerDataNoneIdentity(), + DataChangeDetectionPolicy = new HighWaterMarkChangeDetectionPolicy("metadata_storage_last_modified"), + DataDeletionDetectionPolicy = new SoftDeleteColumnDeletionDetectionPolicy + { + SoftDeleteColumnName = "isDeleted", + SoftDeleteMarkerValue = "true", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + }; + Response response = await client.CreateOrUpdateAsync("tempdatasource", dataSource); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_DataSources_Delete_SearchServiceDeleteDataSource() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + Response response = client.Delete("tempdatasource"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_DataSources_Delete_SearchServiceDeleteDataSource_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + Response response = await client.DeleteAsync("tempdatasource"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_DataSources_GetDataSource_SearchServiceGetDataSource() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + Response response = client.GetDataSource("mydocdbdatasource", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); + Console.WriteLine(result.GetProperty("credentials").ToString()); + Console.WriteLine(result.GetProperty("container").GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_DataSources_GetDataSource_SearchServiceGetDataSource_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + Response response = await client.GetDataSourceAsync("mydocdbdatasource", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); + Console.WriteLine(result.GetProperty("credentials").ToString()); + Console.WriteLine(result.GetProperty("container").GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_DataSources_GetDataSource_SearchServiceGetDataSource_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + Response response = client.GetDataSource("mydocdbdatasource"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_DataSources_GetDataSource_SearchServiceGetDataSource_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + Response response = await client.GetDataSourceAsync("mydocdbdatasource"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_DataSources_GetDataSources_SearchServiceListDataSources() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + Response response = client.GetDataSources(null, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("type").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("credentials").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("container").GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_DataSources_GetDataSources_SearchServiceListDataSources_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + Response response = await client.GetDataSourcesAsync(null, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("type").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("credentials").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("container").GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_DataSources_GetDataSources_SearchServiceListDataSources_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + Response response = client.GetDataSources(); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_DataSources_GetDataSources_SearchServiceListDataSources_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + Response response = await client.GetDataSourcesAsync(); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_DataSources_Create_SearchServiceCreateDataSource() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "tempdatasource", + ["description"] = "My Azure Blob data source.", + ["type"] = "azureblob", + ["credentials"] = new + { + connectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + }, + ["container"] = new + { + name = "doc-extraction-skillset", + query = "E2E_Dsat", + }, + ["identity"] = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + ["dataChangeDetectionPolicy"] = new Dictionary + { + ["highWaterMarkColumnName"] = "metadata_storage_last_modified", + ["@odata.type"] = "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy" + }, + ["dataDeletionDetectionPolicy"] = new Dictionary + { + ["softDeleteColumnName"] = "isDeleted", + ["softDeleteMarkerValue"] = "true", + ["@odata.type"] = "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } + }); + Response response = client.Create(content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); + Console.WriteLine(result.GetProperty("credentials").ToString()); + Console.WriteLine(result.GetProperty("container").GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_DataSources_Create_SearchServiceCreateDataSource_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "tempdatasource", + ["description"] = "My Azure Blob data source.", + ["type"] = "azureblob", + ["credentials"] = new + { + connectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + }, + ["container"] = new + { + name = "doc-extraction-skillset", + query = "E2E_Dsat", + }, + ["identity"] = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + ["dataChangeDetectionPolicy"] = new Dictionary + { + ["highWaterMarkColumnName"] = "metadata_storage_last_modified", + ["@odata.type"] = "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy" + }, + ["dataDeletionDetectionPolicy"] = new Dictionary + { + ["softDeleteColumnName"] = "isDeleted", + ["softDeleteMarkerValue"] = "true", + ["@odata.type"] = "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } + }); + Response response = await client.CreateAsync(content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("type").ToString()); + Console.WriteLine(result.GetProperty("credentials").ToString()); + Console.WriteLine(result.GetProperty("container").GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_DataSources_Create_SearchServiceCreateDataSource_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + SearchIndexerDataSource dataSource = new SearchIndexerDataSource("tempdatasource", SearchIndexerDataSourceType.AzureBlob, new DataSourceCredentials + { + ConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + }, new SearchIndexerDataContainer("doc-extraction-skillset") + { + Query = "E2E_Dsat", + }) + { + Description = "My Azure Blob data source.", + Identity = new SearchIndexerDataNoneIdentity(), + DataChangeDetectionPolicy = new HighWaterMarkChangeDetectionPolicy("metadata_storage_last_modified"), + DataDeletionDetectionPolicy = new SoftDeleteColumnDeletionDetectionPolicy + { + SoftDeleteColumnName = "isDeleted", + SoftDeleteMarkerValue = "true", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + }; + Response response = client.Create(dataSource); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_DataSources_Create_SearchServiceCreateDataSource_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + DataSources client = new SearchClient(endpoint, credential).GetDataSourcesClient(); + + SearchIndexerDataSource dataSource = new SearchIndexerDataSource("tempdatasource", SearchIndexerDataSourceType.AzureBlob, new DataSourceCredentials + { + ConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + }, new SearchIndexerDataContainer("doc-extraction-skillset") + { + Query = "E2E_Dsat", + }) + { + Description = "My Azure Blob data source.", + Identity = new SearchIndexerDataNoneIdentity(), + DataChangeDetectionPolicy = new HighWaterMarkChangeDetectionPolicy("metadata_storage_last_modified"), + DataDeletionDetectionPolicy = new SoftDeleteColumnDeletionDetectionPolicy + { + SoftDeleteColumnName = "isDeleted", + SoftDeleteMarkerValue = "true", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + }; + Response response = await client.CreateAsync(dataSource); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_Indexers.cs b/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_Indexers.cs new file mode 100644 index 000000000000..603403335b6b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_Indexers.cs @@ -0,0 +1,999 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Text.Json; +using System.Threading.Tasks; +using System.Xml; +using Azure.Core; +using Azure.Identity; +using NUnit.Framework; + +namespace Azure.Search.Documents.Indexes.Samples +{ + public partial class Samples_Indexers + { + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexers_Reset_SearchServiceResetIndexer() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = client.Reset("myindexer"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexers_Reset_SearchServiceResetIndexer_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = await client.ResetAsync("myindexer"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexers_ResetDocs_SearchServiceResetDocs() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + using RequestContent content = RequestContent.Create(new + { + documentKeys = new object[] + { +"1", +"2", +"3" + }, + }); + Response response = client.ResetDocs("myindexer", content); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexers_ResetDocs_SearchServiceResetDocs_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + using RequestContent content = RequestContent.Create(new + { + documentKeys = new object[] + { +"1", +"2", +"3" + }, + }); + Response response = await client.ResetDocsAsync("myindexer", content); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexers_ResetDocs_SearchServiceResetDocs_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = client.ResetDocs("myindexer"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexers_ResetDocs_SearchServiceResetDocs_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = await client.ResetDocsAsync("myindexer"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexers_Run_SearchServiceRunIndexer() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = client.Run("myindexer"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexers_Run_SearchServiceRunIndexer_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = await client.RunAsync("myindexer"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexers_CreateOrUpdate_SearchServiceCreateOrUpdateIndexer() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "myindexer", + ["description"] = "Description of the indexer", + ["dataSourceName"] = "mydocdbdatasource", + ["skillsetName"] = "myskillset", + ["targetIndexName"] = "preview-test", + ["schedule"] = new + { + interval = "P1D", + startTime = "2025-01-07T19:30:00Z", + }, + ["parameters"] = new + { + batchSize = 10, + maxFailedItems = 10, + maxFailedItemsPerBatch = 5, + configuration = new + { + parsingMode = "markdown", + excludedFileNameExtensions = ".png,.mp4", + indexedFileNameExtensions = ".docx,.pptx", + failOnUnsupportedContentType = true, + failOnUnprocessableDocument = false, + indexStorageMetadataOnlyForOversizedDocuments = true, + delimitedTextHeaders = "Header1,Header2", + delimitedTextDelimiter = "|", + firstLineContainsHeaders = true, + markdownParsingSubmode = "oneToOne", + markdownHeaderDepth = "h6", + documentRoot = "/root", + dataToExtract = "storageMetadata", + imageAction = "none", + allowSkillsetToReadFileData = false, + pdfTextRotationAlgorithm = "none", + executionEnvironment = "standard", + }, + }, + ["fieldMappings"] = new object[] + { +new +{ +sourceFieldName = "/document", +targetFieldName = "name", +mappingFunction = new +{ +name = "base64Encode", +}, +} + }, + ["outputFieldMappings"] = new object[] + { +new +{ +sourceFieldName = "/document", +targetFieldName = "name", +mappingFunction = new +{ +name = "base64Encode", +}, +} + }, + ["disabled"] = false, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } + }); + Response response = client.CreateOrUpdate("myindexer", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("dataSourceName").ToString()); + Console.WriteLine(result.GetProperty("targetIndexName").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexers_CreateOrUpdate_SearchServiceCreateOrUpdateIndexer_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "myindexer", + ["description"] = "Description of the indexer", + ["dataSourceName"] = "mydocdbdatasource", + ["skillsetName"] = "myskillset", + ["targetIndexName"] = "preview-test", + ["schedule"] = new + { + interval = "P1D", + startTime = "2025-01-07T19:30:00Z", + }, + ["parameters"] = new + { + batchSize = 10, + maxFailedItems = 10, + maxFailedItemsPerBatch = 5, + configuration = new + { + parsingMode = "markdown", + excludedFileNameExtensions = ".png,.mp4", + indexedFileNameExtensions = ".docx,.pptx", + failOnUnsupportedContentType = true, + failOnUnprocessableDocument = false, + indexStorageMetadataOnlyForOversizedDocuments = true, + delimitedTextHeaders = "Header1,Header2", + delimitedTextDelimiter = "|", + firstLineContainsHeaders = true, + markdownParsingSubmode = "oneToOne", + markdownHeaderDepth = "h6", + documentRoot = "/root", + dataToExtract = "storageMetadata", + imageAction = "none", + allowSkillsetToReadFileData = false, + pdfTextRotationAlgorithm = "none", + executionEnvironment = "standard", + }, + }, + ["fieldMappings"] = new object[] + { +new +{ +sourceFieldName = "/document", +targetFieldName = "name", +mappingFunction = new +{ +name = "base64Encode", +}, +} + }, + ["outputFieldMappings"] = new object[] + { +new +{ +sourceFieldName = "/document", +targetFieldName = "name", +mappingFunction = new +{ +name = "base64Encode", +}, +} + }, + ["disabled"] = false, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } + }); + Response response = await client.CreateOrUpdateAsync("myindexer", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("dataSourceName").ToString()); + Console.WriteLine(result.GetProperty("targetIndexName").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexers_CreateOrUpdate_SearchServiceCreateOrUpdateIndexer_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + SearchIndexer indexer = new SearchIndexer("myindexer", "mydocdbdatasource", "preview-test") + { + Description = "Description of the indexer", + SkillsetName = "myskillset", + Schedule = new IndexingSchedule(XmlConvert.ToTimeSpan("P1D")) + { + StartTime = DateTimeOffset.Parse("2025-01-07T19:30:00Z"), + }, + Parameters = new IndexingParameters + { + BatchSize = 10, + MaxFailedItems = 10, + MaxFailedItemsPerBatch = 5, + Configuration = new IndexingParametersConfiguration + { + ParsingMode = BlobIndexerParsingMode.Markdown, + ExcludedFileNameExtensions = ".png,.mp4", + IndexedFileNameExtensions = ".docx,.pptx", + FailOnUnsupportedContentType = true, + FailOnUnprocessableDocument = false, + IndexStorageMetadataOnlyForOversizedDocuments = true, + DelimitedTextHeaders = "Header1,Header2", + DelimitedTextDelimiter = "|", + FirstLineContainsHeaders = true, + MarkdownParsingSubmode = MarkdownParsingSubmode.OneToOne, + MarkdownHeaderDepth = MarkdownHeaderDepth.H6, + DocumentRoot = "/root", + DataToExtract = BlobIndexerDataToExtract.StorageMetadata, + ImageAction = BlobIndexerImageAction.None, + AllowSkillsetToReadFileData = false, + PdfTextRotationAlgorithm = BlobIndexerPDFTextRotationAlgorithm.None, + ExecutionEnvironment = IndexerExecutionEnvironment.Standard, + }, + }, + FieldMappings = {new FieldMapping("/document") +{ +TargetFieldName = "name", +MappingFunction = new FieldMappingFunction("base64Encode"), +}}, + OutputFieldMappings = {new FieldMapping("/document") +{ +TargetFieldName = "name", +MappingFunction = new FieldMappingFunction("base64Encode"), +}}, + Disabled = false, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + }; + Response response = client.CreateOrUpdate("myindexer", indexer); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexers_CreateOrUpdate_SearchServiceCreateOrUpdateIndexer_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + SearchIndexer indexer = new SearchIndexer("myindexer", "mydocdbdatasource", "preview-test") + { + Description = "Description of the indexer", + SkillsetName = "myskillset", + Schedule = new IndexingSchedule(XmlConvert.ToTimeSpan("P1D")) + { + StartTime = DateTimeOffset.Parse("2025-01-07T19:30:00Z"), + }, + Parameters = new IndexingParameters + { + BatchSize = 10, + MaxFailedItems = 10, + MaxFailedItemsPerBatch = 5, + Configuration = new IndexingParametersConfiguration + { + ParsingMode = BlobIndexerParsingMode.Markdown, + ExcludedFileNameExtensions = ".png,.mp4", + IndexedFileNameExtensions = ".docx,.pptx", + FailOnUnsupportedContentType = true, + FailOnUnprocessableDocument = false, + IndexStorageMetadataOnlyForOversizedDocuments = true, + DelimitedTextHeaders = "Header1,Header2", + DelimitedTextDelimiter = "|", + FirstLineContainsHeaders = true, + MarkdownParsingSubmode = MarkdownParsingSubmode.OneToOne, + MarkdownHeaderDepth = MarkdownHeaderDepth.H6, + DocumentRoot = "/root", + DataToExtract = BlobIndexerDataToExtract.StorageMetadata, + ImageAction = BlobIndexerImageAction.None, + AllowSkillsetToReadFileData = false, + PdfTextRotationAlgorithm = BlobIndexerPDFTextRotationAlgorithm.None, + ExecutionEnvironment = IndexerExecutionEnvironment.Standard, + }, + }, + FieldMappings = {new FieldMapping("/document") +{ +TargetFieldName = "name", +MappingFunction = new FieldMappingFunction("base64Encode"), +}}, + OutputFieldMappings = {new FieldMapping("/document") +{ +TargetFieldName = "name", +MappingFunction = new FieldMappingFunction("base64Encode"), +}}, + Disabled = false, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + }; + Response response = await client.CreateOrUpdateAsync("myindexer", indexer); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexers_Delete_SearchServiceDeleteIndexer() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = client.Delete("tempindexer"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexers_Delete_SearchServiceDeleteIndexer_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = await client.DeleteAsync("tempindexer"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexers_GetIndexer_SearchServiceGetIndexer() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = client.GetIndexer("myindexer", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("dataSourceName").ToString()); + Console.WriteLine(result.GetProperty("targetIndexName").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexers_GetIndexer_SearchServiceGetIndexer_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = await client.GetIndexerAsync("myindexer", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("dataSourceName").ToString()); + Console.WriteLine(result.GetProperty("targetIndexName").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexers_GetIndexer_SearchServiceGetIndexer_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = client.GetIndexer("myindexer"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexers_GetIndexer_SearchServiceGetIndexer_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = await client.GetIndexerAsync("myindexer"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexers_GetIndexers_SearchServiceListIndexers() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = client.GetIndexers("*", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("dataSourceName").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("targetIndexName").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexers_GetIndexers_SearchServiceListIndexers_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = await client.GetIndexersAsync("*", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("dataSourceName").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("targetIndexName").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexers_GetIndexers_SearchServiceListIndexers_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = client.GetIndexers(); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexers_GetIndexers_SearchServiceListIndexers_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = await client.GetIndexersAsync(); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexers_Create_SearchServiceCreateIndexer() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "myindexer", + ["description"] = "Description of the indexer", + ["dataSourceName"] = "mydocdbdatasource", + ["skillsetName"] = "myskillset", + ["targetIndexName"] = "preview-test", + ["schedule"] = new + { + interval = "P1D", + startTime = "2025-01-07T19:30:00Z", + }, + ["parameters"] = new + { + batchSize = 10, + maxFailedItems = 10, + maxFailedItemsPerBatch = 5, + configuration = new + { + parsingMode = "markdown", + excludedFileNameExtensions = ".png,.mp4", + indexedFileNameExtensions = ".docx,.pptx", + failOnUnsupportedContentType = true, + failOnUnprocessableDocument = false, + indexStorageMetadataOnlyForOversizedDocuments = true, + delimitedTextHeaders = "Header1,Header2", + delimitedTextDelimiter = "|", + firstLineContainsHeaders = true, + markdownParsingSubmode = "oneToMany", + markdownHeaderDepth = "h6", + documentRoot = "/root", + dataToExtract = "storageMetadata", + imageAction = "none", + allowSkillsetToReadFileData = false, + pdfTextRotationAlgorithm = "none", + executionEnvironment = "standard", + }, + }, + ["fieldMappings"] = new object[] + { +new +{ +sourceFieldName = "/document", +targetFieldName = "name", +mappingFunction = new +{ +name = "base64Encode", +}, +} + }, + ["outputFieldMappings"] = new object[] + { +new +{ +sourceFieldName = "/document", +targetFieldName = "name", +mappingFunction = new +{ +name = "base64Encode", +}, +} + }, + ["disabled"] = false, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + }, + ["cache"] = new + { + storageConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + enableReprocessing = true, + identity = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + } + }); + Response response = client.Create(content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("dataSourceName").ToString()); + Console.WriteLine(result.GetProperty("targetIndexName").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexers_Create_SearchServiceCreateIndexer_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "myindexer", + ["description"] = "Description of the indexer", + ["dataSourceName"] = "mydocdbdatasource", + ["skillsetName"] = "myskillset", + ["targetIndexName"] = "preview-test", + ["schedule"] = new + { + interval = "P1D", + startTime = "2025-01-07T19:30:00Z", + }, + ["parameters"] = new + { + batchSize = 10, + maxFailedItems = 10, + maxFailedItemsPerBatch = 5, + configuration = new + { + parsingMode = "markdown", + excludedFileNameExtensions = ".png,.mp4", + indexedFileNameExtensions = ".docx,.pptx", + failOnUnsupportedContentType = true, + failOnUnprocessableDocument = false, + indexStorageMetadataOnlyForOversizedDocuments = true, + delimitedTextHeaders = "Header1,Header2", + delimitedTextDelimiter = "|", + firstLineContainsHeaders = true, + markdownParsingSubmode = "oneToMany", + markdownHeaderDepth = "h6", + documentRoot = "/root", + dataToExtract = "storageMetadata", + imageAction = "none", + allowSkillsetToReadFileData = false, + pdfTextRotationAlgorithm = "none", + executionEnvironment = "standard", + }, + }, + ["fieldMappings"] = new object[] + { +new +{ +sourceFieldName = "/document", +targetFieldName = "name", +mappingFunction = new +{ +name = "base64Encode", +}, +} + }, + ["outputFieldMappings"] = new object[] + { +new +{ +sourceFieldName = "/document", +targetFieldName = "name", +mappingFunction = new +{ +name = "base64Encode", +}, +} + }, + ["disabled"] = false, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + }, + ["cache"] = new + { + storageConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + enableReprocessing = true, + identity = new Dictionary + { + ["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" + }, + } + }); + Response response = await client.CreateAsync(content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("dataSourceName").ToString()); + Console.WriteLine(result.GetProperty("targetIndexName").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexers_Create_SearchServiceCreateIndexer_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + SearchIndexer indexer = new SearchIndexer("myindexer", "mydocdbdatasource", "preview-test") + { + Description = "Description of the indexer", + SkillsetName = "myskillset", + Schedule = new IndexingSchedule(XmlConvert.ToTimeSpan("P1D")) + { + StartTime = DateTimeOffset.Parse("2025-01-07T19:30:00Z"), + }, + Parameters = new IndexingParameters + { + BatchSize = 10, + MaxFailedItems = 10, + MaxFailedItemsPerBatch = 5, + Configuration = new IndexingParametersConfiguration + { + ParsingMode = BlobIndexerParsingMode.Markdown, + ExcludedFileNameExtensions = ".png,.mp4", + IndexedFileNameExtensions = ".docx,.pptx", + FailOnUnsupportedContentType = true, + FailOnUnprocessableDocument = false, + IndexStorageMetadataOnlyForOversizedDocuments = true, + DelimitedTextHeaders = "Header1,Header2", + DelimitedTextDelimiter = "|", + FirstLineContainsHeaders = true, + MarkdownParsingSubmode = MarkdownParsingSubmode.OneToMany, + MarkdownHeaderDepth = MarkdownHeaderDepth.H6, + DocumentRoot = "/root", + DataToExtract = BlobIndexerDataToExtract.StorageMetadata, + ImageAction = BlobIndexerImageAction.None, + AllowSkillsetToReadFileData = false, + PdfTextRotationAlgorithm = BlobIndexerPDFTextRotationAlgorithm.None, + ExecutionEnvironment = IndexerExecutionEnvironment.Standard, + }, + }, + FieldMappings = {new FieldMapping("/document") +{ +TargetFieldName = "name", +MappingFunction = new FieldMappingFunction("base64Encode"), +}}, + OutputFieldMappings = {new FieldMapping("/document") +{ +TargetFieldName = "name", +MappingFunction = new FieldMappingFunction("base64Encode"), +}}, + Disabled = false, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + Cache = new SearchIndexerCache + { + StorageConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + EnableReprocessing = true, + Identity = new SearchIndexerDataNoneIdentity(), + }, + }; + Response response = client.Create(indexer); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexers_Create_SearchServiceCreateIndexer_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + SearchIndexer indexer = new SearchIndexer("myindexer", "mydocdbdatasource", "preview-test") + { + Description = "Description of the indexer", + SkillsetName = "myskillset", + Schedule = new IndexingSchedule(XmlConvert.ToTimeSpan("P1D")) + { + StartTime = DateTimeOffset.Parse("2025-01-07T19:30:00Z"), + }, + Parameters = new IndexingParameters + { + BatchSize = 10, + MaxFailedItems = 10, + MaxFailedItemsPerBatch = 5, + Configuration = new IndexingParametersConfiguration + { + ParsingMode = BlobIndexerParsingMode.Markdown, + ExcludedFileNameExtensions = ".png,.mp4", + IndexedFileNameExtensions = ".docx,.pptx", + FailOnUnsupportedContentType = true, + FailOnUnprocessableDocument = false, + IndexStorageMetadataOnlyForOversizedDocuments = true, + DelimitedTextHeaders = "Header1,Header2", + DelimitedTextDelimiter = "|", + FirstLineContainsHeaders = true, + MarkdownParsingSubmode = MarkdownParsingSubmode.OneToMany, + MarkdownHeaderDepth = MarkdownHeaderDepth.H6, + DocumentRoot = "/root", + DataToExtract = BlobIndexerDataToExtract.StorageMetadata, + ImageAction = BlobIndexerImageAction.None, + AllowSkillsetToReadFileData = false, + PdfTextRotationAlgorithm = BlobIndexerPDFTextRotationAlgorithm.None, + ExecutionEnvironment = IndexerExecutionEnvironment.Standard, + }, + }, + FieldMappings = {new FieldMapping("/document") +{ +TargetFieldName = "name", +MappingFunction = new FieldMappingFunction("base64Encode"), +}}, + OutputFieldMappings = {new FieldMapping("/document") +{ +TargetFieldName = "name", +MappingFunction = new FieldMappingFunction("base64Encode"), +}}, + Disabled = false, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + Cache = new SearchIndexerCache + { + StorageConnectionString = "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ", + EnableReprocessing = true, + Identity = new SearchIndexerDataNoneIdentity(), + }, + }; + Response response = await client.CreateAsync(indexer); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexers_GetStatus_SearchServiceGetIndexerStatus() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = client.GetStatus("myindexer", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("errors")[0].GetProperty("errorMessage").ToString()); + Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("errors")[0].GetProperty("statusCode").ToString()); + Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("warnings")[0].GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("itemsProcessed").ToString()); + Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("itemsFailed").ToString()); + Console.WriteLine(result.GetProperty("limits").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexers_GetStatus_SearchServiceGetIndexerStatus_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = await client.GetStatusAsync("myindexer", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("errors")[0].GetProperty("errorMessage").ToString()); + Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("errors")[0].GetProperty("statusCode").ToString()); + Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("warnings")[0].GetProperty("message").ToString()); + Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("itemsProcessed").ToString()); + Console.WriteLine(result.GetProperty("executionHistory")[0].GetProperty("itemsFailed").ToString()); + Console.WriteLine(result.GetProperty("limits").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexers_GetStatus_SearchServiceGetIndexerStatus_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = client.GetStatus("myindexer"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexers_GetStatus_SearchServiceGetIndexerStatus_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexers client = new SearchClient(endpoint, credential).GetIndexersClient(); + + Response response = await client.GetStatusAsync("myindexer"); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_Indexes.cs b/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_Indexes.cs new file mode 100644 index 000000000000..7e0bf33eaf22 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_Indexes.cs @@ -0,0 +1,3149 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Text.Json; +using System.Threading.Tasks; +using System.Xml; +using Azure.Core; +using Azure.Identity; +using NUnit.Framework; + +namespace Azure.Search.Documents.Indexes.Samples +{ + public partial class Samples_Indexes + { + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexes_Create_SearchServiceCreateIndex() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "temp-preview-test", + ["fields"] = new object[] + { +new +{ +name = "id", +type = "Edm.String", +key = true, +sortable = true, +}, +new +{ +name = "vector1", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 20, +vectorSearchProfile = "config1", +}, +new +{ +name = "vector1b", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 10, +vectorSearchProfile = "config2", +}, +new +{ +name = "vector2", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 5, +vectorSearchProfile = "config3", +}, +new +{ +name = "vector3", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 5, +vectorSearchProfile = "config3", +}, +new +{ +name = "vector22", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 10, +vectorSearchProfile = "config2", +}, +new +{ +name = "vector4", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 32, +vectorSearchProfile = "config4", +}, +new +{ +name = "name", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "en.lucene", +}, +new +{ +name = "description", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "standard.lucene", +}, +new +{ +name = "category", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "en.lucene", +}, +new +{ +name = "ownerId", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "en.lucene", +}, +new +{ +name = "price", +type = "Edm.Double", +retrievable = true, +filterable = true, +sortable = true, +facetable = true, +} + }, + ["scoringProfiles"] = new object[] + { +new +{ +name = "stringFieldBoost", +text = new +{ +weights = new +{ +name = 3, +description = 1, +category = 2, +ownerId = 1, +}, +}, +functions = new object[] +{ +new +{ +tag = new +{ +tagsParameter = "categoryTag", +}, +type = "tag", +fieldName = "category", +boost = 2, +} +}, +} + }, + ["defaultScoringProfile"] = "stringFieldBoost", + ["corsOptions"] = new + { + allowedOrigins = new object[] + { +"https://www.example.com/foo" + }, + maxAgeInSeconds = 10L, + }, + ["suggesters"] = new object[] + { +new +{ +name = "sg", +searchMode = "analyzingInfixMatching", +sourceFields = new object[] +{ +"category", +"ownerId" +}, +} + }, + ["analyzers"] = new object[] + { +new Dictionary +{ +["tokenizer"] = "standard_v2", +["tokenFilters"] = new object[] +{ +"common_grams" +}, +["charFilters"] = new object[] +{ +"html_strip" +}, +["@odata.type"] = "#Microsoft.Azure.Search.CustomAnalyzer", +["name"] = "tagsAnalyzer" +} + }, + ["tokenizers"] = new object[] + { +new Dictionary +{ +["maxTokenLength"] = 100, +["@odata.type"] = "#Microsoft.Azure.Search.StandardTokenizerV2", +["name"] = "my_tokenizer" +} + }, + ["tokenFilters"] = new object[] + { +new Dictionary +{ +["preserveOriginal"] = false, +["@odata.type"] = "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", +["name"] = "my_tokenFilter" +} + }, + ["charFilters"] = new object[] + { +new Dictionary +{ +["mappings"] = new object[] +{ +".=>,", +"_=>-" +}, +["@odata.type"] = "#Microsoft.Azure.Search.MappingCharFilter", +["name"] = "my_mapping" +} + }, + ["normalizers"] = new object[] + { +new Dictionary +{ +["tokenFilters"] = new object[] +{ +"my_tokenFilter" +}, +["charFilters"] = new object[] +{ +"my_mapping" +}, +["@odata.type"] = "#Microsoft.Azure.Search.CustomNormalizer", +["name"] = "my_normalizer" +} + }, + ["similarity"] = new Dictionary + { + ["k1"] = 10, + ["b"] = 0.1, + ["@odata.type"] = "#Microsoft.Azure.Search.BM25Similarity" + }, + ["semantic"] = new + { + defaultConfiguration = "testconfig", + configurations = new object[] + { +new +{ +name = "testconfig", +prioritizedFields = new +{ +titleField = new +{ +fieldName = "category", +}, +prioritizedContentFields = new object[] +{ +new +{ +fieldName = "description", +} +}, +prioritizedKeywordsFields = new object[] +{ +new +{ +fieldName = "ownerId", +} +}, +}, +flightingOptIn = true, +} + }, + }, + ["vectorSearch"] = new + { + profiles = new object[] + { +new +{ +name = "config1", +algorithm = "cosine", +vectorizer = "openai", +compression = "mySQ8", +}, +new +{ +name = "config2", +algorithm = "euclidean", +vectorizer = "custom-web-api", +compression = "mySQ8", +}, +new +{ +name = "config3", +algorithm = "dotProduct", +vectorizer = "custom-web-api", +compression = "myBQC", +}, +new +{ +name = "config4", +algorithm = "dotProduct", +vectorizer = "custom-web-api", +compression = "myBQWithoutOriginals", +} + }, + algorithms = new object[] + { +new +{ +hnswParameters = new +{ +metric = "cosine", +}, +name = "cosine", +kind = "hnsw", +}, +new +{ +hnswParameters = new +{ +metric = "euclidean", +}, +name = "euclidean", +kind = "hnsw", +}, +new +{ +hnswParameters = new +{ +metric = "dotProduct", +}, +name = "dotProduct", +kind = "hnsw", +} + }, + vectorizers = new object[] + { +new +{ +azureOpenAIParameters = new +{ +resourceUri = "https://test-sample.openai.azure.com/", +deploymentId = "model", +apiKey = "api-key", +modelName = "text-embedding-3-large", +}, +name = "openai", +kind = "azureOpenAI", +}, +new +{ +customWebApiParameters = new +{ +uri = "https://my-custom-endpoint.org/", +httpHeaders = new +{ +header1 = "value1", +header2 = "value2", +}, +httpMethod = "POST", +timeout = "PT1M", +authResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", +authIdentity = new Dictionary +{ +["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" +}, +}, +name = "custom-web-api", +kind = "customWebApi", +}, +new +{ +amlParameters = new +{ +uri = "https://my-custom-endpoint.org/", +resourceId = "aml resource id", +timeout = "PT1M", +region = "aml region", +modelName = "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32", +}, +name = "aml", +kind = "aml", +} + }, + compressions = new object[] + { +new +{ +scalarQuantizationParameters = new +{ +quantizedDataType = "int8", +}, +name = "mySQ8", +kind = "scalarQuantization", +rescoringOptions = new +{ +enableRescoring = true, +defaultOversampling = 10, +rescoreStorageMethod = "preserveOriginals", +}, +truncationDimension = 2, +}, +new +{ +name = "myBQC", +kind = "binaryQuantization", +rescoringOptions = new +{ +enableRescoring = true, +defaultOversampling = 10, +rescoreStorageMethod = "preserveOriginals", +}, +truncationDimension = 2, +}, +new +{ +name = "myBQWithoutOriginals", +kind = "binaryQuantization", +rescoringOptions = new +{ +enableRescoring = true, +defaultOversampling = 10, +rescoreStorageMethod = "discardOriginals", +}, +truncationDimension = 2, +} + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" + }); + Response response = client.Create(content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexes_Create_SearchServiceCreateIndex_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "temp-preview-test", + ["fields"] = new object[] + { +new +{ +name = "id", +type = "Edm.String", +key = true, +sortable = true, +}, +new +{ +name = "vector1", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 20, +vectorSearchProfile = "config1", +}, +new +{ +name = "vector1b", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 10, +vectorSearchProfile = "config2", +}, +new +{ +name = "vector2", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 5, +vectorSearchProfile = "config3", +}, +new +{ +name = "vector3", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 5, +vectorSearchProfile = "config3", +}, +new +{ +name = "vector22", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 10, +vectorSearchProfile = "config2", +}, +new +{ +name = "vector4", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 32, +vectorSearchProfile = "config4", +}, +new +{ +name = "name", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "en.lucene", +}, +new +{ +name = "description", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "standard.lucene", +}, +new +{ +name = "category", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "en.lucene", +}, +new +{ +name = "ownerId", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "en.lucene", +}, +new +{ +name = "price", +type = "Edm.Double", +retrievable = true, +filterable = true, +sortable = true, +facetable = true, +} + }, + ["scoringProfiles"] = new object[] + { +new +{ +name = "stringFieldBoost", +text = new +{ +weights = new +{ +name = 3, +description = 1, +category = 2, +ownerId = 1, +}, +}, +functions = new object[] +{ +new +{ +tag = new +{ +tagsParameter = "categoryTag", +}, +type = "tag", +fieldName = "category", +boost = 2, +} +}, +} + }, + ["defaultScoringProfile"] = "stringFieldBoost", + ["corsOptions"] = new + { + allowedOrigins = new object[] + { +"https://www.example.com/foo" + }, + maxAgeInSeconds = 10L, + }, + ["suggesters"] = new object[] + { +new +{ +name = "sg", +searchMode = "analyzingInfixMatching", +sourceFields = new object[] +{ +"category", +"ownerId" +}, +} + }, + ["analyzers"] = new object[] + { +new Dictionary +{ +["tokenizer"] = "standard_v2", +["tokenFilters"] = new object[] +{ +"common_grams" +}, +["charFilters"] = new object[] +{ +"html_strip" +}, +["@odata.type"] = "#Microsoft.Azure.Search.CustomAnalyzer", +["name"] = "tagsAnalyzer" +} + }, + ["tokenizers"] = new object[] + { +new Dictionary +{ +["maxTokenLength"] = 100, +["@odata.type"] = "#Microsoft.Azure.Search.StandardTokenizerV2", +["name"] = "my_tokenizer" +} + }, + ["tokenFilters"] = new object[] + { +new Dictionary +{ +["preserveOriginal"] = false, +["@odata.type"] = "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", +["name"] = "my_tokenFilter" +} + }, + ["charFilters"] = new object[] + { +new Dictionary +{ +["mappings"] = new object[] +{ +".=>,", +"_=>-" +}, +["@odata.type"] = "#Microsoft.Azure.Search.MappingCharFilter", +["name"] = "my_mapping" +} + }, + ["normalizers"] = new object[] + { +new Dictionary +{ +["tokenFilters"] = new object[] +{ +"my_tokenFilter" +}, +["charFilters"] = new object[] +{ +"my_mapping" +}, +["@odata.type"] = "#Microsoft.Azure.Search.CustomNormalizer", +["name"] = "my_normalizer" +} + }, + ["similarity"] = new Dictionary + { + ["k1"] = 10, + ["b"] = 0.1, + ["@odata.type"] = "#Microsoft.Azure.Search.BM25Similarity" + }, + ["semantic"] = new + { + defaultConfiguration = "testconfig", + configurations = new object[] + { +new +{ +name = "testconfig", +prioritizedFields = new +{ +titleField = new +{ +fieldName = "category", +}, +prioritizedContentFields = new object[] +{ +new +{ +fieldName = "description", +} +}, +prioritizedKeywordsFields = new object[] +{ +new +{ +fieldName = "ownerId", +} +}, +}, +flightingOptIn = true, +} + }, + }, + ["vectorSearch"] = new + { + profiles = new object[] + { +new +{ +name = "config1", +algorithm = "cosine", +vectorizer = "openai", +compression = "mySQ8", +}, +new +{ +name = "config2", +algorithm = "euclidean", +vectorizer = "custom-web-api", +compression = "mySQ8", +}, +new +{ +name = "config3", +algorithm = "dotProduct", +vectorizer = "custom-web-api", +compression = "myBQC", +}, +new +{ +name = "config4", +algorithm = "dotProduct", +vectorizer = "custom-web-api", +compression = "myBQWithoutOriginals", +} + }, + algorithms = new object[] + { +new +{ +hnswParameters = new +{ +metric = "cosine", +}, +name = "cosine", +kind = "hnsw", +}, +new +{ +hnswParameters = new +{ +metric = "euclidean", +}, +name = "euclidean", +kind = "hnsw", +}, +new +{ +hnswParameters = new +{ +metric = "dotProduct", +}, +name = "dotProduct", +kind = "hnsw", +} + }, + vectorizers = new object[] + { +new +{ +azureOpenAIParameters = new +{ +resourceUri = "https://test-sample.openai.azure.com/", +deploymentId = "model", +apiKey = "api-key", +modelName = "text-embedding-3-large", +}, +name = "openai", +kind = "azureOpenAI", +}, +new +{ +customWebApiParameters = new +{ +uri = "https://my-custom-endpoint.org/", +httpHeaders = new +{ +header1 = "value1", +header2 = "value2", +}, +httpMethod = "POST", +timeout = "PT1M", +authResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", +authIdentity = new Dictionary +{ +["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" +}, +}, +name = "custom-web-api", +kind = "customWebApi", +}, +new +{ +amlParameters = new +{ +uri = "https://my-custom-endpoint.org/", +resourceId = "aml resource id", +timeout = "PT1M", +region = "aml region", +modelName = "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32", +}, +name = "aml", +kind = "aml", +} + }, + compressions = new object[] + { +new +{ +scalarQuantizationParameters = new +{ +quantizedDataType = "int8", +}, +name = "mySQ8", +kind = "scalarQuantization", +rescoringOptions = new +{ +enableRescoring = true, +defaultOversampling = 10, +rescoreStorageMethod = "preserveOriginals", +}, +truncationDimension = 2, +}, +new +{ +name = "myBQC", +kind = "binaryQuantization", +rescoringOptions = new +{ +enableRescoring = true, +defaultOversampling = 10, +rescoreStorageMethod = "preserveOriginals", +}, +truncationDimension = 2, +}, +new +{ +name = "myBQWithoutOriginals", +kind = "binaryQuantization", +rescoringOptions = new +{ +enableRescoring = true, +defaultOversampling = 10, +rescoreStorageMethod = "discardOriginals", +}, +truncationDimension = 2, +} + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" + }); + Response response = await client.CreateAsync(content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexes_Create_SearchServiceCreateIndex_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + SearchIndex index = new SearchIndex("temp-preview-test", new SearchField[] + { +new SearchField("id", SearchFieldDataType.String) +{ +Key = true, +Sortable = true, +}, +new SearchField("vector1", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 20, +VectorSearchProfile = "config1", +}, +new SearchField("vector1b", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 10, +VectorSearchProfile = "config2", +}, +new SearchField("vector2", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 5, +VectorSearchProfile = "config3", +}, +new SearchField("vector3", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 5, +VectorSearchProfile = "config3", +}, +new SearchField("vector22", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 10, +VectorSearchProfile = "config2", +}, +new SearchField("vector4", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 32, +VectorSearchProfile = "config4", +}, +new SearchField("name", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.EnLucene, +}, +new SearchField("description", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.StandardLucene, +}, +new SearchField("category", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.EnLucene, +}, +new SearchField("ownerId", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.EnLucene, +}, +new SearchField("price", SearchFieldDataType.Double) +{ +Retrievable = true, +Filterable = true, +Sortable = true, +Facetable = true, +} + }) + { + ScoringProfiles = {new ScoringProfile("stringFieldBoost") +{ +Text = new TextWeights(new Dictionary +{ +["name"] = 3, +["description"] = 1, +["category"] = 2, +["ownerId"] = 1 +}), +Functions = {new TagScoringFunction("category", 2, new TagScoringParameters("categoryTag"))}, +}}, + DefaultScoringProfile = "stringFieldBoost", + CorsOptions = new CorsOptions(new string[] { "https://www.example.com/foo" }) + { + MaxAgeInSeconds = 10L, + }, + Suggesters = { new SearchSuggester("sg", new string[] { "category", "ownerId" }) }, + Analyzers = {new CustomAnalyzer("tagsAnalyzer", LexicalTokenizerName.Standard) +{ +TokenFilters = {TokenFilterName.CommonGram}, +CharFilters = {CharFilterName.HtmlStrip}, +}}, + Tokenizers = {new LuceneStandardTokenizerV2("my_tokenizer") +{ +MaxTokenLength = 100, +}}, + TokenFilters = {new AsciiFoldingTokenFilter("my_tokenFilter") +{ +PreserveOriginal = false, +}}, + CharFilters = { new MappingCharFilter("my_mapping", new string[] { ".=>,", "_=>-" }) }, + Normalizers = {new CustomNormalizer("my_normalizer") +{ +TokenFilters = {new TokenFilterName("my_tokenFilter")}, +CharFilters = {new CharFilterName("my_mapping")}, +}}, + Similarity = new BM25SimilarityAlgorithm + { + K1 = 10, + B = 0.1, + }, + Semantic = new SemanticSearch + { + DefaultConfiguration = "testconfig", + Configurations = {new SemanticConfiguration("testconfig", new SemanticPrioritizedFields +{ +TitleField = new SemanticField("category"), +PrioritizedContentFields = {new SemanticField("description")}, +PrioritizedKeywordsFields = {new SemanticField("ownerId")}, +}) +{ +FlightingOptIn = true, +}}, + }, + VectorSearch = new VectorSearch + { + Profiles = {new VectorSearchProfile("config1", "cosine") +{ +Vectorizer = "openai", +Compression = "mySQ8", +}, new VectorSearchProfile("config2", "euclidean") +{ +Vectorizer = "custom-web-api", +Compression = "mySQ8", +}, new VectorSearchProfile("config3", "dotProduct") +{ +Vectorizer = "custom-web-api", +Compression = "myBQC", +}, new VectorSearchProfile("config4", "dotProduct") +{ +Vectorizer = "custom-web-api", +Compression = "myBQWithoutOriginals", +}}, + Algorithms = {new HnswAlgorithmConfiguration("cosine") +{ +HnswParameters = new HnswParameters +{ +Metric = VectorSearchAlgorithmMetric.Cosine, +}, +}, new HnswAlgorithmConfiguration("euclidean") +{ +HnswParameters = new HnswParameters +{ +Metric = VectorSearchAlgorithmMetric.Euclidean, +}, +}, new HnswAlgorithmConfiguration("dotProduct") +{ +HnswParameters = new HnswParameters +{ +Metric = VectorSearchAlgorithmMetric.DotProduct, +}, +}}, + Vectorizers = {new AzureOpenAIVectorizer("openai") +{ +AzureOpenAIParameters = new AzureOpenAIVectorizerParameters +{ +ResourceUri = new Uri("https://test-sample.openai.azure.com/"), +DeploymentId = "model", +ApiKey = "api-key", +ModelName = AzureOpenAIModelName.TextEmbedding3Large, +}, +}, new WebApiVectorizer("custom-web-api") +{ +CustomWebApiParameters = new WebApiVectorizerParameters +{ +Uri = new Uri("https://my-custom-endpoint.org/"), +HttpHeaders = +{ +["header1"] = "value1", +["header2"] = "value2" +}, +HttpMethod = "POST", +Timeout = XmlConvert.ToTimeSpan("PT1M"), +AuthResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", +AuthIdentity = new SearchIndexerDataNoneIdentity(), +}, +}, new AMLVectorizer("aml") +{ +AmlParameters = new AMLParameters(new Uri("https://my-custom-endpoint.org/")) +{ +ResourceId = "aml resource id", +Timeout = XmlConvert.ToTimeSpan("PT1M"), +Region = "aml region", +ModelName = AIFoundryModelCatalogName.OpenAICLIPImageTextEmbeddingsVitBasePatch32, +}, +}}, + Compressions = {new ScalarQuantizationCompression("mySQ8") +{ +ScalarQuantizationParameters = new ScalarQuantizationParameters +{ +QuantizedDataType = VectorSearchCompressionTarget.Int8, +}, +RescoringOptions = new RescoringOptions +{ +EnableRescoring = true, +DefaultOversampling = 10, +RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, +}, +TruncationDimension = 2, +}, new BinaryQuantizationCompression("myBQC") +{ +RescoringOptions = new RescoringOptions +{ +EnableRescoring = true, +DefaultOversampling = 10, +RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, +}, +TruncationDimension = 2, +}, new BinaryQuantizationCompression("myBQWithoutOriginals") +{ +RescoringOptions = new RescoringOptions +{ +EnableRescoring = true, +DefaultOversampling = 10, +RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.DiscardOriginals, +}, +TruncationDimension = 2, +}}, + }, + ETag = "0x1234568AE7E58A1", + }; + Response response = client.Create(index); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexes_Create_SearchServiceCreateIndex_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + SearchIndex index = new SearchIndex("temp-preview-test", new SearchField[] + { +new SearchField("id", SearchFieldDataType.String) +{ +Key = true, +Sortable = true, +}, +new SearchField("vector1", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 20, +VectorSearchProfile = "config1", +}, +new SearchField("vector1b", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 10, +VectorSearchProfile = "config2", +}, +new SearchField("vector2", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 5, +VectorSearchProfile = "config3", +}, +new SearchField("vector3", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 5, +VectorSearchProfile = "config3", +}, +new SearchField("vector22", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 10, +VectorSearchProfile = "config2", +}, +new SearchField("vector4", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 32, +VectorSearchProfile = "config4", +}, +new SearchField("name", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.EnLucene, +}, +new SearchField("description", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.StandardLucene, +}, +new SearchField("category", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.EnLucene, +}, +new SearchField("ownerId", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.EnLucene, +}, +new SearchField("price", SearchFieldDataType.Double) +{ +Retrievable = true, +Filterable = true, +Sortable = true, +Facetable = true, +} + }) + { + ScoringProfiles = {new ScoringProfile("stringFieldBoost") +{ +Text = new TextWeights(new Dictionary +{ +["name"] = 3, +["description"] = 1, +["category"] = 2, +["ownerId"] = 1 +}), +Functions = {new TagScoringFunction("category", 2, new TagScoringParameters("categoryTag"))}, +}}, + DefaultScoringProfile = "stringFieldBoost", + CorsOptions = new CorsOptions(new string[] { "https://www.example.com/foo" }) + { + MaxAgeInSeconds = 10L, + }, + Suggesters = { new SearchSuggester("sg", new string[] { "category", "ownerId" }) }, + Analyzers = {new CustomAnalyzer("tagsAnalyzer", LexicalTokenizerName.Standard) +{ +TokenFilters = {TokenFilterName.CommonGram}, +CharFilters = {CharFilterName.HtmlStrip}, +}}, + Tokenizers = {new LuceneStandardTokenizerV2("my_tokenizer") +{ +MaxTokenLength = 100, +}}, + TokenFilters = {new AsciiFoldingTokenFilter("my_tokenFilter") +{ +PreserveOriginal = false, +}}, + CharFilters = { new MappingCharFilter("my_mapping", new string[] { ".=>,", "_=>-" }) }, + Normalizers = {new CustomNormalizer("my_normalizer") +{ +TokenFilters = {new TokenFilterName("my_tokenFilter")}, +CharFilters = {new CharFilterName("my_mapping")}, +}}, + Similarity = new BM25SimilarityAlgorithm + { + K1 = 10, + B = 0.1, + }, + Semantic = new SemanticSearch + { + DefaultConfiguration = "testconfig", + Configurations = {new SemanticConfiguration("testconfig", new SemanticPrioritizedFields +{ +TitleField = new SemanticField("category"), +PrioritizedContentFields = {new SemanticField("description")}, +PrioritizedKeywordsFields = {new SemanticField("ownerId")}, +}) +{ +FlightingOptIn = true, +}}, + }, + VectorSearch = new VectorSearch + { + Profiles = {new VectorSearchProfile("config1", "cosine") +{ +Vectorizer = "openai", +Compression = "mySQ8", +}, new VectorSearchProfile("config2", "euclidean") +{ +Vectorizer = "custom-web-api", +Compression = "mySQ8", +}, new VectorSearchProfile("config3", "dotProduct") +{ +Vectorizer = "custom-web-api", +Compression = "myBQC", +}, new VectorSearchProfile("config4", "dotProduct") +{ +Vectorizer = "custom-web-api", +Compression = "myBQWithoutOriginals", +}}, + Algorithms = {new HnswAlgorithmConfiguration("cosine") +{ +HnswParameters = new HnswParameters +{ +Metric = VectorSearchAlgorithmMetric.Cosine, +}, +}, new HnswAlgorithmConfiguration("euclidean") +{ +HnswParameters = new HnswParameters +{ +Metric = VectorSearchAlgorithmMetric.Euclidean, +}, +}, new HnswAlgorithmConfiguration("dotProduct") +{ +HnswParameters = new HnswParameters +{ +Metric = VectorSearchAlgorithmMetric.DotProduct, +}, +}}, + Vectorizers = {new AzureOpenAIVectorizer("openai") +{ +AzureOpenAIParameters = new AzureOpenAIVectorizerParameters +{ +ResourceUri = new Uri("https://test-sample.openai.azure.com/"), +DeploymentId = "model", +ApiKey = "api-key", +ModelName = AzureOpenAIModelName.TextEmbedding3Large, +}, +}, new WebApiVectorizer("custom-web-api") +{ +CustomWebApiParameters = new WebApiVectorizerParameters +{ +Uri = new Uri("https://my-custom-endpoint.org/"), +HttpHeaders = +{ +["header1"] = "value1", +["header2"] = "value2" +}, +HttpMethod = "POST", +Timeout = XmlConvert.ToTimeSpan("PT1M"), +AuthResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", +AuthIdentity = new SearchIndexerDataNoneIdentity(), +}, +}, new AMLVectorizer("aml") +{ +AmlParameters = new AMLParameters(new Uri("https://my-custom-endpoint.org/")) +{ +ResourceId = "aml resource id", +Timeout = XmlConvert.ToTimeSpan("PT1M"), +Region = "aml region", +ModelName = AIFoundryModelCatalogName.OpenAICLIPImageTextEmbeddingsVitBasePatch32, +}, +}}, + Compressions = {new ScalarQuantizationCompression("mySQ8") +{ +ScalarQuantizationParameters = new ScalarQuantizationParameters +{ +QuantizedDataType = VectorSearchCompressionTarget.Int8, +}, +RescoringOptions = new RescoringOptions +{ +EnableRescoring = true, +DefaultOversampling = 10, +RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, +}, +TruncationDimension = 2, +}, new BinaryQuantizationCompression("myBQC") +{ +RescoringOptions = new RescoringOptions +{ +EnableRescoring = true, +DefaultOversampling = 10, +RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, +}, +TruncationDimension = 2, +}, new BinaryQuantizationCompression("myBQWithoutOriginals") +{ +RescoringOptions = new RescoringOptions +{ +EnableRescoring = true, +DefaultOversampling = 10, +RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.DiscardOriginals, +}, +TruncationDimension = 2, +}}, + }, + ETag = "0x1234568AE7E58A1", + }; + Response response = await client.CreateAsync(index); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexes_CreateOrUpdate_SearchServiceCreateOrUpdateIndex() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "temp-preview-test", + ["fields"] = new object[] + { +new +{ +name = "id", +type = "Edm.String", +key = true, +sortable = true, +}, +new +{ +name = "vector1", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 20, +vectorSearchProfile = "config1", +}, +new +{ +name = "vector1b", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 10, +vectorSearchProfile = "config2", +}, +new +{ +name = "vector2", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 5, +vectorSearchProfile = "config3", +}, +new +{ +name = "vector3", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 5, +vectorSearchProfile = "config3", +}, +new +{ +name = "vector22", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 10, +vectorSearchProfile = "config2", +}, +new +{ +name = "vector4", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 32, +vectorSearchProfile = "config4", +}, +new +{ +name = "name", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "en.lucene", +}, +new +{ +name = "description", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "standard.lucene", +}, +new +{ +name = "category", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "en.lucene", +}, +new +{ +name = "ownerId", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "en.lucene", +}, +new +{ +name = "price", +type = "Edm.Double", +retrievable = true, +filterable = true, +sortable = true, +facetable = true, +} + }, + ["scoringProfiles"] = new object[] + { +new +{ +name = "stringFieldBoost", +text = new +{ +weights = new +{ +name = 3, +description = 1, +category = 2, +ownerId = 1, +}, +}, +functions = new object[] +{ +new +{ +tag = new +{ +tagsParameter = "categoryTag", +}, +type = "tag", +fieldName = "category", +boost = 2, +} +}, +} + }, + ["defaultScoringProfile"] = "stringFieldBoost", + ["corsOptions"] = new + { + allowedOrigins = new object[] + { +"https://www.example.com/foo" + }, + maxAgeInSeconds = 10L, + }, + ["suggesters"] = new object[] + { +new +{ +name = "sg", +searchMode = "analyzingInfixMatching", +sourceFields = new object[] +{ +"category", +"ownerId" +}, +} + }, + ["analyzers"] = new object[] + { +new Dictionary +{ +["tokenizer"] = "standard_v2", +["tokenFilters"] = new object[] +{ +"common_grams" +}, +["charFilters"] = new object[] +{ +"html_strip" +}, +["@odata.type"] = "#Microsoft.Azure.Search.CustomAnalyzer", +["name"] = "tagsAnalyzer" +} + }, + ["tokenizers"] = new object[] + { +new Dictionary +{ +["maxTokenLength"] = 100, +["@odata.type"] = "#Microsoft.Azure.Search.StandardTokenizerV2", +["name"] = "my_tokenizer" +} + }, + ["tokenFilters"] = new object[] + { +new Dictionary +{ +["preserveOriginal"] = false, +["@odata.type"] = "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", +["name"] = "my_tokenFilter" +} + }, + ["charFilters"] = new object[] + { +new Dictionary +{ +["mappings"] = new object[] +{ +".=>,", +"_=>-" +}, +["@odata.type"] = "#Microsoft.Azure.Search.MappingCharFilter", +["name"] = "my_mapping" +} + }, + ["normalizers"] = new object[] + { +new Dictionary +{ +["tokenFilters"] = new object[] +{ +"my_tokenFilter" +}, +["charFilters"] = new object[] +{ +"my_mapping" +}, +["@odata.type"] = "#Microsoft.Azure.Search.CustomNormalizer", +["name"] = "my_normalizer" +} + }, + ["similarity"] = new Dictionary + { + ["k1"] = 10, + ["b"] = 0.1, + ["@odata.type"] = "#Microsoft.Azure.Search.BM25Similarity" + }, + ["semantic"] = new + { + defaultConfiguration = "testconfig", + configurations = new object[] + { +new +{ +name = "testconfig", +prioritizedFields = new +{ +titleField = new +{ +fieldName = "category", +}, +prioritizedContentFields = new object[] +{ +new +{ +fieldName = "description", +} +}, +prioritizedKeywordsFields = new object[] +{ +new +{ +fieldName = "ownerId", +} +}, +}, +flightingOptIn = true, +} + }, + }, + ["vectorSearch"] = new + { + profiles = new object[] + { +new +{ +name = "config1", +algorithm = "cosine", +vectorizer = "openai", +compression = "mySQ8", +}, +new +{ +name = "config2", +algorithm = "euclidean", +vectorizer = "custom-web-api", +compression = "mySQ8", +}, +new +{ +name = "config3", +algorithm = "dotProduct", +vectorizer = "custom-web-api", +compression = "myBQC", +}, +new +{ +name = "config4", +algorithm = "dotProduct", +vectorizer = "custom-web-api", +compression = "myBQWithoutOriginals", +} + }, + algorithms = new object[] + { +new +{ +hnswParameters = new +{ +metric = "cosine", +}, +name = "cosine", +kind = "hnsw", +}, +new +{ +hnswParameters = new +{ +metric = "euclidean", +}, +name = "euclidean", +kind = "hnsw", +}, +new +{ +hnswParameters = new +{ +metric = "dotProduct", +}, +name = "dotProduct", +kind = "hnsw", +} + }, + vectorizers = new object[] + { +new +{ +azureOpenAIParameters = new +{ +resourceUri = "https://test-sample.openai.azure.com/", +deploymentId = "model", +apiKey = "api-key", +modelName = "text-embedding-3-large", +}, +name = "openai", +kind = "azureOpenAI", +}, +new +{ +customWebApiParameters = new +{ +uri = "https://my-custom-endpoint.org/", +httpHeaders = new +{ +header1 = "value1", +header2 = "value2", +}, +httpMethod = "POST", +timeout = "PT1M", +authResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", +authIdentity = new Dictionary +{ +["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" +}, +}, +name = "custom-web-api", +kind = "customWebApi", +}, +new +{ +amlParameters = new +{ +uri = "https://my-custom-endpoint.org/", +resourceId = "aml resource id", +timeout = "PT1M", +region = "aml region", +modelName = "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32", +}, +name = "aml", +kind = "aml", +} + }, + compressions = new object[] + { +new +{ +scalarQuantizationParameters = new +{ +quantizedDataType = "int8", +}, +name = "mySQ8", +kind = "scalarQuantization", +rescoringOptions = new +{ +enableRescoring = true, +defaultOversampling = 10, +rescoreStorageMethod = "preserveOriginals", +}, +truncationDimension = 2, +}, +new +{ +name = "myBQC", +kind = "binaryQuantization", +rescoringOptions = new +{ +enableRescoring = true, +defaultOversampling = 10, +rescoreStorageMethod = "preserveOriginals", +}, +truncationDimension = 2, +}, +new +{ +name = "myBQWithoutOriginals", +kind = "binaryQuantization", +rescoringOptions = new +{ +enableRescoring = true, +defaultOversampling = 10, +rescoreStorageMethod = "discardOriginals", +}, +truncationDimension = 2, +} + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" + }); + Response response = client.CreateOrUpdate("temp-preview-test", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexes_CreateOrUpdate_SearchServiceCreateOrUpdateIndex_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "temp-preview-test", + ["fields"] = new object[] + { +new +{ +name = "id", +type = "Edm.String", +key = true, +sortable = true, +}, +new +{ +name = "vector1", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 20, +vectorSearchProfile = "config1", +}, +new +{ +name = "vector1b", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 10, +vectorSearchProfile = "config2", +}, +new +{ +name = "vector2", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 5, +vectorSearchProfile = "config3", +}, +new +{ +name = "vector3", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 5, +vectorSearchProfile = "config3", +}, +new +{ +name = "vector22", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 10, +vectorSearchProfile = "config2", +}, +new +{ +name = "vector4", +type = "Collection(Edm.Single)", +retrievable = true, +searchable = true, +dimensions = 32, +vectorSearchProfile = "config4", +}, +new +{ +name = "name", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "en.lucene", +}, +new +{ +name = "description", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "standard.lucene", +}, +new +{ +name = "category", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "en.lucene", +}, +new +{ +name = "ownerId", +type = "Edm.String", +retrievable = true, +searchable = true, +filterable = true, +sortable = true, +facetable = true, +analyzer = "en.lucene", +}, +new +{ +name = "price", +type = "Edm.Double", +retrievable = true, +filterable = true, +sortable = true, +facetable = true, +} + }, + ["scoringProfiles"] = new object[] + { +new +{ +name = "stringFieldBoost", +text = new +{ +weights = new +{ +name = 3, +description = 1, +category = 2, +ownerId = 1, +}, +}, +functions = new object[] +{ +new +{ +tag = new +{ +tagsParameter = "categoryTag", +}, +type = "tag", +fieldName = "category", +boost = 2, +} +}, +} + }, + ["defaultScoringProfile"] = "stringFieldBoost", + ["corsOptions"] = new + { + allowedOrigins = new object[] + { +"https://www.example.com/foo" + }, + maxAgeInSeconds = 10L, + }, + ["suggesters"] = new object[] + { +new +{ +name = "sg", +searchMode = "analyzingInfixMatching", +sourceFields = new object[] +{ +"category", +"ownerId" +}, +} + }, + ["analyzers"] = new object[] + { +new Dictionary +{ +["tokenizer"] = "standard_v2", +["tokenFilters"] = new object[] +{ +"common_grams" +}, +["charFilters"] = new object[] +{ +"html_strip" +}, +["@odata.type"] = "#Microsoft.Azure.Search.CustomAnalyzer", +["name"] = "tagsAnalyzer" +} + }, + ["tokenizers"] = new object[] + { +new Dictionary +{ +["maxTokenLength"] = 100, +["@odata.type"] = "#Microsoft.Azure.Search.StandardTokenizerV2", +["name"] = "my_tokenizer" +} + }, + ["tokenFilters"] = new object[] + { +new Dictionary +{ +["preserveOriginal"] = false, +["@odata.type"] = "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", +["name"] = "my_tokenFilter" +} + }, + ["charFilters"] = new object[] + { +new Dictionary +{ +["mappings"] = new object[] +{ +".=>,", +"_=>-" +}, +["@odata.type"] = "#Microsoft.Azure.Search.MappingCharFilter", +["name"] = "my_mapping" +} + }, + ["normalizers"] = new object[] + { +new Dictionary +{ +["tokenFilters"] = new object[] +{ +"my_tokenFilter" +}, +["charFilters"] = new object[] +{ +"my_mapping" +}, +["@odata.type"] = "#Microsoft.Azure.Search.CustomNormalizer", +["name"] = "my_normalizer" +} + }, + ["similarity"] = new Dictionary + { + ["k1"] = 10, + ["b"] = 0.1, + ["@odata.type"] = "#Microsoft.Azure.Search.BM25Similarity" + }, + ["semantic"] = new + { + defaultConfiguration = "testconfig", + configurations = new object[] + { +new +{ +name = "testconfig", +prioritizedFields = new +{ +titleField = new +{ +fieldName = "category", +}, +prioritizedContentFields = new object[] +{ +new +{ +fieldName = "description", +} +}, +prioritizedKeywordsFields = new object[] +{ +new +{ +fieldName = "ownerId", +} +}, +}, +flightingOptIn = true, +} + }, + }, + ["vectorSearch"] = new + { + profiles = new object[] + { +new +{ +name = "config1", +algorithm = "cosine", +vectorizer = "openai", +compression = "mySQ8", +}, +new +{ +name = "config2", +algorithm = "euclidean", +vectorizer = "custom-web-api", +compression = "mySQ8", +}, +new +{ +name = "config3", +algorithm = "dotProduct", +vectorizer = "custom-web-api", +compression = "myBQC", +}, +new +{ +name = "config4", +algorithm = "dotProduct", +vectorizer = "custom-web-api", +compression = "myBQWithoutOriginals", +} + }, + algorithms = new object[] + { +new +{ +hnswParameters = new +{ +metric = "cosine", +}, +name = "cosine", +kind = "hnsw", +}, +new +{ +hnswParameters = new +{ +metric = "euclidean", +}, +name = "euclidean", +kind = "hnsw", +}, +new +{ +hnswParameters = new +{ +metric = "dotProduct", +}, +name = "dotProduct", +kind = "hnsw", +} + }, + vectorizers = new object[] + { +new +{ +azureOpenAIParameters = new +{ +resourceUri = "https://test-sample.openai.azure.com/", +deploymentId = "model", +apiKey = "api-key", +modelName = "text-embedding-3-large", +}, +name = "openai", +kind = "azureOpenAI", +}, +new +{ +customWebApiParameters = new +{ +uri = "https://my-custom-endpoint.org/", +httpHeaders = new +{ +header1 = "value1", +header2 = "value2", +}, +httpMethod = "POST", +timeout = "PT1M", +authResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", +authIdentity = new Dictionary +{ +["@odata.type"] = "#Microsoft.Azure.Search.DataNoneIdentity" +}, +}, +name = "custom-web-api", +kind = "customWebApi", +}, +new +{ +amlParameters = new +{ +uri = "https://my-custom-endpoint.org/", +resourceId = "aml resource id", +timeout = "PT1M", +region = "aml region", +modelName = "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32", +}, +name = "aml", +kind = "aml", +} + }, + compressions = new object[] + { +new +{ +scalarQuantizationParameters = new +{ +quantizedDataType = "int8", +}, +name = "mySQ8", +kind = "scalarQuantization", +rescoringOptions = new +{ +enableRescoring = true, +defaultOversampling = 10, +rescoreStorageMethod = "preserveOriginals", +}, +truncationDimension = 2, +}, +new +{ +name = "myBQC", +kind = "binaryQuantization", +rescoringOptions = new +{ +enableRescoring = true, +defaultOversampling = 10, +rescoreStorageMethod = "preserveOriginals", +}, +truncationDimension = 2, +}, +new +{ +name = "myBQWithoutOriginals", +kind = "binaryQuantization", +rescoringOptions = new +{ +enableRescoring = true, +defaultOversampling = 10, +rescoreStorageMethod = "discardOriginals", +}, +truncationDimension = 2, +} + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" + }); + Response response = await client.CreateOrUpdateAsync("temp-preview-test", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexes_CreateOrUpdate_SearchServiceCreateOrUpdateIndex_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + SearchIndex index = new SearchIndex("temp-preview-test", new SearchField[] + { +new SearchField("id", SearchFieldDataType.String) +{ +Key = true, +Sortable = true, +}, +new SearchField("vector1", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 20, +VectorSearchProfile = "config1", +}, +new SearchField("vector1b", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 10, +VectorSearchProfile = "config2", +}, +new SearchField("vector2", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 5, +VectorSearchProfile = "config3", +}, +new SearchField("vector3", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 5, +VectorSearchProfile = "config3", +}, +new SearchField("vector22", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 10, +VectorSearchProfile = "config2", +}, +new SearchField("vector4", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 32, +VectorSearchProfile = "config4", +}, +new SearchField("name", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.EnLucene, +}, +new SearchField("description", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.StandardLucene, +}, +new SearchField("category", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.EnLucene, +}, +new SearchField("ownerId", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.EnLucene, +}, +new SearchField("price", SearchFieldDataType.Double) +{ +Retrievable = true, +Filterable = true, +Sortable = true, +Facetable = true, +} + }) + { + ScoringProfiles = {new ScoringProfile("stringFieldBoost") +{ +Text = new TextWeights(new Dictionary +{ +["name"] = 3, +["description"] = 1, +["category"] = 2, +["ownerId"] = 1 +}), +Functions = {new TagScoringFunction("category", 2, new TagScoringParameters("categoryTag"))}, +}}, + DefaultScoringProfile = "stringFieldBoost", + CorsOptions = new CorsOptions(new string[] { "https://www.example.com/foo" }) + { + MaxAgeInSeconds = 10L, + }, + Suggesters = { new SearchSuggester("sg", new string[] { "category", "ownerId" }) }, + Analyzers = {new CustomAnalyzer("tagsAnalyzer", LexicalTokenizerName.Standard) +{ +TokenFilters = {TokenFilterName.CommonGram}, +CharFilters = {CharFilterName.HtmlStrip}, +}}, + Tokenizers = {new LuceneStandardTokenizerV2("my_tokenizer") +{ +MaxTokenLength = 100, +}}, + TokenFilters = {new AsciiFoldingTokenFilter("my_tokenFilter") +{ +PreserveOriginal = false, +}}, + CharFilters = { new MappingCharFilter("my_mapping", new string[] { ".=>,", "_=>-" }) }, + Normalizers = {new CustomNormalizer("my_normalizer") +{ +TokenFilters = {new TokenFilterName("my_tokenFilter")}, +CharFilters = {new CharFilterName("my_mapping")}, +}}, + Similarity = new BM25SimilarityAlgorithm + { + K1 = 10, + B = 0.1, + }, + Semantic = new SemanticSearch + { + DefaultConfiguration = "testconfig", + Configurations = {new SemanticConfiguration("testconfig", new SemanticPrioritizedFields +{ +TitleField = new SemanticField("category"), +PrioritizedContentFields = {new SemanticField("description")}, +PrioritizedKeywordsFields = {new SemanticField("ownerId")}, +}) +{ +FlightingOptIn = true, +}}, + }, + VectorSearch = new VectorSearch + { + Profiles = {new VectorSearchProfile("config1", "cosine") +{ +Vectorizer = "openai", +Compression = "mySQ8", +}, new VectorSearchProfile("config2", "euclidean") +{ +Vectorizer = "custom-web-api", +Compression = "mySQ8", +}, new VectorSearchProfile("config3", "dotProduct") +{ +Vectorizer = "custom-web-api", +Compression = "myBQC", +}, new VectorSearchProfile("config4", "dotProduct") +{ +Vectorizer = "custom-web-api", +Compression = "myBQWithoutOriginals", +}}, + Algorithms = {new HnswAlgorithmConfiguration("cosine") +{ +HnswParameters = new HnswParameters +{ +Metric = VectorSearchAlgorithmMetric.Cosine, +}, +}, new HnswAlgorithmConfiguration("euclidean") +{ +HnswParameters = new HnswParameters +{ +Metric = VectorSearchAlgorithmMetric.Euclidean, +}, +}, new HnswAlgorithmConfiguration("dotProduct") +{ +HnswParameters = new HnswParameters +{ +Metric = VectorSearchAlgorithmMetric.DotProduct, +}, +}}, + Vectorizers = {new AzureOpenAIVectorizer("openai") +{ +AzureOpenAIParameters = new AzureOpenAIVectorizerParameters +{ +ResourceUri = new Uri("https://test-sample.openai.azure.com/"), +DeploymentId = "model", +ApiKey = "api-key", +ModelName = AzureOpenAIModelName.TextEmbedding3Large, +}, +}, new WebApiVectorizer("custom-web-api") +{ +CustomWebApiParameters = new WebApiVectorizerParameters +{ +Uri = new Uri("https://my-custom-endpoint.org/"), +HttpHeaders = +{ +["header1"] = "value1", +["header2"] = "value2" +}, +HttpMethod = "POST", +Timeout = XmlConvert.ToTimeSpan("PT1M"), +AuthResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", +AuthIdentity = new SearchIndexerDataNoneIdentity(), +}, +}, new AMLVectorizer("aml") +{ +AmlParameters = new AMLParameters(new Uri("https://my-custom-endpoint.org/")) +{ +ResourceId = "aml resource id", +Timeout = XmlConvert.ToTimeSpan("PT1M"), +Region = "aml region", +ModelName = AIFoundryModelCatalogName.OpenAICLIPImageTextEmbeddingsVitBasePatch32, +}, +}}, + Compressions = {new ScalarQuantizationCompression("mySQ8") +{ +ScalarQuantizationParameters = new ScalarQuantizationParameters +{ +QuantizedDataType = VectorSearchCompressionTarget.Int8, +}, +RescoringOptions = new RescoringOptions +{ +EnableRescoring = true, +DefaultOversampling = 10, +RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, +}, +TruncationDimension = 2, +}, new BinaryQuantizationCompression("myBQC") +{ +RescoringOptions = new RescoringOptions +{ +EnableRescoring = true, +DefaultOversampling = 10, +RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, +}, +TruncationDimension = 2, +}, new BinaryQuantizationCompression("myBQWithoutOriginals") +{ +RescoringOptions = new RescoringOptions +{ +EnableRescoring = true, +DefaultOversampling = 10, +RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.DiscardOriginals, +}, +TruncationDimension = 2, +}}, + }, + ETag = "0x1234568AE7E58A1", + }; + Response response = client.CreateOrUpdate("temp-preview-test", index); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexes_CreateOrUpdate_SearchServiceCreateOrUpdateIndex_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + SearchIndex index = new SearchIndex("temp-preview-test", new SearchField[] + { +new SearchField("id", SearchFieldDataType.String) +{ +Key = true, +Sortable = true, +}, +new SearchField("vector1", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 20, +VectorSearchProfile = "config1", +}, +new SearchField("vector1b", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 10, +VectorSearchProfile = "config2", +}, +new SearchField("vector2", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 5, +VectorSearchProfile = "config3", +}, +new SearchField("vector3", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 5, +VectorSearchProfile = "config3", +}, +new SearchField("vector22", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 10, +VectorSearchProfile = "config2", +}, +new SearchField("vector4", new SearchFieldDataType("Collection(Edm.Single)")) +{ +Retrievable = true, +Searchable = true, +Dimensions = 32, +VectorSearchProfile = "config4", +}, +new SearchField("name", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.EnLucene, +}, +new SearchField("description", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.StandardLucene, +}, +new SearchField("category", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.EnLucene, +}, +new SearchField("ownerId", SearchFieldDataType.String) +{ +Retrievable = true, +Searchable = true, +Filterable = true, +Sortable = true, +Facetable = true, +Analyzer = LexicalAnalyzerName.EnLucene, +}, +new SearchField("price", SearchFieldDataType.Double) +{ +Retrievable = true, +Filterable = true, +Sortable = true, +Facetable = true, +} + }) + { + ScoringProfiles = {new ScoringProfile("stringFieldBoost") +{ +Text = new TextWeights(new Dictionary +{ +["name"] = 3, +["description"] = 1, +["category"] = 2, +["ownerId"] = 1 +}), +Functions = {new TagScoringFunction("category", 2, new TagScoringParameters("categoryTag"))}, +}}, + DefaultScoringProfile = "stringFieldBoost", + CorsOptions = new CorsOptions(new string[] { "https://www.example.com/foo" }) + { + MaxAgeInSeconds = 10L, + }, + Suggesters = { new SearchSuggester("sg", new string[] { "category", "ownerId" }) }, + Analyzers = {new CustomAnalyzer("tagsAnalyzer", LexicalTokenizerName.Standard) +{ +TokenFilters = {TokenFilterName.CommonGram}, +CharFilters = {CharFilterName.HtmlStrip}, +}}, + Tokenizers = {new LuceneStandardTokenizerV2("my_tokenizer") +{ +MaxTokenLength = 100, +}}, + TokenFilters = {new AsciiFoldingTokenFilter("my_tokenFilter") +{ +PreserveOriginal = false, +}}, + CharFilters = { new MappingCharFilter("my_mapping", new string[] { ".=>,", "_=>-" }) }, + Normalizers = {new CustomNormalizer("my_normalizer") +{ +TokenFilters = {new TokenFilterName("my_tokenFilter")}, +CharFilters = {new CharFilterName("my_mapping")}, +}}, + Similarity = new BM25SimilarityAlgorithm + { + K1 = 10, + B = 0.1, + }, + Semantic = new SemanticSearch + { + DefaultConfiguration = "testconfig", + Configurations = {new SemanticConfiguration("testconfig", new SemanticPrioritizedFields +{ +TitleField = new SemanticField("category"), +PrioritizedContentFields = {new SemanticField("description")}, +PrioritizedKeywordsFields = {new SemanticField("ownerId")}, +}) +{ +FlightingOptIn = true, +}}, + }, + VectorSearch = new VectorSearch + { + Profiles = {new VectorSearchProfile("config1", "cosine") +{ +Vectorizer = "openai", +Compression = "mySQ8", +}, new VectorSearchProfile("config2", "euclidean") +{ +Vectorizer = "custom-web-api", +Compression = "mySQ8", +}, new VectorSearchProfile("config3", "dotProduct") +{ +Vectorizer = "custom-web-api", +Compression = "myBQC", +}, new VectorSearchProfile("config4", "dotProduct") +{ +Vectorizer = "custom-web-api", +Compression = "myBQWithoutOriginals", +}}, + Algorithms = {new HnswAlgorithmConfiguration("cosine") +{ +HnswParameters = new HnswParameters +{ +Metric = VectorSearchAlgorithmMetric.Cosine, +}, +}, new HnswAlgorithmConfiguration("euclidean") +{ +HnswParameters = new HnswParameters +{ +Metric = VectorSearchAlgorithmMetric.Euclidean, +}, +}, new HnswAlgorithmConfiguration("dotProduct") +{ +HnswParameters = new HnswParameters +{ +Metric = VectorSearchAlgorithmMetric.DotProduct, +}, +}}, + Vectorizers = {new AzureOpenAIVectorizer("openai") +{ +AzureOpenAIParameters = new AzureOpenAIVectorizerParameters +{ +ResourceUri = new Uri("https://test-sample.openai.azure.com/"), +DeploymentId = "model", +ApiKey = "api-key", +ModelName = AzureOpenAIModelName.TextEmbedding3Large, +}, +}, new WebApiVectorizer("custom-web-api") +{ +CustomWebApiParameters = new WebApiVectorizerParameters +{ +Uri = new Uri("https://my-custom-endpoint.org/"), +HttpHeaders = +{ +["header1"] = "value1", +["header2"] = "value2" +}, +HttpMethod = "POST", +Timeout = XmlConvert.ToTimeSpan("PT1M"), +AuthResourceId = "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b", +AuthIdentity = new SearchIndexerDataNoneIdentity(), +}, +}, new AMLVectorizer("aml") +{ +AmlParameters = new AMLParameters(new Uri("https://my-custom-endpoint.org/")) +{ +ResourceId = "aml resource id", +Timeout = XmlConvert.ToTimeSpan("PT1M"), +Region = "aml region", +ModelName = AIFoundryModelCatalogName.OpenAICLIPImageTextEmbeddingsVitBasePatch32, +}, +}}, + Compressions = {new ScalarQuantizationCompression("mySQ8") +{ +ScalarQuantizationParameters = new ScalarQuantizationParameters +{ +QuantizedDataType = VectorSearchCompressionTarget.Int8, +}, +RescoringOptions = new RescoringOptions +{ +EnableRescoring = true, +DefaultOversampling = 10, +RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, +}, +TruncationDimension = 2, +}, new BinaryQuantizationCompression("myBQC") +{ +RescoringOptions = new RescoringOptions +{ +EnableRescoring = true, +DefaultOversampling = 10, +RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.PreserveOriginals, +}, +TruncationDimension = 2, +}, new BinaryQuantizationCompression("myBQWithoutOriginals") +{ +RescoringOptions = new RescoringOptions +{ +EnableRescoring = true, +DefaultOversampling = 10, +RescoreStorageMethod = VectorSearchCompressionRescoreStorageMethod.DiscardOriginals, +}, +TruncationDimension = 2, +}}, + }, + ETag = "0x1234568AE7E58A1", + }; + Response response = await client.CreateOrUpdateAsync("temp-preview-test", index); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexes_Delete_SearchServiceDeleteIndex() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + Response response = client.Delete("temp-preview-test"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexes_Delete_SearchServiceDeleteIndex_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + Response response = await client.DeleteAsync("temp-preview-test"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexes_GetIndex_SearchServiceGetIndex() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + Response response = client.GetIndex("preview-test", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexes_GetIndex_SearchServiceGetIndex_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + Response response = await client.GetIndexAsync("preview-test", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexes_GetIndex_SearchServiceGetIndex_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + Response response = client.GetIndex("preview-test"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexes_GetIndex_SearchServiceGetIndex_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + Response response = await client.GetIndexAsync("preview-test"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexes_GetStatistics_SearchServiceGetIndexStatistics() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + Response response = client.GetStatistics("preview-test", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("documentCount").ToString()); + Console.WriteLine(result.GetProperty("storageSize").ToString()); + Console.WriteLine(result.GetProperty("vectorIndexSize").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexes_GetStatistics_SearchServiceGetIndexStatistics_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + Response response = await client.GetStatisticsAsync("preview-test", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("documentCount").ToString()); + Console.WriteLine(result.GetProperty("storageSize").ToString()); + Console.WriteLine(result.GetProperty("vectorIndexSize").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexes_GetStatistics_SearchServiceGetIndexStatistics_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + Response response = client.GetStatistics("preview-test"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexes_GetStatistics_SearchServiceGetIndexStatistics_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + Response response = await client.GetStatisticsAsync("preview-test"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexes_Analyze_SearchServiceIndexAnalyze() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + using RequestContent content = RequestContent.Create(new + { + text = "Text to analyze", + analyzer = "ar.lucene", + }); + Response response = client.Analyze("preview-test", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("token").ToString()); + Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("startOffset").ToString()); + Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("endOffset").ToString()); + Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("position").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexes_Analyze_SearchServiceIndexAnalyze_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + using RequestContent content = RequestContent.Create(new + { + text = "Text to analyze", + analyzer = "ar.lucene", + }); + Response response = await client.AnalyzeAsync("preview-test", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("token").ToString()); + Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("startOffset").ToString()); + Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("endOffset").ToString()); + Console.WriteLine(result.GetProperty("tokens")[0].GetProperty("position").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexes_Analyze_SearchServiceIndexAnalyze_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + AnalyzeRequest request = new AnalyzeRequest("Text to analyze") + { + Analyzer = LexicalAnalyzerName.ArLucene, + }; + Response response = client.Analyze("preview-test", request); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexes_Analyze_SearchServiceIndexAnalyze_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + AnalyzeRequest request = new AnalyzeRequest("Text to analyze") + { + Analyzer = LexicalAnalyzerName.ArLucene, + }; + Response response = await client.AnalyzeAsync("preview-test", request); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexes_GetIndexes_SearchServiceListIndexes() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + foreach (BinaryData item in client.GetIndexes(null, null)) + { + JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); + } + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexes_GetIndexes_SearchServiceListIndexes_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + await foreach (BinaryData item in client.GetIndexesAsync(null, null)) + { + JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("fields")[0].GetProperty("type").ToString()); + } + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Indexes_GetIndexes_SearchServiceListIndexes_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + foreach (SearchIndex item in client.GetIndexes()) + { + } + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Indexes_GetIndexes_SearchServiceListIndexes_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Indexes client = new SearchClient(endpoint, credential).GetIndexesClient(); + + await foreach (SearchIndex item in client.GetIndexesAsync()) + { + } + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_SearchClient.cs b/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_SearchClient.cs new file mode 100644 index 000000000000..b721efc7d630 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_SearchClient.cs @@ -0,0 +1,146 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Text.Json; +using System.Threading.Tasks; +using Azure.Identity; +using NUnit.Framework; + +namespace Azure.Search.Documents.Indexes.Samples +{ + public partial class Samples_SearchClient + { + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Search_GetServiceStatistics_SearchServiceGetServiceStatistics() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SearchClient client = new SearchClient(endpoint, credential); + + Response response = client.GetServiceStatistics(null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("counters").GetProperty("aliasesCount").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("documentCount").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("indexesCount").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("indexersCount").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("dataSourcesCount").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("storageSize").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("synonymMaps").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("skillsetCount").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("vectorIndexSize").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("limits").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Search_GetServiceStatistics_SearchServiceGetServiceStatistics_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SearchClient client = new SearchClient(endpoint, credential); + + Response response = await client.GetServiceStatisticsAsync(null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("counters").GetProperty("aliasesCount").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("documentCount").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("indexesCount").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("indexersCount").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("dataSourcesCount").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("storageSize").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("synonymMaps").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("skillsetCount").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("counters").GetProperty("vectorIndexSize").GetProperty("usage").ToString()); + Console.WriteLine(result.GetProperty("limits").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Search_GetServiceStatistics_SearchServiceGetServiceStatistics_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SearchClient client = new SearchClient(endpoint, credential); + + Response response = client.GetServiceStatistics(); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Search_GetServiceStatistics_SearchServiceGetServiceStatistics_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SearchClient client = new SearchClient(endpoint, credential); + + Response response = await client.GetServiceStatisticsAsync(); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Search_GetIndexStatsSummary_SearchServiceGetIndexStatsSummary() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SearchClient client = new SearchClient(endpoint, credential); + + foreach (BinaryData item in client.GetIndexStatsSummary(null)) + { + JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("documentCount").ToString()); + Console.WriteLine(result.GetProperty("storageSize").ToString()); + } + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Search_GetIndexStatsSummary_SearchServiceGetIndexStatsSummary_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SearchClient client = new SearchClient(endpoint, credential); + + await foreach (BinaryData item in client.GetIndexStatsSummaryAsync(null)) + { + JsonElement result = JsonDocument.Parse(item.ToStream()).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("documentCount").ToString()); + Console.WriteLine(result.GetProperty("storageSize").ToString()); + } + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Search_GetIndexStatsSummary_SearchServiceGetIndexStatsSummary_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SearchClient client = new SearchClient(endpoint, credential); + + foreach (IndexStatisticsSummary item in client.GetIndexStatsSummary()) + { + } + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Search_GetIndexStatsSummary_SearchServiceGetIndexStatsSummary_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SearchClient client = new SearchClient(endpoint, credential); + + await foreach (IndexStatisticsSummary item in client.GetIndexStatsSummaryAsync()) + { + } + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_Skillsets.cs b/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_Skillsets.cs new file mode 100644 index 000000000000..b4e07ace4038 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_Skillsets.cs @@ -0,0 +1,1545 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Text.Json; +using System.Threading.Tasks; +using System.Xml; +using Azure.Core; +using Azure.Identity; +using NUnit.Framework; + +namespace Azure.Search.Documents.Indexes.Samples +{ + public partial class Samples_Skillsets + { + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Skillsets_CreateOrUpdate_SearchServiceCreateOrUpdateSkillset() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "tempskillset", + ["description"] = "Skillset for extracting entities and more", + ["skills"] = new object[] + { +new Dictionary +{ +["@odata.type"] = "#Microsoft.Skills.Text.LanguageDetectionSkill", +["name"] = "skill2", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "countryHint", +source = "/document/countryHint", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "languageCode", +targetName = "languageCode", +} +} +}, +new Dictionary +{ +["textSplitMode"] = "pages", +["maximumPageLength"] = 4000, +["unit"] = "azureOpenAITokens", +["azureOpenAITokenizerParameters"] = new +{ +encoderModelName = "cl100k_base", +allowedSpecialTokens = new object[] +{ +"[START]", +"[END]" +}, +}, +["@odata.type"] = "#Microsoft.Skills.Text.SplitSkill", +["name"] = "skill3", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "languageCode", +source = "/document/languageCode", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "textItems", +targetName = "pages", +} +} +}, +new Dictionary +{ +["@odata.type"] = "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", +["name"] = "skill4", +["context"] = "/document/pages/*", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "languageCode", +source = "/document/languageCode", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "keyPhrases", +targetName = "keyPhrases", +} +} +}, +new Dictionary +{ +["uri"] = "https://contoso.example.org/", +["httpMethod"] = "POST", +["timeout"] = "PT5S", +["@odata.type"] = "#Microsoft.Skills.Custom.WebApiSkill", +["name"] = "skill5", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "languageCode", +source = "/document/languageCode", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "customresult", +targetName = "result", +} +} +}, +new Dictionary +{ +["outputMode"] = "oneToMany", +["markdownHeaderDepth"] = "h3", +["@odata.type"] = "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", +["name"] = "docIntelligenceLayoutSkill", +["context"] = "/document", +["inputs"] = new object[] +{ +new +{ +name = "file_data", +source = "/document/content", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "markdown_document", +targetName = "markdown_document", +} +} +} + }, + ["cognitiveServices"] = new Dictionary + { + ["key"] = "myKey", + ["subdomainUrl"] = "https://mySubdomainName.cognitiveservices.azure.com", + ["@odata.type"] = "#Microsoft.Azure.Search.AIServicesByKey", + ["description"] = "Description of the Azure AI service resource attached to a skillset" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } + }); + Response response = client.CreateOrUpdate("tempskillset", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("@odata.type").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Skillsets_CreateOrUpdate_SearchServiceCreateOrUpdateSkillset_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "tempskillset", + ["description"] = "Skillset for extracting entities and more", + ["skills"] = new object[] + { +new Dictionary +{ +["@odata.type"] = "#Microsoft.Skills.Text.LanguageDetectionSkill", +["name"] = "skill2", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "countryHint", +source = "/document/countryHint", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "languageCode", +targetName = "languageCode", +} +} +}, +new Dictionary +{ +["textSplitMode"] = "pages", +["maximumPageLength"] = 4000, +["unit"] = "azureOpenAITokens", +["azureOpenAITokenizerParameters"] = new +{ +encoderModelName = "cl100k_base", +allowedSpecialTokens = new object[] +{ +"[START]", +"[END]" +}, +}, +["@odata.type"] = "#Microsoft.Skills.Text.SplitSkill", +["name"] = "skill3", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "languageCode", +source = "/document/languageCode", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "textItems", +targetName = "pages", +} +} +}, +new Dictionary +{ +["@odata.type"] = "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", +["name"] = "skill4", +["context"] = "/document/pages/*", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "languageCode", +source = "/document/languageCode", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "keyPhrases", +targetName = "keyPhrases", +} +} +}, +new Dictionary +{ +["uri"] = "https://contoso.example.org/", +["httpMethod"] = "POST", +["timeout"] = "PT5S", +["@odata.type"] = "#Microsoft.Skills.Custom.WebApiSkill", +["name"] = "skill5", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "languageCode", +source = "/document/languageCode", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "customresult", +targetName = "result", +} +} +}, +new Dictionary +{ +["outputMode"] = "oneToMany", +["markdownHeaderDepth"] = "h3", +["@odata.type"] = "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", +["name"] = "docIntelligenceLayoutSkill", +["context"] = "/document", +["inputs"] = new object[] +{ +new +{ +name = "file_data", +source = "/document/content", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "markdown_document", +targetName = "markdown_document", +} +} +} + }, + ["cognitiveServices"] = new Dictionary + { + ["key"] = "myKey", + ["subdomainUrl"] = "https://mySubdomainName.cognitiveservices.azure.com", + ["@odata.type"] = "#Microsoft.Azure.Search.AIServicesByKey", + ["description"] = "Description of the Azure AI service resource attached to a skillset" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } + }); + Response response = await client.CreateOrUpdateAsync("tempskillset", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("@odata.type").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Skillsets_CreateOrUpdate_SearchServiceCreateOrUpdateSkillset_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + SearchIndexerSkillset skillset = new SearchIndexerSkillset("tempskillset", new SearchIndexerSkill[] + { +new LanguageDetectionSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("countryHint") +{ +Source = "/document/countryHint", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("languageCode") +{ +TargetName = "languageCode", +} +}) +{ +Name = "skill2", +}, +new SplitSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("languageCode") +{ +Source = "/document/languageCode", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("textItems") +{ +TargetName = "pages", +} +}) +{ +TextSplitMode = TextSplitMode.Pages, +MaximumPageLength = 4000, +Unit = SplitSkillUnit.AzureOpenAITokens, +AzureOpenAITokenizerParameters = new AzureOpenAITokenizerParameters +{ +EncoderModelName = SplitSkillEncoderModelName.CL100kBase, +AllowedSpecialTokens = {"[START]", "[END]"}, +}, +Name = "skill3", +}, +new KeyPhraseExtractionSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("languageCode") +{ +Source = "/document/languageCode", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("keyPhrases") +{ +TargetName = "keyPhrases", +} +}) +{ +Name = "skill4", +Context = "/document/pages/*", +}, +new WebApiSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("languageCode") +{ +Source = "/document/languageCode", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("customresult") +{ +TargetName = "result", +} +}, "https://contoso.example.org/") +{ +HttpMethod = "POST", +Timeout = XmlConvert.ToTimeSpan("PT5S"), +Name = "skill5", +}, +new DocumentIntelligenceLayoutSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("file_data") +{ +Source = "/document/content", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("markdown_document") +{ +TargetName = "markdown_document", +} +}) +{ +OutputMode = DocumentIntelligenceLayoutSkillOutputMode.OneToMany, +MarkdownHeaderDepth = DocumentIntelligenceLayoutSkillMarkdownHeaderDepth.H3, +Name = "docIntelligenceLayoutSkill", +Context = "/document", +} + }) + { + Description = "Skillset for extracting entities and more", + CognitiveServices = new AIServicesAccountKey("myKey", "https://mySubdomainName.cognitiveservices.azure.com") + { + Description = "Description of the Azure AI service resource attached to a skillset", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + }; + Response response = client.CreateOrUpdate("tempskillset", skillset); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Skillsets_CreateOrUpdate_SearchServiceCreateOrUpdateSkillset_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + SearchIndexerSkillset skillset = new SearchIndexerSkillset("tempskillset", new SearchIndexerSkill[] + { +new LanguageDetectionSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("countryHint") +{ +Source = "/document/countryHint", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("languageCode") +{ +TargetName = "languageCode", +} +}) +{ +Name = "skill2", +}, +new SplitSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("languageCode") +{ +Source = "/document/languageCode", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("textItems") +{ +TargetName = "pages", +} +}) +{ +TextSplitMode = TextSplitMode.Pages, +MaximumPageLength = 4000, +Unit = SplitSkillUnit.AzureOpenAITokens, +AzureOpenAITokenizerParameters = new AzureOpenAITokenizerParameters +{ +EncoderModelName = SplitSkillEncoderModelName.CL100kBase, +AllowedSpecialTokens = {"[START]", "[END]"}, +}, +Name = "skill3", +}, +new KeyPhraseExtractionSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("languageCode") +{ +Source = "/document/languageCode", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("keyPhrases") +{ +TargetName = "keyPhrases", +} +}) +{ +Name = "skill4", +Context = "/document/pages/*", +}, +new WebApiSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("languageCode") +{ +Source = "/document/languageCode", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("customresult") +{ +TargetName = "result", +} +}, "https://contoso.example.org/") +{ +HttpMethod = "POST", +Timeout = XmlConvert.ToTimeSpan("PT5S"), +Name = "skill5", +}, +new DocumentIntelligenceLayoutSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("file_data") +{ +Source = "/document/content", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("markdown_document") +{ +TargetName = "markdown_document", +} +}) +{ +OutputMode = DocumentIntelligenceLayoutSkillOutputMode.OneToMany, +MarkdownHeaderDepth = DocumentIntelligenceLayoutSkillMarkdownHeaderDepth.H3, +Name = "docIntelligenceLayoutSkill", +Context = "/document", +} + }) + { + Description = "Skillset for extracting entities and more", + CognitiveServices = new AIServicesAccountKey("myKey", "https://mySubdomainName.cognitiveservices.azure.com") + { + Description = "Description of the Azure AI service resource attached to a skillset", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + }; + Response response = await client.CreateOrUpdateAsync("tempskillset", skillset); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Skillsets_Delete_SearchServiceDeleteSkillset() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + Response response = client.Delete("tempskillset"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Skillsets_Delete_SearchServiceDeleteSkillset_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + Response response = await client.DeleteAsync("tempskillset"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Skillsets_GetSkillset_SearchServiceGetSkillset() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + Response response = client.GetSkillset("myskillset", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("@odata.type").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Skillsets_GetSkillset_SearchServiceGetSkillset_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + Response response = await client.GetSkillsetAsync("myskillset", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("@odata.type").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Skillsets_GetSkillset_SearchServiceGetSkillset_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + Response response = client.GetSkillset("myskillset"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Skillsets_GetSkillset_SearchServiceGetSkillset_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + Response response = await client.GetSkillsetAsync("myskillset"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Skillsets_GetSkillsets_SearchServiceListSkillsets() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + Response response = client.GetSkillsets(null, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("skills")[0].GetProperty("@odata.type").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Skillsets_GetSkillsets_SearchServiceListSkillsets_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + Response response = await client.GetSkillsetsAsync(null, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("skills")[0].GetProperty("@odata.type").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Skillsets_GetSkillsets_SearchServiceListSkillsets_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + Response response = client.GetSkillsets(); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Skillsets_GetSkillsets_SearchServiceListSkillsets_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + Response response = await client.GetSkillsetsAsync(); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Skillsets_Create_SearchServiceCreateSkillset() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "tempskillset", + ["description"] = "Skillset for extracting entities and more", + ["skills"] = new object[] + { +new Dictionary +{ +["@odata.type"] = "#Microsoft.Skills.Text.LanguageDetectionSkill", +["name"] = "skill2", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "countryHint", +source = "/document/countryHint", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "languageCode", +targetName = "languageCode", +} +} +}, +new Dictionary +{ +["textSplitMode"] = "pages", +["maximumPageLength"] = 4000, +["unit"] = "azureOpenAITokens", +["azureOpenAITokenizerParameters"] = new +{ +encoderModelName = "cl100k_base", +allowedSpecialTokens = new object[] +{ +"[START]", +"[END]" +}, +}, +["@odata.type"] = "#Microsoft.Skills.Text.SplitSkill", +["name"] = "skill3", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "languageCode", +source = "/document/languageCode", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "textItems", +targetName = "pages", +} +} +}, +new Dictionary +{ +["@odata.type"] = "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", +["name"] = "skill4", +["context"] = "/document/pages/*", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "languageCode", +source = "/document/languageCode", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "keyPhrases", +targetName = "keyPhrases", +} +} +}, +new Dictionary +{ +["uri"] = "https://contoso.example.org/", +["httpMethod"] = "POST", +["timeout"] = "PT5S", +["@odata.type"] = "#Microsoft.Skills.Custom.WebApiSkill", +["name"] = "skill5", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "languageCode", +source = "/document/languageCode", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "customresult", +targetName = "result", +} +} +}, +new Dictionary +{ +["outputMode"] = "oneToMany", +["markdownHeaderDepth"] = "h3", +["@odata.type"] = "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", +["name"] = "docIntelligenceLayoutSkill", +["context"] = "/document", +["inputs"] = new object[] +{ +new +{ +name = "file_data", +source = "/document/content", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "markdown_document", +targetName = "markdown_document", +} +} +} + }, + ["cognitiveServices"] = new Dictionary + { + ["key"] = "myKey", + ["subdomainUrl"] = "https://mySubdomainName.cognitiveservices.azure.com", + ["@odata.type"] = "#Microsoft.Azure.Search.AIServicesByKey", + ["description"] = "Description of the Azure AI service resource attached to a skillset" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } + }); + Response response = client.Create(content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("@odata.type").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Skillsets_Create_SearchServiceCreateSkillset_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "tempskillset", + ["description"] = "Skillset for extracting entities and more", + ["skills"] = new object[] + { +new Dictionary +{ +["@odata.type"] = "#Microsoft.Skills.Text.LanguageDetectionSkill", +["name"] = "skill2", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "countryHint", +source = "/document/countryHint", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "languageCode", +targetName = "languageCode", +} +} +}, +new Dictionary +{ +["textSplitMode"] = "pages", +["maximumPageLength"] = 4000, +["unit"] = "azureOpenAITokens", +["azureOpenAITokenizerParameters"] = new +{ +encoderModelName = "cl100k_base", +allowedSpecialTokens = new object[] +{ +"[START]", +"[END]" +}, +}, +["@odata.type"] = "#Microsoft.Skills.Text.SplitSkill", +["name"] = "skill3", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "languageCode", +source = "/document/languageCode", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "textItems", +targetName = "pages", +} +} +}, +new Dictionary +{ +["@odata.type"] = "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", +["name"] = "skill4", +["context"] = "/document/pages/*", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "languageCode", +source = "/document/languageCode", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "keyPhrases", +targetName = "keyPhrases", +} +} +}, +new Dictionary +{ +["uri"] = "https://contoso.example.org/", +["httpMethod"] = "POST", +["timeout"] = "PT5S", +["@odata.type"] = "#Microsoft.Skills.Custom.WebApiSkill", +["name"] = "skill5", +["inputs"] = new object[] +{ +new +{ +name = "text", +source = "/document/content", +}, +new +{ +name = "languageCode", +source = "/document/languageCode", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "customresult", +targetName = "result", +} +} +}, +new Dictionary +{ +["outputMode"] = "oneToMany", +["markdownHeaderDepth"] = "h3", +["@odata.type"] = "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", +["name"] = "docIntelligenceLayoutSkill", +["context"] = "/document", +["inputs"] = new object[] +{ +new +{ +name = "file_data", +source = "/document/content", +} +}, +["outputs"] = new object[] +{ +new +{ +name = "markdown_document", +targetName = "markdown_document", +} +} +} + }, + ["cognitiveServices"] = new Dictionary + { + ["key"] = "myKey", + ["subdomainUrl"] = "https://mySubdomainName.cognitiveservices.azure.com", + ["@odata.type"] = "#Microsoft.Azure.Search.AIServicesByKey", + ["description"] = "Description of the Azure AI service resource attached to a skillset" + }, + ["@odata.etag"] = "0x1234568AE7E58A1", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + } + }); + Response response = await client.CreateAsync(content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("@odata.type").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("inputs")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("skills")[0].GetProperty("outputs")[0].GetProperty("name").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Skillsets_Create_SearchServiceCreateSkillset_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + SearchIndexerSkillset skillset = new SearchIndexerSkillset("tempskillset", new SearchIndexerSkill[] + { +new LanguageDetectionSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("countryHint") +{ +Source = "/document/countryHint", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("languageCode") +{ +TargetName = "languageCode", +} +}) +{ +Name = "skill2", +}, +new SplitSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("languageCode") +{ +Source = "/document/languageCode", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("textItems") +{ +TargetName = "pages", +} +}) +{ +TextSplitMode = TextSplitMode.Pages, +MaximumPageLength = 4000, +Unit = SplitSkillUnit.AzureOpenAITokens, +AzureOpenAITokenizerParameters = new AzureOpenAITokenizerParameters +{ +EncoderModelName = SplitSkillEncoderModelName.CL100kBase, +AllowedSpecialTokens = {"[START]", "[END]"}, +}, +Name = "skill3", +}, +new KeyPhraseExtractionSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("languageCode") +{ +Source = "/document/languageCode", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("keyPhrases") +{ +TargetName = "keyPhrases", +} +}) +{ +Name = "skill4", +Context = "/document/pages/*", +}, +new WebApiSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("languageCode") +{ +Source = "/document/languageCode", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("customresult") +{ +TargetName = "result", +} +}, "https://contoso.example.org/") +{ +HttpMethod = "POST", +Timeout = XmlConvert.ToTimeSpan("PT5S"), +Name = "skill5", +}, +new DocumentIntelligenceLayoutSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("file_data") +{ +Source = "/document/content", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("markdown_document") +{ +TargetName = "markdown_document", +} +}) +{ +OutputMode = DocumentIntelligenceLayoutSkillOutputMode.OneToMany, +MarkdownHeaderDepth = DocumentIntelligenceLayoutSkillMarkdownHeaderDepth.H3, +Name = "docIntelligenceLayoutSkill", +Context = "/document", +} + }) + { + Description = "Skillset for extracting entities and more", + CognitiveServices = new AIServicesAccountKey("myKey", "https://mySubdomainName.cognitiveservices.azure.com") + { + Description = "Description of the Azure AI service resource attached to a skillset", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + }; + Response response = client.Create(skillset); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Skillsets_Create_SearchServiceCreateSkillset_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + SearchIndexerSkillset skillset = new SearchIndexerSkillset("tempskillset", new SearchIndexerSkill[] + { +new LanguageDetectionSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("countryHint") +{ +Source = "/document/countryHint", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("languageCode") +{ +TargetName = "languageCode", +} +}) +{ +Name = "skill2", +}, +new SplitSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("languageCode") +{ +Source = "/document/languageCode", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("textItems") +{ +TargetName = "pages", +} +}) +{ +TextSplitMode = TextSplitMode.Pages, +MaximumPageLength = 4000, +Unit = SplitSkillUnit.AzureOpenAITokens, +AzureOpenAITokenizerParameters = new AzureOpenAITokenizerParameters +{ +EncoderModelName = SplitSkillEncoderModelName.CL100kBase, +AllowedSpecialTokens = {"[START]", "[END]"}, +}, +Name = "skill3", +}, +new KeyPhraseExtractionSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("languageCode") +{ +Source = "/document/languageCode", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("keyPhrases") +{ +TargetName = "keyPhrases", +} +}) +{ +Name = "skill4", +Context = "/document/pages/*", +}, +new WebApiSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("text") +{ +Source = "/document/content", +}, +new InputFieldMappingEntry("languageCode") +{ +Source = "/document/languageCode", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("customresult") +{ +TargetName = "result", +} +}, "https://contoso.example.org/") +{ +HttpMethod = "POST", +Timeout = XmlConvert.ToTimeSpan("PT5S"), +Name = "skill5", +}, +new DocumentIntelligenceLayoutSkill(new InputFieldMappingEntry[] +{ +new InputFieldMappingEntry("file_data") +{ +Source = "/document/content", +} +}, new OutputFieldMappingEntry[] +{ +new OutputFieldMappingEntry("markdown_document") +{ +TargetName = "markdown_document", +} +}) +{ +OutputMode = DocumentIntelligenceLayoutSkillOutputMode.OneToMany, +MarkdownHeaderDepth = DocumentIntelligenceLayoutSkillMarkdownHeaderDepth.H3, +Name = "docIntelligenceLayoutSkill", +Context = "/document", +} + }) + { + Description = "Skillset for extracting entities and more", + CognitiveServices = new AIServicesAccountKey("myKey", "https://mySubdomainName.cognitiveservices.azure.com") + { + Description = "Description of the Azure AI service resource attached to a skillset", + }, + ETag = "0x1234568AE7E58A1", + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + }; + Response response = await client.CreateAsync(skillset); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Skillsets_ResetSkills_SearchServiceResetSkills() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + using RequestContent content = RequestContent.Create(new + { + skillNames = new object[] + { +"skill2", +"skill3", +"skill4" + }, + }); + Response response = client.ResetSkills("myskillset", content); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Skillsets_ResetSkills_SearchServiceResetSkills_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + using RequestContent content = RequestContent.Create(new + { + skillNames = new object[] + { +"skill2", +"skill3", +"skill4" + }, + }); + Response response = await client.ResetSkillsAsync("myskillset", content); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Skillsets_ResetSkills_SearchServiceResetSkills_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + SkillNames skillNames = new SkillNames + { + SkillNamesProperty = { "skill2", "skill3", "skill4" }, + }; + Response response = client.ResetSkills("myskillset", skillNames); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Skillsets_ResetSkills_SearchServiceResetSkills_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Skillsets client = new SearchClient(endpoint, credential).GetSkillsetsClient(); + + SkillNames skillNames = new SkillNames + { + SkillNamesProperty = { "skill2", "skill3", "skill4" }, + }; + Response response = await client.ResetSkillsAsync("myskillset", skillNames); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_SynonymMaps.cs b/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_SynonymMaps.cs new file mode 100644 index 000000000000..ec9240a7c2d6 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/tests/Generated/Samples/Samples_SynonymMaps.cs @@ -0,0 +1,382 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Text.Json; +using System.Threading.Tasks; +using Azure.Core; +using Azure.Identity; +using NUnit.Framework; + +namespace Azure.Search.Documents.Indexes.Samples +{ + public partial class Samples_SynonymMaps + { + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_SynonymMaps_CreateOrUpdate_SearchServiceCreateOrUpdateSynonymMap() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "mysynonymmap", + ["format"] = "solr", + ["synonyms"] = "United States, United States of America, USA\nWashington, Wash. => WA", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" + }); + Response response = client.CreateOrUpdate("mysynonymmap", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("format").ToString()); + Console.WriteLine(result.GetProperty("synonyms").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_SynonymMaps_CreateOrUpdate_SearchServiceCreateOrUpdateSynonymMap_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "mysynonymmap", + ["format"] = "solr", + ["synonyms"] = "United States, United States of America, USA\nWashington, Wash. => WA", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" + }); + Response response = await client.CreateOrUpdateAsync("mysynonymmap", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("format").ToString()); + Console.WriteLine(result.GetProperty("synonyms").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_SynonymMaps_CreateOrUpdate_SearchServiceCreateOrUpdateSynonymMap_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + SynonymMap synonymMap = new SynonymMap("mysynonymmap", "United States, United States of America, USA\nWashington, Wash. => WA") + { + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + ETag = "0x1234568AE7E58A1", + }; + Response response = client.CreateOrUpdate("mysynonymmap", synonymMap); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_SynonymMaps_CreateOrUpdate_SearchServiceCreateOrUpdateSynonymMap_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + SynonymMap synonymMap = new SynonymMap("mysynonymmap", "United States, United States of America, USA\nWashington, Wash. => WA") + { + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + ETag = "0x1234568AE7E58A1", + }; + Response response = await client.CreateOrUpdateAsync("mysynonymmap", synonymMap); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_SynonymMaps_Delete_SearchServiceDeleteSynonymMap() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + Response response = client.Delete("tempsynonymmap"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_SynonymMaps_Delete_SearchServiceDeleteSynonymMap_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + Response response = await client.DeleteAsync("tempsynonymmap"); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_SynonymMaps_GetSynonymMap_SearchServiceGetSynonymMap() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + Response response = client.GetSynonymMap("mysynonymmap", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("format").ToString()); + Console.WriteLine(result.GetProperty("synonyms").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_SynonymMaps_GetSynonymMap_SearchServiceGetSynonymMap_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + Response response = await client.GetSynonymMapAsync("mysynonymmap", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("format").ToString()); + Console.WriteLine(result.GetProperty("synonyms").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_SynonymMaps_GetSynonymMap_SearchServiceGetSynonymMap_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + Response response = client.GetSynonymMap("mysynonymmap"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_SynonymMaps_GetSynonymMap_SearchServiceGetSynonymMap_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + Response response = await client.GetSynonymMapAsync("mysynonymmap"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_SynonymMaps_GetSynonymMaps_SearchServiceListSynonymMaps() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + Response response = client.GetSynonymMaps(null, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("format").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("synonyms").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_SynonymMaps_GetSynonymMaps_SearchServiceListSynonymMaps_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + Response response = await client.GetSynonymMapsAsync(null, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("format").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("synonyms").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_SynonymMaps_GetSynonymMaps_SearchServiceListSynonymMaps_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + Response response = client.GetSynonymMaps(); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_SynonymMaps_GetSynonymMaps_SearchServiceListSynonymMaps_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + Response response = await client.GetSynonymMapsAsync(); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_SynonymMaps_Create_SearchServiceCreateSynonymMap() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "tempsynonymmap", + ["format"] = "solr", + ["synonyms"] = "United States, United States of America, USA\nWashington, Wash. => WA", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" + }); + Response response = client.Create(content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("format").ToString()); + Console.WriteLine(result.GetProperty("synonyms").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_SynonymMaps_Create_SearchServiceCreateSynonymMap_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + using RequestContent content = RequestContent.Create(new Dictionary + { + ["name"] = "tempsynonymmap", + ["format"] = "solr", + ["synonyms"] = "United States, United States of America, USA\nWashington, Wash. => WA", + ["encryptionKey"] = new + { + keyVaultKeyName = "myUserManagedEncryptionKey-createdinAzureKeyVault", + keyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + keyVaultUri = "https://myKeyVault.vault.azure.net", + accessCredentials = new + { + applicationId = "00000000-0000-0000-0000-000000000000", + applicationSecret = "", + }, + }, + ["@odata.etag"] = "0x1234568AE7E58A1" + }); + Response response = await client.CreateAsync(content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("name").ToString()); + Console.WriteLine(result.GetProperty("format").ToString()); + Console.WriteLine(result.GetProperty("synonyms").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_SynonymMaps_Create_SearchServiceCreateSynonymMap_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + SynonymMap synonymMap = new SynonymMap("tempsynonymmap", "United States, United States of America, USA\nWashington, Wash. => WA") + { + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + ETag = "0x1234568AE7E58A1", + }; + Response response = client.Create(synonymMap); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_SynonymMaps_Create_SearchServiceCreateSynonymMap_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + SynonymMaps client = new SearchClient(endpoint, credential).GetSynonymMapsClient(); + + SynonymMap synonymMap = new SynonymMap("tempsynonymmap", "United States, United States of America, USA\nWashington, Wash. => WA") + { + EncryptionKey = new SearchResourceEncryptionKey("myUserManagedEncryptionKey-createdinAzureKeyVault", "https://myKeyVault.vault.azure.net") + { + KeyVaultKeyVersion = "myKeyVersion-32charAlphaNumericString", + AccessCredentials = new AzureActiveDirectoryApplicationCredentials("00000000-0000-0000-0000-000000000000") + { + ApplicationSecret = "", + }, + }, + ETag = "0x1234568AE7E58A1", + }; + Response response = await client.CreateAsync(synonymMap); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Indexes/tsp-location.yaml b/sdk/search/Azure.Search.Documents.Indexes/tsp-location.yaml new file mode 100644 index 000000000000..b9158b5d0b1d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Indexes/tsp-location.yaml @@ -0,0 +1,5 @@ +directory: specification/search/Azure.Search.Service +commit: 5b1fbde971f33fb4fbfb01b5390526d7eda053d9 +repo: Azure/azure-rest-api-specs +additionalDirectories: +- specification/search/Azure.Search diff --git a/sdk/search/Azure.Search.Documents.Search/Azure.Search.Documents.Search.sln b/sdk/search/Azure.Search.Documents.Search/Azure.Search.Documents.Search.sln new file mode 100644 index 000000000000..6e13bd17af58 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/Azure.Search.Documents.Search.sln @@ -0,0 +1,56 @@ +Microsoft Visual Studio Solution File, Format Version 12.00 +# Visual Studio Version 16 +VisualStudioVersion = 16.0.29709.97 +MinimumVisualStudioVersion = 10.0.40219.1 +Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Azure.Core.TestFramework", "..\..\core\Azure.Core.TestFramework\src\Azure.Core.TestFramework.csproj", "{ECC730C1-4AEA-420C-916A-66B19B79E4DC}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Azure.Search.Documents.Search", "src\Azure.Search.Documents.Search.csproj", "{28FF4005-4467-4E36-92E7-DEA27DEB1519}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Azure.Search.Documents.Search.Tests", "tests\Azure.Search.Documents.Search.Tests.csproj", "{1F1CD1D4-9932-4B73-99D8-C252A67D4B46}" +EndProject +Global + GlobalSection(SolutionConfigurationPlatforms) = preSolution + Debug|Any CPU = Debug|Any CPU + Release|Any CPU = Release|Any CPU + EndGlobalSection + GlobalSection(ProjectConfigurationPlatforms) = postSolution + {B0C276D1-2930-4887-B29A-D1A33E7009A2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {B0C276D1-2930-4887-B29A-D1A33E7009A2}.Debug|Any CPU.Build.0 = Debug|Any CPU + {B0C276D1-2930-4887-B29A-D1A33E7009A2}.Release|Any CPU.ActiveCfg = Release|Any CPU + {B0C276D1-2930-4887-B29A-D1A33E7009A2}.Release|Any CPU.Build.0 = Release|Any CPU + {8E9A77AC-792A-4432-8320-ACFD46730401}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {8E9A77AC-792A-4432-8320-ACFD46730401}.Debug|Any CPU.Build.0 = Debug|Any CPU + {8E9A77AC-792A-4432-8320-ACFD46730401}.Release|Any CPU.ActiveCfg = Release|Any CPU + {8E9A77AC-792A-4432-8320-ACFD46730401}.Release|Any CPU.Build.0 = Release|Any CPU + {ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Debug|Any CPU.Build.0 = Debug|Any CPU + {ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Release|Any CPU.ActiveCfg = Release|Any CPU + {ECC730C1-4AEA-420C-916A-66B19B79E4DC}.Release|Any CPU.Build.0 = Release|Any CPU + {A4241C1F-A53D-474C-9E4E-075054407E74}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {A4241C1F-A53D-474C-9E4E-075054407E74}.Debug|Any CPU.Build.0 = Debug|Any CPU + {A4241C1F-A53D-474C-9E4E-075054407E74}.Release|Any CPU.ActiveCfg = Release|Any CPU + {A4241C1F-A53D-474C-9E4E-075054407E74}.Release|Any CPU.Build.0 = Release|Any CPU + {FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Debug|Any CPU.Build.0 = Debug|Any CPU + {FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Release|Any CPU.ActiveCfg = Release|Any CPU + {FA8BD3F1-8616-47B6-974C-7576CDF4717E}.Release|Any CPU.Build.0 = Release|Any CPU + {85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Debug|Any CPU.Build.0 = Debug|Any CPU + {85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Release|Any CPU.ActiveCfg = Release|Any CPU + {85677AD3-C214-42FA-AE6E-49B956CAC8DC}.Release|Any CPU.Build.0 = Release|Any CPU + {28FF4005-4467-4E36-92E7-DEA27DEB1519}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {28FF4005-4467-4E36-92E7-DEA27DEB1519}.Debug|Any CPU.Build.0 = Debug|Any CPU + {28FF4005-4467-4E36-92E7-DEA27DEB1519}.Release|Any CPU.ActiveCfg = Release|Any CPU + {28FF4005-4467-4E36-92E7-DEA27DEB1519}.Release|Any CPU.Build.0 = Release|Any CPU + {1F1CD1D4-9932-4B73-99D8-C252A67D4B46}.Debug|Any CPU.ActiveCfg = Debug|Any CPU + {1F1CD1D4-9932-4B73-99D8-C252A67D4B46}.Debug|Any CPU.Build.0 = Debug|Any CPU + {1F1CD1D4-9932-4B73-99D8-C252A67D4B46}.Release|Any CPU.ActiveCfg = Release|Any CPU + {1F1CD1D4-9932-4B73-99D8-C252A67D4B46}.Release|Any CPU.Build.0 = Release|Any CPU + EndGlobalSection + GlobalSection(SolutionProperties) = preSolution + HideSolutionNode = FALSE + EndGlobalSection + GlobalSection(ExtensibilityGlobals) = postSolution + SolutionGuid = {A97F4B90-2591-4689-B1F8-5F21FE6D6CAE} + EndGlobalSection +EndGlobal diff --git a/sdk/search/Azure.Search.Documents.Search/CHANGELOG.md b/sdk/search/Azure.Search.Documents.Search/CHANGELOG.md new file mode 100644 index 000000000000..8b33f0fedccc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/CHANGELOG.md @@ -0,0 +1,11 @@ +# Release History + +## 1.0.0-beta.1 (Unreleased) + +### Features Added + +### Breaking Changes + +### Bugs Fixed + +### Other Changes \ No newline at end of file diff --git a/sdk/search/Azure.Search.Documents.Search/Directory.Build.props b/sdk/search/Azure.Search.Documents.Search/Directory.Build.props new file mode 100644 index 000000000000..63bd836ad44b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/Directory.Build.props @@ -0,0 +1,6 @@ + + + + diff --git a/sdk/search/Azure.Search.Documents.Search/README.md b/sdk/search/Azure.Search.Documents.Search/README.md new file mode 100644 index 000000000000..07ff0c867f8f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/README.md @@ -0,0 +1,107 @@ +# Azure.Search.Documents.Search client library for .NET + +Azure.Search.Documents.Search is a managed service that helps developers get secret simply and securely. + +Use the client library for to: + +* [Get secret](https://docs.microsoft.com/azure) + +[Source code][source_root] | [Package (NuGet)][package] | [API reference documentation][reference_docs] | [Product documentation][azconfig_docs] | [Samples][source_samples] + + [Source code](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/search/Azure.Search.Documents.Search/src) | [Package (NuGet)](https://www.nuget.org/packages) | [API reference documentation](https://azure.github.io/azure-sdk-for-net) | [Product documentation](https://docs.microsoft.com/azure) + +## Getting started + +This section should include everything a developer needs to do to install and create their first client connection *very quickly*. + +### Install the package + +First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `dotnet add package package-name`, but should enable a developer to successfully install the package from NuGet, npm, or even cloning a GitHub repository. + +Install the client library for .NET with [NuGet](https://www.nuget.org/ ): + +```dotnetcli +dotnet add package Azure.Search.Documents.Search --prerelease +``` + +### Prerequisites + +Include a section after the install command that details any requirements that must be satisfied before a developer can [authenticate](#authenticate-the-client) and test all of the snippets in the [Examples](#examples) section. For example, for Cosmos DB: + +> You must have an [Azure subscription](https://azure.microsoft.com/free/dotnet/) and [Cosmos DB account](https://docs.microsoft.com/azure/cosmos-db/account-overview) (SQL API). In order to take advantage of the C# 8.0 syntax, it is recommended that you compile using the [.NET Core SDK](https://dotnet.microsoft.com/download) 3.0 or higher with a [language version](https://docs.microsoft.com/dotnet/csharp/language-reference/configure-language-version#override-a-default) of `latest`. It is also possible to compile with the .NET Core SDK 2.1.x using a language version of `preview`. + +### Authenticate the client + +If your library requires authentication for use, such as for Azure services, include instructions and example code needed for initializing and authenticating. + +For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object. + +### Service API versions + +The client library targets the latest service API version by default. A client instance accepts an optional service API version parameter from its options to specify which API version service to communicate. + +#### Select a service API version + +You have the flexibility to explicitly select a supported service API version when instantiating a client by configuring its associated options. This ensures that the client can communicate with services using the specified API version. + +For example, + +```C# Snippet:CreateClientForSpecificApiVersion +Uri endpoint = new Uri(""); +DefaultAzureCredential credential = new DefaultAzureCredential(); +ClientOptions options = new ClientOptions(ClientOptions.ServiceVersion.) +var client = new Client(endpoint, credential, options); +``` + +When selecting an API version, it's important to verify that there are no breaking changes compared to the latest API version. If there are significant differences, API calls may fail due to incompatibility. + +Always ensure that the chosen API version is fully supported and operational for your specific use case and that it aligns with the service's versioning policy. + +## Key concepts + +The *Key concepts* section should describe the functionality of the main classes. Point out the most important and useful classes in the package (with links to their reference pages) and explain how those classes work together. Feel free to use bulleted lists, tables, code blocks, or even diagrams for clarity. + +Include the *Thread safety* and *Additional concepts* sections below at the end of your *Key concepts* section. You may remove or add links depending on what your library makes use of: + +### Thread safety + +We guarantee that all client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that the recommendation of reusing client instances is always safe, even across threads. + +### Additional concepts + +[Client options](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) | +[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) | +[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) | +[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) | +[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md) | +[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#mocking) | +[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/) + + +## Examples + +You can familiarize yourself with different APIs using [Samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/search/Azure.Search.Documents.Search/samples). + +## Troubleshooting + +Describe common errors and exceptions, how to "unpack" them if necessary, and include guidance for graceful handling and recovery. + +Provide information to help developers avoid throttling or other service-enforced errors they might encounter. For example, provide guidance and examples for using retry or connection policies in the API. + +If the package or a related package supports it, include tips for logging or enabling instrumentation to help them debug their code. + +## Next steps + +* Provide a link to additional code examples, ideally to those sitting alongside the README in the package's `/samples` directory. +* If appropriate, point users to other packages that might be useful. +* If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for. + +## Contributing + +This is a template, but your SDK readme should include details on how to contribute code to the repo/package. + + +[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization +[style-guide-cloud]: https://aka.ms/azsdk/cloud-style-guide + +![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-net/sdk/search/Azure.Search.Documents.Search/README.png) \ No newline at end of file diff --git a/sdk/search/Azure.Search.Documents.Search/src/Azure.Search.Documents.Search.csproj b/sdk/search/Azure.Search.Documents.Search/src/Azure.Search.Documents.Search.csproj new file mode 100644 index 000000000000..588bdc2c81a9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Azure.Search.Documents.Search.csproj @@ -0,0 +1,20 @@ + + + This is the Azure.Search.Documents.Search client library for developing .NET applications with rich experience. + Azure SDK Code Generation Azure.Search.Documents.Search for Azure Data Plane + 1.0.0-beta.1 + Azure.Search.Documents.Search + $(RequiredTargetFrameworks) + true + + + + + + + + + + + + diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteItem.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteItem.Serialization.cs new file mode 100644 index 000000000000..eb9a70fe0246 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteItem.Serialization.cs @@ -0,0 +1,150 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class AutocompleteItem : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AutocompleteItem)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("text"u8); + writer.WriteStringValue(Text); + writer.WritePropertyName("queryPlusText"u8); + writer.WriteStringValue(QueryPlusText); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + AutocompleteItem IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AutocompleteItem)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAutocompleteItem(document.RootElement, options); + } + + internal static AutocompleteItem DeserializeAutocompleteItem(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string text = default; + string queryPlusText = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("text"u8)) + { + text = property.Value.GetString(); + continue; + } + if (property.NameEquals("queryPlusText"u8)) + { + queryPlusText = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AutocompleteItem(text, queryPlusText, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AutocompleteItem)} does not support writing '{options.Format}' format."); + } + } + + AutocompleteItem IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAutocompleteItem(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AutocompleteItem)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static AutocompleteItem FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAutocompleteItem(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteItem.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteItem.cs new file mode 100644 index 000000000000..f64e9ed16f50 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteItem.cs @@ -0,0 +1,82 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// The result of Autocomplete requests. + public partial class AutocompleteItem + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The completed term. + /// The query along with the completed term. + /// or is null. + internal AutocompleteItem(string text, string queryPlusText) + { + Argument.AssertNotNull(text, nameof(text)); + Argument.AssertNotNull(queryPlusText, nameof(queryPlusText)); + + Text = text; + QueryPlusText = queryPlusText; + } + + /// Initializes a new instance of . + /// The completed term. + /// The query along with the completed term. + /// Keeps track of any properties unknown to the library. + internal AutocompleteItem(string text, string queryPlusText, IDictionary serializedAdditionalRawData) + { + Text = text; + QueryPlusText = queryPlusText; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal AutocompleteItem() + { + } + + /// The completed term. + public string Text { get; } + /// The query along with the completed term. + public string QueryPlusText { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteMode.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteMode.cs new file mode 100644 index 000000000000..bbb72afb49d2 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteMode.cs @@ -0,0 +1,68 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// + /// Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' + /// to get shingles and 'oneTermWithContext' to use the current context in + /// producing autocomplete terms. + /// + public readonly partial struct AutocompleteMode : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public AutocompleteMode(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string OneTermValue = "oneTerm"; + private const string TwoTermsValue = "twoTerms"; + private const string OneTermWithContextValue = "oneTermWithContext"; + + /// + /// Only one term is suggested. If the query has two terms, only the last term is + /// completed. For example, if the input is 'washington medic', the suggested terms + /// could include 'medicaid', 'medicare', and 'medicine'. + /// + public static AutocompleteMode OneTerm { get; } = new AutocompleteMode(OneTermValue); + /// + /// Matching two-term phrases in the index will be suggested. For example, if the + /// input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'. + /// + public static AutocompleteMode TwoTerms { get; } = new AutocompleteMode(TwoTermsValue); + /// + /// Completes the last term in a query with two or more terms, where the last two + /// terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'. + /// + public static AutocompleteMode OneTermWithContext { get; } = new AutocompleteMode(OneTermWithContextValue); + /// Determines if two values are the same. + public static bool operator ==(AutocompleteMode left, AutocompleteMode right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(AutocompleteMode left, AutocompleteMode right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator AutocompleteMode(string value) => new AutocompleteMode(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is AutocompleteMode other && Equals(other); + /// + public bool Equals(AutocompleteMode other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteRequest.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteRequest.Serialization.cs new file mode 100644 index 000000000000..68a779b24f60 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteRequest.Serialization.cs @@ -0,0 +1,265 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class AutocompleteRequest : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AutocompleteRequest)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("search"u8); + writer.WriteStringValue(Search); + if (Optional.IsDefined(AutocompleteMode)) + { + writer.WritePropertyName("autocompleteMode"u8); + writer.WriteStringValue(AutocompleteMode.Value.ToString()); + } + if (Optional.IsDefined(Filter)) + { + writer.WritePropertyName("filter"u8); + writer.WriteStringValue(Filter); + } + if (Optional.IsDefined(Fuzzy)) + { + writer.WritePropertyName("fuzzy"u8); + writer.WriteBooleanValue(Fuzzy.Value); + } + if (Optional.IsDefined(HighlightPostTag)) + { + writer.WritePropertyName("highlightPostTag"u8); + writer.WriteStringValue(HighlightPostTag); + } + if (Optional.IsDefined(HighlightPreTag)) + { + writer.WritePropertyName("highlightPreTag"u8); + writer.WriteStringValue(HighlightPreTag); + } + if (Optional.IsDefined(MinimumCoverage)) + { + writer.WritePropertyName("minimumCoverage"u8); + writer.WriteNumberValue(MinimumCoverage.Value); + } + if (Optional.IsDefined(SearchFields)) + { + writer.WritePropertyName("searchFields"u8); + writer.WriteStringValue(SearchFields); + } + writer.WritePropertyName("suggesterName"u8); + writer.WriteStringValue(SuggesterName); + if (Optional.IsDefined(Top)) + { + writer.WritePropertyName("top"u8); + writer.WriteNumberValue(Top.Value); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + AutocompleteRequest IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AutocompleteRequest)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAutocompleteRequest(document.RootElement, options); + } + + internal static AutocompleteRequest DeserializeAutocompleteRequest(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string search = default; + AutocompleteMode? autocompleteMode = default; + string filter = default; + bool? fuzzy = default; + string highlightPostTag = default; + string highlightPreTag = default; + double? minimumCoverage = default; + string searchFields = default; + string suggesterName = default; + int? top = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("search"u8)) + { + search = property.Value.GetString(); + continue; + } + if (property.NameEquals("autocompleteMode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + autocompleteMode = new AutocompleteMode(property.Value.GetString()); + continue; + } + if (property.NameEquals("filter"u8)) + { + filter = property.Value.GetString(); + continue; + } + if (property.NameEquals("fuzzy"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + fuzzy = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("highlightPostTag"u8)) + { + highlightPostTag = property.Value.GetString(); + continue; + } + if (property.NameEquals("highlightPreTag"u8)) + { + highlightPreTag = property.Value.GetString(); + continue; + } + if (property.NameEquals("minimumCoverage"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + minimumCoverage = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("searchFields"u8)) + { + searchFields = property.Value.GetString(); + continue; + } + if (property.NameEquals("suggesterName"u8)) + { + suggesterName = property.Value.GetString(); + continue; + } + if (property.NameEquals("top"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + top = property.Value.GetInt32(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AutocompleteRequest( + search, + autocompleteMode, + filter, + fuzzy, + highlightPostTag, + highlightPreTag, + minimumCoverage, + searchFields, + suggesterName, + top, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AutocompleteRequest)} does not support writing '{options.Format}' format."); + } + } + + AutocompleteRequest IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAutocompleteRequest(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AutocompleteRequest)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static AutocompleteRequest FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAutocompleteRequest(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteRequest.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteRequest.cs new file mode 100644 index 000000000000..d62546704c4e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteRequest.cs @@ -0,0 +1,185 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// Parameters for fuzzy matching, and other autocomplete query behaviors. + public partial class AutocompleteRequest + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The search text on which to base autocomplete results. + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + /// or is null. + public AutocompleteRequest(string search, string suggesterName) + { + Argument.AssertNotNull(search, nameof(search)); + Argument.AssertNotNull(suggesterName, nameof(suggesterName)); + + Search = search; + SuggesterName = suggesterName; + } + + /// Initializes a new instance of . + /// The search text on which to base autocomplete results. + /// + /// Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' + /// to get shingles and 'oneTermWithContext' to use the current context while + /// producing auto-completed terms. + /// + /// + /// An OData expression that filters the documents used to produce completed terms + /// for the Autocomplete result. + /// + /// + /// A value indicating whether to use fuzzy matching for the autocomplete query. + /// Default is false. When set to true, the query will autocomplete terms even if + /// there's a substituted or missing character in the search text. While this + /// provides a better experience in some scenarios, it comes at a performance cost + /// as fuzzy autocomplete queries are slower and consume more resources. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. If omitted, hit highlighting is disabled. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. If omitted, hit highlighting is disabled. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by an autocomplete query in order for the query to be reported as a + /// success. This parameter can be useful for ensuring search availability even for + /// services with only one replica. The default is 80. + /// + /// + /// The comma-separated list of field names to consider when querying for + /// auto-completed terms. Target fields must be included in the specified + /// suggester. + /// + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + /// + /// The number of auto-completed terms to retrieve. This must be a value between 1 + /// and 100. The default is 5. + /// + /// Keeps track of any properties unknown to the library. + internal AutocompleteRequest(string search, AutocompleteMode? autocompleteMode, string filter, bool? fuzzy, string highlightPostTag, string highlightPreTag, double? minimumCoverage, string searchFields, string suggesterName, int? top, IDictionary serializedAdditionalRawData) + { + Search = search; + AutocompleteMode = autocompleteMode; + Filter = filter; + Fuzzy = fuzzy; + HighlightPostTag = highlightPostTag; + HighlightPreTag = highlightPreTag; + MinimumCoverage = minimumCoverage; + SearchFields = searchFields; + SuggesterName = suggesterName; + Top = top; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal AutocompleteRequest() + { + } + + /// The search text on which to base autocomplete results. + public string Search { get; } + /// + /// Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' + /// to get shingles and 'oneTermWithContext' to use the current context while + /// producing auto-completed terms. + /// + public AutocompleteMode? AutocompleteMode { get; set; } + /// + /// An OData expression that filters the documents used to produce completed terms + /// for the Autocomplete result. + /// + public string Filter { get; set; } + /// + /// A value indicating whether to use fuzzy matching for the autocomplete query. + /// Default is false. When set to true, the query will autocomplete terms even if + /// there's a substituted or missing character in the search text. While this + /// provides a better experience in some scenarios, it comes at a performance cost + /// as fuzzy autocomplete queries are slower and consume more resources. + /// + public bool? Fuzzy { get; set; } + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. If omitted, hit highlighting is disabled. + /// + public string HighlightPostTag { get; set; } + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. If omitted, hit highlighting is disabled. + /// + public string HighlightPreTag { get; set; } + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by an autocomplete query in order for the query to be reported as a + /// success. This parameter can be useful for ensuring search availability even for + /// services with only one replica. The default is 80. + /// + public double? MinimumCoverage { get; set; } + /// + /// The comma-separated list of field names to consider when querying for + /// auto-completed terms. Target fields must be included in the specified + /// suggester. + /// + public string SearchFields { get; set; } + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + public string SuggesterName { get; } + /// + /// The number of auto-completed terms to retrieve. This must be a value between 1 + /// and 100. The default is 5. + /// + public int? Top { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteResult.Serialization.cs new file mode 100644 index 000000000000..fae837862f53 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteResult.Serialization.cs @@ -0,0 +1,167 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class AutocompleteResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AutocompleteResult)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(Coverage)) + { + writer.WritePropertyName("@search.coverage"u8); + writer.WriteNumberValue(Coverage.Value); + } + writer.WritePropertyName("value"u8); + writer.WriteStartArray(); + foreach (var item in Value) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + AutocompleteResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(AutocompleteResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeAutocompleteResult(document.RootElement, options); + } + + internal static AutocompleteResult DeserializeAutocompleteResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + double? searchCoverage = default; + IReadOnlyList value = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@search.coverage"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + searchCoverage = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("value"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(AutocompleteItem.DeserializeAutocompleteItem(item, options)); + } + value = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new AutocompleteResult(searchCoverage, value, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(AutocompleteResult)} does not support writing '{options.Format}' format."); + } + } + + AutocompleteResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAutocompleteResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(AutocompleteResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static AutocompleteResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeAutocompleteResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteResult.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteResult.cs new file mode 100644 index 000000000000..e9e932884cbd --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/AutocompleteResult.cs @@ -0,0 +1,88 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Search +{ + /// The result of Autocomplete query. + public partial class AutocompleteResult + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The list of returned Autocompleted items. + /// is null. + internal AutocompleteResult(IEnumerable value) + { + Argument.AssertNotNull(value, nameof(value)); + + Value = value.ToList(); + } + + /// Initializes a new instance of . + /// + /// 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. + /// Keeps track of any properties unknown to the library. + internal AutocompleteResult(double? coverage, IReadOnlyList value, IDictionary serializedAdditionalRawData) + { + Coverage = coverage; + Value = value; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal AutocompleteResult() + { + } + + /// + /// 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. + /// + public double? Coverage { get; } + /// The list of returned Autocompleted items. + public IReadOnlyList Value { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/DebugInfo.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/DebugInfo.Serialization.cs new file mode 100644 index 000000000000..51f9de0e0ab8 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/DebugInfo.Serialization.cs @@ -0,0 +1,149 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class DebugInfo : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DebugInfo)} does not support writing '{format}' format."); + } + + if (options.Format != "W" && Optional.IsDefined(QueryRewrites)) + { + writer.WritePropertyName("queryRewrites"u8); + writer.WriteObjectValue(QueryRewrites, options); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + DebugInfo IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DebugInfo)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeDebugInfo(document.RootElement, options); + } + + internal static DebugInfo DeserializeDebugInfo(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + QueryRewritesDebugInfo queryRewrites = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("queryRewrites"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + queryRewrites = QueryRewritesDebugInfo.DeserializeQueryRewritesDebugInfo(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new DebugInfo(queryRewrites, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(DebugInfo)} does not support writing '{options.Format}' format."); + } + } + + DebugInfo IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDebugInfo(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(DebugInfo)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static DebugInfo FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDebugInfo(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/DebugInfo.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/DebugInfo.cs new file mode 100644 index 000000000000..557c22592b3f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/DebugInfo.cs @@ -0,0 +1,68 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// Contains debugging information that can be used to further explore your search + /// results. + /// + public partial class DebugInfo + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + internal DebugInfo() + { + } + + /// Initializes a new instance of . + /// Contains debugging information specific to query rewrites. + /// Keeps track of any properties unknown to the library. + internal DebugInfo(QueryRewritesDebugInfo queryRewrites, IDictionary serializedAdditionalRawData) + { + QueryRewrites = queryRewrites; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Contains debugging information specific to query rewrites. + public QueryRewritesDebugInfo QueryRewrites { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/Docs/Documents.xml b/sdk/search/Azure.Search.Documents.Search/src/Generated/Docs/Documents.xml new file mode 100644 index 000000000000..39fb1a27c720 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/Docs/Documents.xml @@ -0,0 +1,1745 @@ + + + + + +This sample shows how to call CountAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = await client.CountAsync("preview-test"); +]]> + + + +This sample shows how to call Count. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = client.Count("preview-test"); +]]> + + + +This sample shows how to call CountAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = await client.CountAsync("preview-test", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> + + + +This sample shows how to call Count and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = client.Count("preview-test", null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> + + + +This sample shows how to call SearchGetAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = await client.SearchGetAsync("myindex"); +]]> +This sample shows how to call SearchGetAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = await client.SearchGetAsync("myindex"); +]]> + + + +This sample shows how to call SearchGet. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = client.SearchGet("myindex"); +]]> +This sample shows how to call SearchGet. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = client.SearchGet("myindex"); +]]> + + + +This sample shows how to call SearchGetAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = await client.SearchGetAsync("myindex", "nice hotels", true, new string[] { "category,count:10,sort:count" }, "rating gt 10", new string[] { "title" }, "", "", 80, new string[] { "search.score() desc", "rating desc" }, "simple", null, "sp", new string[] { "title", "description" }, "any", "global", "mysessionid", new string[] { "docId", "title", "description" }, 100, 10, null, null, null, null, null, null, null, null, null, null, null, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); +]]> +This sample shows how to call SearchGetAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = await client.SearchGetAsync("myindex", "how do clouds form", true, null, null, null, "", "", null, null, "semantic", null, null, null, null, null, null, null, null, null, "my-semantic-config", "partial", 780, "extractive|count-3", "extractive|highlight-true", null, null, null, null, null, null, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); +]]> + + + +This sample shows how to call SearchGet and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = client.SearchGet("myindex", "nice hotels", true, new string[] { "category,count:10,sort:count" }, "rating gt 10", new string[] { "title" }, "", "", 80, new string[] { "search.score() desc", "rating desc" }, "simple", null, "sp", new string[] { "title", "description" }, "any", "global", "mysessionid", new string[] { "docId", "title", "description" }, 100, 10, null, null, null, null, null, null, null, null, null, null, null, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); +]]> +This sample shows how to call SearchGet and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = client.SearchGet("myindex", "how do clouds form", true, null, null, null, "", "", null, null, "semantic", null, null, null, null, null, null, null, null, null, "my-semantic-config", "partial", 780, "extractive|count-3", "extractive|highlight-true", null, null, null, null, null, null, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); +]]> + + + +This sample shows how to call SearchPostAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +SearchRequest searchRequest = new SearchRequest +{ + Count = true, + Facets = { "ownerId", "price,metric:sum,default:10" }, + Filter = "category eq 'purple' or category eq 'pink'", + Highlight = "category", + HighlightPostTag = "", + HighlightPreTag = "", + MinimumCoverage = 100, + QueryType = QueryType.Semantic, + ScoringStatistics = ScoringStatistics.Global, + SessionId = "mysessionid", + ScoringParameters = { "categoryTag:desiredCategoryValue" }, + ScoringProfile = "stringFieldBoost", + Search = "purple", + SearchFields = "id,name,description,category,ownerId", + SearchMode = SearchMode.Any, + QueryLanguage = QueryLanguage.EnUs, + Speller = QuerySpellerType.Lexicon, + Select = "id,name,description,category,ownerId", + Skip = 0, + Top = 10, + SemanticConfiguration = "testconfig", + SemanticErrorHandling = SemanticErrorMode.Partial, + SemanticMaxWaitInMilliseconds = 5000, + SemanticQuery = "find all purple", + Answers = QueryAnswerType.Extractive, + Captions = QueryCaptionType.Extractive, + QueryRewrites = QueryRewritesType.Generative, + VectorQueries = {new VectorizedQuery(new float[]{0F, 1F, 2F, 3F, 4F, 5F, 6F, 7F, 8F, 9F}) + { + K = 50, + Fields = "vector22, vector1b", + Oversampling = 20, + Weight = 1F, + Threshold = new VectorSimilarityThreshold(0.984), + FilterOverride = "ownerId eq 'sam'", + }}, + VectorFilterMode = VectorFilterMode.PreFilter, + HybridSearch = new HybridSearch + { + MaxTextRecallSize = 100, + CountAndFacetMode = HybridCountAndFacetMode.CountAllResults, + }, +}; +Response response = await client.SearchPostAsync("preview-test", searchRequest); +]]> +This sample shows how to call SearchPostAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +SearchRequest searchRequest = new SearchRequest +{ + Count = true, + HighlightPostTag = "", + HighlightPreTag = "", + QueryType = QueryType.Semantic, + Search = "how do clouds form", + SemanticConfiguration = "my-semantic-config", + SemanticErrorHandling = SemanticErrorMode.Partial, + SemanticMaxWaitInMilliseconds = 780, + Answers = new QueryAnswerType("extractive|count-3"), + Captions = new QueryCaptionType("extractive|highlight-true"), +}; +Response response = await client.SearchPostAsync("myindex", searchRequest); +]]> + + + +This sample shows how to call SearchPost. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +SearchRequest searchRequest = new SearchRequest +{ + Count = true, + Facets = { "ownerId", "price,metric:sum,default:10" }, + Filter = "category eq 'purple' or category eq 'pink'", + Highlight = "category", + HighlightPostTag = "", + HighlightPreTag = "", + MinimumCoverage = 100, + QueryType = QueryType.Semantic, + ScoringStatistics = ScoringStatistics.Global, + SessionId = "mysessionid", + ScoringParameters = { "categoryTag:desiredCategoryValue" }, + ScoringProfile = "stringFieldBoost", + Search = "purple", + SearchFields = "id,name,description,category,ownerId", + SearchMode = SearchMode.Any, + QueryLanguage = QueryLanguage.EnUs, + Speller = QuerySpellerType.Lexicon, + Select = "id,name,description,category,ownerId", + Skip = 0, + Top = 10, + SemanticConfiguration = "testconfig", + SemanticErrorHandling = SemanticErrorMode.Partial, + SemanticMaxWaitInMilliseconds = 5000, + SemanticQuery = "find all purple", + Answers = QueryAnswerType.Extractive, + Captions = QueryCaptionType.Extractive, + QueryRewrites = QueryRewritesType.Generative, + VectorQueries = {new VectorizedQuery(new float[]{0F, 1F, 2F, 3F, 4F, 5F, 6F, 7F, 8F, 9F}) + { + K = 50, + Fields = "vector22, vector1b", + Oversampling = 20, + Weight = 1F, + Threshold = new VectorSimilarityThreshold(0.984), + FilterOverride = "ownerId eq 'sam'", + }}, + VectorFilterMode = VectorFilterMode.PreFilter, + HybridSearch = new HybridSearch + { + MaxTextRecallSize = 100, + CountAndFacetMode = HybridCountAndFacetMode.CountAllResults, + }, +}; +Response response = client.SearchPost("preview-test", searchRequest); +]]> +This sample shows how to call SearchPost. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +SearchRequest searchRequest = new SearchRequest +{ + Count = true, + HighlightPostTag = "", + HighlightPreTag = "", + QueryType = QueryType.Semantic, + Search = "how do clouds form", + SemanticConfiguration = "my-semantic-config", + SemanticErrorHandling = SemanticErrorMode.Partial, + SemanticMaxWaitInMilliseconds = 780, + Answers = new QueryAnswerType("extractive|count-3"), + Captions = new QueryCaptionType("extractive|highlight-true"), +}; +Response response = client.SearchPost("myindex", searchRequest); +]]> + + + +This sample shows how to call SearchPostAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +using RequestContent content = RequestContent.Create(new +{ + count = true, + facets = new object[] + { + "ownerId", + "price,metric:sum,default:10" + }, + filter = "category eq 'purple' or category eq 'pink'", + highlight = "category", + highlightPostTag = "", + highlightPreTag = "", + minimumCoverage = 100, + queryType = "semantic", + scoringStatistics = "global", + sessionId = "mysessionid", + scoringParameters = new object[] + { + "categoryTag:desiredCategoryValue" + }, + scoringProfile = "stringFieldBoost", + search = "purple", + searchFields = "id,name,description,category,ownerId", + searchMode = "any", + queryLanguage = "en-us", + speller = "lexicon", + select = "id,name,description,category,ownerId", + skip = 0, + top = 10, + semanticConfiguration = "testconfig", + semanticErrorHandling = "partial", + semanticMaxWaitInMilliseconds = 5000, + semanticQuery = "find all purple", + answers = "extractive", + captions = "extractive", + queryRewrites = "generative", + vectorQueries = new object[] + { + new + { + vector = new object[] + { + 0F, + 1F, + 2F, + 3F, + 4F, + 5F, + 6F, + 7F, + 8F, + 9F + }, + kind = "vector", + k = 50, + fields = "vector22, vector1b", + oversampling = 20, + weight = 1F, + threshold = new + { + value = 0.984, + kind = "vectorSimilarity", + }, + filterOverride = "ownerId eq 'sam'", + } + }, + vectorFilterMode = "preFilter", + hybridSearch = new + { + maxTextRecallSize = 100, + countAndFacetMode = "countAllResults", + }, +}); +Response response = await client.SearchPostAsync("preview-test", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); +]]> +This sample shows how to call SearchPostAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +using RequestContent content = RequestContent.Create(new +{ + count = true, + highlightPostTag = "", + highlightPreTag = "", + queryType = "semantic", + search = "how do clouds form", + semanticConfiguration = "my-semantic-config", + answers = "extractive|count-3", + captions = "extractive|highlight-true", + semanticErrorHandling = "partial", + semanticMaxWaitInMilliseconds = 780, +}); +Response response = await client.SearchPostAsync("myindex", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); +]]> + + + +This sample shows how to call SearchPost and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +using RequestContent content = RequestContent.Create(new +{ + count = true, + facets = new object[] + { + "ownerId", + "price,metric:sum,default:10" + }, + filter = "category eq 'purple' or category eq 'pink'", + highlight = "category", + highlightPostTag = "", + highlightPreTag = "", + minimumCoverage = 100, + queryType = "semantic", + scoringStatistics = "global", + sessionId = "mysessionid", + scoringParameters = new object[] + { + "categoryTag:desiredCategoryValue" + }, + scoringProfile = "stringFieldBoost", + search = "purple", + searchFields = "id,name,description,category,ownerId", + searchMode = "any", + queryLanguage = "en-us", + speller = "lexicon", + select = "id,name,description,category,ownerId", + skip = 0, + top = 10, + semanticConfiguration = "testconfig", + semanticErrorHandling = "partial", + semanticMaxWaitInMilliseconds = 5000, + semanticQuery = "find all purple", + answers = "extractive", + captions = "extractive", + queryRewrites = "generative", + vectorQueries = new object[] + { + new + { + vector = new object[] + { + 0F, + 1F, + 2F, + 3F, + 4F, + 5F, + 6F, + 7F, + 8F, + 9F + }, + kind = "vector", + k = 50, + fields = "vector22, vector1b", + oversampling = 20, + weight = 1F, + threshold = new + { + value = 0.984, + kind = "vectorSimilarity", + }, + filterOverride = "ownerId eq 'sam'", + } + }, + vectorFilterMode = "preFilter", + hybridSearch = new + { + maxTextRecallSize = 100, + countAndFacetMode = "countAllResults", + }, +}); +Response response = client.SearchPost("preview-test", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); +]]> +This sample shows how to call SearchPost and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +using RequestContent content = RequestContent.Create(new +{ + count = true, + highlightPostTag = "", + highlightPreTag = "", + queryType = "semantic", + search = "how do clouds form", + semanticConfiguration = "my-semantic-config", + answers = "extractive|count-3", + captions = "extractive|highlight-true", + semanticErrorHandling = "partial", + semanticMaxWaitInMilliseconds = 780, +}); +Response response = client.SearchPost("myindex", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); +]]> + + + +This sample shows how to call GetDocumentAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = await client.GetDocumentAsync("preview-test", "1"); +]]> + + + +This sample shows how to call GetDocument. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = client.GetDocument("preview-test", "1"); +]]> + + + +This sample shows how to call GetDocumentAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = await client.GetDocumentAsync("preview-test", "1", new string[] { "id", "description", "name", "category", "ownerId" }, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> + + + +This sample shows how to call GetDocument and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = client.GetDocument("preview-test", "1", new string[] { "id", "description", "name", "category", "ownerId" }, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.ToString()); +]]> + + + +This sample shows how to call SuggestGetAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = await client.SuggestGetAsync("myindex", "hote", "sg"); +]]> + + + +This sample shows how to call SuggestGet. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = client.SuggestGet("myindex", "hote", "sg"); +]]> + + + +This sample shows how to call SuggestGetAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = await client.SuggestGetAsync("myindex", "hote", "sg", "rating gt 10", false, "", "", 80, new string[] { "search.score() desc", "rating desc" }, new string[] { "title" }, new string[] { "docId", "title", "description" }, 10, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.text").ToString()); +]]> + + + +This sample shows how to call SuggestGet and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = client.SuggestGet("myindex", "hote", "sg", "rating gt 10", false, "", "", 80, new string[] { "search.score() desc", "rating desc" }, new string[] { "title" }, new string[] { "docId", "title", "description" }, 10, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.text").ToString()); +]]> + + + +This sample shows how to call SuggestPostAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +SuggestRequest suggestRequest = new SuggestRequest("p", "sg") +{ + Filter = "ownerId eq 'sam' and id lt '15'", + Fuzzy = true, + HighlightPostTag = "", + HighlightPreTag = "", + MinimumCoverage = 80, + Orderby = "id desc", + SearchFields = "category", + Select = "id,name,category,ownerId", + Top = 10, +}; +Response response = await client.SuggestPostAsync("preview-test", suggestRequest); +]]> + + + +This sample shows how to call SuggestPost. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +SuggestRequest suggestRequest = new SuggestRequest("p", "sg") +{ + Filter = "ownerId eq 'sam' and id lt '15'", + Fuzzy = true, + HighlightPostTag = "", + HighlightPreTag = "", + MinimumCoverage = 80, + Orderby = "id desc", + SearchFields = "category", + Select = "id,name,category,ownerId", + Top = 10, +}; +Response response = client.SuggestPost("preview-test", suggestRequest); +]]> + + + +This sample shows how to call SuggestPostAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +using RequestContent content = RequestContent.Create(new +{ + filter = "ownerId eq 'sam' and id lt '15'", + fuzzy = true, + highlightPostTag = "", + highlightPreTag = "", + minimumCoverage = 80, + orderby = "id desc", + search = "p", + searchFields = "category", + select = "id,name,category,ownerId", + suggesterName = "sg", + top = 10, +}); +Response response = await client.SuggestPostAsync("preview-test", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.text").ToString()); +]]> + + + +This sample shows how to call SuggestPost and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +using RequestContent content = RequestContent.Create(new +{ + filter = "ownerId eq 'sam' and id lt '15'", + fuzzy = true, + highlightPostTag = "", + highlightPreTag = "", + minimumCoverage = 80, + orderby = "id desc", + search = "p", + searchFields = "category", + select = "id,name,category,ownerId", + suggesterName = "sg", + top = 10, +}); +Response response = client.SuggestPost("preview-test", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.text").ToString()); +]]> + + + +This sample shows how to call IndexAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +IndexBatch batch = new IndexBatch(new IndexAction[] +{ + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + } +}); +Response response = await client.IndexAsync("preview-test", batch); +]]> + + + +This sample shows how to call Index. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +IndexBatch batch = new IndexBatch(new IndexAction[] +{ + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + }, + new IndexAction + { + ActionType = IndexActionType.MergeOrUpload, + } +}); +Response response = client.Index("preview-test", batch); +]]> + + + +This sample shows how to call IndexAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +using RequestContent content = RequestContent.Create(new +{ + value = new object[] + { + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + } + }, +}); +Response response = await client.IndexAsync("preview-test", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("key").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("statusCode").ToString()); +]]> + + + +This sample shows how to call Index and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +using RequestContent content = RequestContent.Create(new +{ + value = new object[] + { + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + }, + new Dictionary + { + ["@search.action"] = "mergeOrUpload" + } + }, +}); +Response response = client.Index("preview-test", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("key").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("status").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("statusCode").ToString()); +]]> + + + +This sample shows how to call AutocompleteGetAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = await client.AutocompleteGetAsync("myindex", "washington medic", "sg"); +]]> + + + +This sample shows how to call AutocompleteGet. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = client.AutocompleteGet("myindex", "washington medic", "sg"); +]]> + + + +This sample shows how to call AutocompleteGetAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = await client.AutocompleteGetAsync("myindex", "washington medic", "sg", "oneTerm", null, false, "", "", 80, new string[] { "title", "description" }, null, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("text").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("queryPlusText").ToString()); +]]> + + + +This sample shows how to call AutocompleteGet and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +Response response = client.AutocompleteGet("myindex", "washington medic", "sg", "oneTerm", null, false, "", "", 80, new string[] { "title", "description" }, null, null); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("text").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("queryPlusText").ToString()); +]]> + + + +This sample shows how to call AutocompletePostAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +AutocompleteRequest autocompleteRequest = new AutocompleteRequest("p", "sg") +{ + AutocompleteMode = AutocompleteMode.OneTerm, + Filter = "ownerId ne '1'", + Fuzzy = true, + HighlightPostTag = "", + HighlightPreTag = "", + MinimumCoverage = 80, + SearchFields = "category, ownerId", + Top = 10, +}; +Response response = await client.AutocompletePostAsync("preview-test", autocompleteRequest); +]]> + + + +This sample shows how to call AutocompletePost. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +AutocompleteRequest autocompleteRequest = new AutocompleteRequest("p", "sg") +{ + AutocompleteMode = AutocompleteMode.OneTerm, + Filter = "ownerId ne '1'", + Fuzzy = true, + HighlightPostTag = "", + HighlightPreTag = "", + MinimumCoverage = 80, + SearchFields = "category, ownerId", + Top = 10, +}; +Response response = client.AutocompletePost("preview-test", autocompleteRequest); +]]> + + + +This sample shows how to call AutocompletePostAsync and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +using RequestContent content = RequestContent.Create(new +{ + search = "p", + autocompleteMode = "oneTerm", + filter = "ownerId ne '1'", + fuzzy = true, + highlightPostTag = "", + highlightPreTag = "", + minimumCoverage = 80, + searchFields = "category, ownerId", + suggesterName = "sg", + top = 10, +}); +Response response = await client.AutocompletePostAsync("preview-test", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("text").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("queryPlusText").ToString()); +]]> + + + +This sample shows how to call AutocompletePost and parse the result. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + +using RequestContent content = RequestContent.Create(new +{ + search = "p", + autocompleteMode = "oneTerm", + filter = "ownerId ne '1'", + fuzzy = true, + highlightPostTag = "", + highlightPreTag = "", + minimumCoverage = 80, + searchFields = "category, ownerId", + suggesterName = "sg", + top = 10, +}); +Response response = client.AutocompletePost("preview-test", content); + +JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; +Console.WriteLine(result.GetProperty("value")[0].GetProperty("text").ToString()); +Console.WriteLine(result.GetProperty("value")[0].GetProperty("queryPlusText").ToString()); +]]> + + + \ No newline at end of file diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/DocumentDebugInfo.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/DocumentDebugInfo.Serialization.cs new file mode 100644 index 000000000000..b5721dbf3a2a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/DocumentDebugInfo.Serialization.cs @@ -0,0 +1,164 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class DocumentDebugInfo : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DocumentDebugInfo)} does not support writing '{format}' format."); + } + + if (options.Format != "W" && Optional.IsDefined(Semantic)) + { + writer.WritePropertyName("semantic"u8); + writer.WriteObjectValue(Semantic, options); + } + if (options.Format != "W" && Optional.IsDefined(Vectors)) + { + writer.WritePropertyName("vectors"u8); + writer.WriteObjectValue(Vectors, options); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + DocumentDebugInfo IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(DocumentDebugInfo)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeDocumentDebugInfo(document.RootElement, options); + } + + internal static DocumentDebugInfo DeserializeDocumentDebugInfo(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + SemanticDebugInfo semantic = default; + VectorsDebugInfo vectors = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("semantic"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + semantic = SemanticDebugInfo.DeserializeSemanticDebugInfo(property.Value, options); + continue; + } + if (property.NameEquals("vectors"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + vectors = VectorsDebugInfo.DeserializeVectorsDebugInfo(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new DocumentDebugInfo(semantic, vectors, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(DocumentDebugInfo)} does not support writing '{options.Format}' format."); + } + } + + DocumentDebugInfo IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDocumentDebugInfo(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(DocumentDebugInfo)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static DocumentDebugInfo FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeDocumentDebugInfo(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/DocumentDebugInfo.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/DocumentDebugInfo.cs new file mode 100644 index 000000000000..6854b05521fd --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/DocumentDebugInfo.cs @@ -0,0 +1,72 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// Contains debugging information that can be used to further explore your search + /// results. + /// + public partial class DocumentDebugInfo + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + internal DocumentDebugInfo() + { + } + + /// Initializes a new instance of . + /// Contains debugging information specific to semantic ranking requests. + /// Contains debugging information specific to vector and hybrid search. + /// Keeps track of any properties unknown to the library. + internal DocumentDebugInfo(SemanticDebugInfo semantic, VectorsDebugInfo vectors, IDictionary serializedAdditionalRawData) + { + Semantic = semantic; + Vectors = vectors; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Contains debugging information specific to semantic ranking requests. + public SemanticDebugInfo Semantic { get; } + /// Contains debugging information specific to vector and hybrid search. + public VectorsDebugInfo Vectors { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/Documents.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/Documents.cs new file mode 100644 index 000000000000..03ce0210122d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/Documents.cs @@ -0,0 +1,2499 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Threading; +using System.Threading.Tasks; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Search.Documents.Search +{ + // Data plane generated sub-client. + /// The Documents sub-client. + public partial class Documents + { + private const string AuthorizationHeader = "api-key"; + private readonly AzureKeyCredential _keyCredential; + private static readonly string[] AuthorizationScopes = new string[] { "https://search.azure.com/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + private readonly string _apiVersion; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of Documents for mocking. + protected Documents() + { + } + + /// Initializes a new instance of Documents. + /// The handler for diagnostic messaging in the client. + /// The HTTP pipeline for sending and receiving REST requests and responses. + /// The key credential to copy. + /// The token credential to copy. + /// Service host. + /// The API version to use for this operation. + internal Documents(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, AzureKeyCredential keyCredential, TokenCredential tokenCredential, Uri endpoint, string apiVersion) + { + ClientDiagnostics = clientDiagnostics; + _pipeline = pipeline; + _keyCredential = keyCredential; + _tokenCredential = tokenCredential; + _endpoint = endpoint; + _apiVersion = apiVersion; + } + + /// Queries the number of documents in the index. + /// The name of the index. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> CountAsync(string indexName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await CountAsync(indexName, context).ConfigureAwait(false); + return Response.FromValue(response.Content.ToObjectFromJson(), response); + } + + /// Queries the number of documents in the index. + /// The name of the index. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response Count(string indexName, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = Count(indexName, context); + return Response.FromValue(response.Content.ToObjectFromJson(), response); + } + + /// + /// [Protocol Method] Queries the number of documents in the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task CountAsync(string indexName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + using var scope = ClientDiagnostics.CreateScope("Documents.Count"); + scope.Start(); + try + { + using HttpMessage message = CreateCountRequest(indexName, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Queries the number of documents in the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Count(string indexName, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + using var scope = ClientDiagnostics.CreateScope("Documents.Count"); + scope.Start(); + try + { + using HttpMessage message = CreateCountRequest(indexName, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Searches for documents in the index. + /// The name of the index. + /// + /// A full-text search query expression; Use "*" or omit this parameter to match + /// all documents. + /// + /// + /// A value that specifies whether to fetch the total count of results. Default is + /// false. Setting this value to true may have a performance impact. Note that the + /// count returned is an approximation. + /// + /// + /// The list of facet expressions to apply to the search query. Each facet + /// expression contains a field name, optionally followed by a comma-separated list + /// of name:value pairs. + /// + /// The OData $filter expression to apply to the search query. + /// + /// The list of field names to use for hit highlights. Only searchable fields can + /// be used for hit highlighting. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. Default is </em>. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. Default is <em>. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by a search query in order for the query to be reported as a success. + /// This parameter can be useful for ensuring search availability even for services + /// with only one replica. The default is 100. + /// + /// + /// The list of OData $orderby expressions by which to sort the results. Each + /// expression can be either a field name or a call to either the geo.distance() or + /// the search.score() functions. Each expression can be followed by asc to + /// indicate ascending, and desc to indicate descending. The default is ascending + /// order. Ties will be broken by the match scores of documents. If no OrderBy is + /// specified, the default sort order is descending by document match score. There + /// can be at most 32 $orderby clauses. + /// + /// + /// A value that specifies the syntax of the search query. The default is 'simple'. + /// Use 'full' if your query uses the Lucene query syntax. + /// + /// + /// The list of parameter values to be used in scoring functions (for example, + /// referencePointParameter) using the format name-values. For example, if the + /// scoring profile defines a function with a parameter called 'mylocation' the + /// parameter string would be "mylocation--122.2,44.8" (without the quotes). + /// + /// + /// The name of a scoring profile to evaluate match scores for matching documents + /// in order to sort the results. + /// + /// + /// The 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. + /// + /// + /// A value that specifies whether we want to calculate scoring statistics (such as + /// document frequency) globally for more consistent scoring, or locally, for lower + /// latency. + /// + /// + /// A value to be used to create a sticky session, which can help to get more + /// consistent results. As long as the same sessionId is used, a best-effort + /// attempt will be made to target the same replica set. Be wary that reusing the + /// same sessionID values repeatedly can interfere with the load balancing of the + /// requests across replicas and adversely affect the performance of the search + /// service. The value used as sessionId cannot start with a '_' character. + /// + /// + /// The list of fields to retrieve. If unspecified, all fields marked as + /// retrievable in the schema are included. + /// + /// + /// 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. + /// + /// + /// The name of the semantic configuration that lists which fields should be used + /// for semantic ranking, captions, highlights, and answers + /// + /// + /// 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. + /// + /// + /// 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. + /// The maximum character length of answers can be configured by appending the pipe + /// character '|' followed by the 'count-<number of maximum character length>', + /// such as 'extractive|maxcharlength-600'. + /// + /// + /// 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`. The maximum character length of captions can be configured by + /// appending the pipe character '|' followed by the 'count-<number of maximum + /// character length>', such as 'extractive|maxcharlength-600'. + /// + /// + /// Allows setting a separate search query that will be solely used for semantic + /// reranking, semantic captions and semantic answers. Is useful for scenarios + /// where there is a need to use different queries between the base retrieval and + /// ranking phase, and the L2 semantic phase. + /// + /// + /// When QueryRewrites is set to `generative`, the query terms are sent to a + /// generate model which will produce 10 (default) rewrites to help increase the + /// recall of the request. The requested count can be configured by appending the + /// pipe character `|` followed by the `count-<number of rewrites>` option, such as + /// `generative|count-3`. Defaults to `None`. This parameter is only valid if the + /// query type is `semantic`. + /// + /// + /// Enables a debugging tool that can be used to further explore your search + /// results. + /// + /// The language of the query. + /// Improve search recall by spell-correcting individual search query terms. + /// The list of field names used for semantic ranking. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> SearchGetAsync(string indexName, string searchText = null, bool? includeTotalResultCount = null, IEnumerable facets = null, string filter = null, IEnumerable highlightFields = null, string highlightPostTag = null, string highlightPreTag = null, double? minimumCoverage = null, IEnumerable orderBy = null, QueryType? queryType = null, IEnumerable scoringParameters = null, string scoringProfile = null, IEnumerable searchFields = null, SearchMode? searchMode = null, ScoringStatistics? scoringStatistics = null, string sessionId = null, IEnumerable select = null, int? skip = null, int? top = null, string semanticConfiguration = null, SemanticErrorMode? semanticErrorHandling = null, int? semanticMaxWaitInMilliseconds = null, QueryAnswerType? answers = null, QueryCaptionType? captions = null, string semanticQuery = null, QueryRewritesType? queryRewrites = null, QueryDebugMode? debug = null, QueryLanguage? queryLanguage = null, QuerySpellerType? speller = null, IEnumerable semanticFields = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await SearchGetAsync(indexName, searchText, includeTotalResultCount, facets, filter, highlightFields, highlightPostTag, highlightPreTag, minimumCoverage, orderBy, queryType?.ToString(), scoringParameters, scoringProfile, searchFields, searchMode?.ToString(), scoringStatistics?.ToString(), sessionId, select, skip, top, semanticConfiguration, semanticErrorHandling?.ToString(), semanticMaxWaitInMilliseconds, answers?.ToString(), captions?.ToString(), semanticQuery, queryRewrites?.ToString(), debug?.ToString(), queryLanguage?.ToString(), speller?.ToString(), semanticFields, context).ConfigureAwait(false); + return Response.FromValue(SearchDocumentsResult.FromResponse(response), response); + } + + /// Searches for documents in the index. + /// The name of the index. + /// + /// A full-text search query expression; Use "*" or omit this parameter to match + /// all documents. + /// + /// + /// A value that specifies whether to fetch the total count of results. Default is + /// false. Setting this value to true may have a performance impact. Note that the + /// count returned is an approximation. + /// + /// + /// The list of facet expressions to apply to the search query. Each facet + /// expression contains a field name, optionally followed by a comma-separated list + /// of name:value pairs. + /// + /// The OData $filter expression to apply to the search query. + /// + /// The list of field names to use for hit highlights. Only searchable fields can + /// be used for hit highlighting. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. Default is </em>. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. Default is <em>. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by a search query in order for the query to be reported as a success. + /// This parameter can be useful for ensuring search availability even for services + /// with only one replica. The default is 100. + /// + /// + /// The list of OData $orderby expressions by which to sort the results. Each + /// expression can be either a field name or a call to either the geo.distance() or + /// the search.score() functions. Each expression can be followed by asc to + /// indicate ascending, and desc to indicate descending. The default is ascending + /// order. Ties will be broken by the match scores of documents. If no OrderBy is + /// specified, the default sort order is descending by document match score. There + /// can be at most 32 $orderby clauses. + /// + /// + /// A value that specifies the syntax of the search query. The default is 'simple'. + /// Use 'full' if your query uses the Lucene query syntax. + /// + /// + /// The list of parameter values to be used in scoring functions (for example, + /// referencePointParameter) using the format name-values. For example, if the + /// scoring profile defines a function with a parameter called 'mylocation' the + /// parameter string would be "mylocation--122.2,44.8" (without the quotes). + /// + /// + /// The name of a scoring profile to evaluate match scores for matching documents + /// in order to sort the results. + /// + /// + /// The 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. + /// + /// + /// A value that specifies whether we want to calculate scoring statistics (such as + /// document frequency) globally for more consistent scoring, or locally, for lower + /// latency. + /// + /// + /// A value to be used to create a sticky session, which can help to get more + /// consistent results. As long as the same sessionId is used, a best-effort + /// attempt will be made to target the same replica set. Be wary that reusing the + /// same sessionID values repeatedly can interfere with the load balancing of the + /// requests across replicas and adversely affect the performance of the search + /// service. The value used as sessionId cannot start with a '_' character. + /// + /// + /// The list of fields to retrieve. If unspecified, all fields marked as + /// retrievable in the schema are included. + /// + /// + /// 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. + /// + /// + /// The name of the semantic configuration that lists which fields should be used + /// for semantic ranking, captions, highlights, and answers + /// + /// + /// 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. + /// + /// + /// 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. + /// The maximum character length of answers can be configured by appending the pipe + /// character '|' followed by the 'count-<number of maximum character length>', + /// such as 'extractive|maxcharlength-600'. + /// + /// + /// 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`. The maximum character length of captions can be configured by + /// appending the pipe character '|' followed by the 'count-<number of maximum + /// character length>', such as 'extractive|maxcharlength-600'. + /// + /// + /// Allows setting a separate search query that will be solely used for semantic + /// reranking, semantic captions and semantic answers. Is useful for scenarios + /// where there is a need to use different queries between the base retrieval and + /// ranking phase, and the L2 semantic phase. + /// + /// + /// When QueryRewrites is set to `generative`, the query terms are sent to a + /// generate model which will produce 10 (default) rewrites to help increase the + /// recall of the request. The requested count can be configured by appending the + /// pipe character `|` followed by the `count-<number of rewrites>` option, such as + /// `generative|count-3`. Defaults to `None`. This parameter is only valid if the + /// query type is `semantic`. + /// + /// + /// Enables a debugging tool that can be used to further explore your search + /// results. + /// + /// The language of the query. + /// Improve search recall by spell-correcting individual search query terms. + /// The list of field names used for semantic ranking. + /// The cancellation token to use. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response SearchGet(string indexName, string searchText = null, bool? includeTotalResultCount = null, IEnumerable facets = null, string filter = null, IEnumerable highlightFields = null, string highlightPostTag = null, string highlightPreTag = null, double? minimumCoverage = null, IEnumerable orderBy = null, QueryType? queryType = null, IEnumerable scoringParameters = null, string scoringProfile = null, IEnumerable searchFields = null, SearchMode? searchMode = null, ScoringStatistics? scoringStatistics = null, string sessionId = null, IEnumerable select = null, int? skip = null, int? top = null, string semanticConfiguration = null, SemanticErrorMode? semanticErrorHandling = null, int? semanticMaxWaitInMilliseconds = null, QueryAnswerType? answers = null, QueryCaptionType? captions = null, string semanticQuery = null, QueryRewritesType? queryRewrites = null, QueryDebugMode? debug = null, QueryLanguage? queryLanguage = null, QuerySpellerType? speller = null, IEnumerable semanticFields = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = SearchGet(indexName, searchText, includeTotalResultCount, facets, filter, highlightFields, highlightPostTag, highlightPreTag, minimumCoverage, orderBy, queryType?.ToString(), scoringParameters, scoringProfile, searchFields, searchMode?.ToString(), scoringStatistics?.ToString(), sessionId, select, skip, top, semanticConfiguration, semanticErrorHandling?.ToString(), semanticMaxWaitInMilliseconds, answers?.ToString(), captions?.ToString(), semanticQuery, queryRewrites?.ToString(), debug?.ToString(), queryLanguage?.ToString(), speller?.ToString(), semanticFields, context); + return Response.FromValue(SearchDocumentsResult.FromResponse(response), response); + } + + /// + /// [Protocol Method] Searches for documents in the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// + /// A full-text search query expression; Use "*" or omit this parameter to match + /// all documents. + /// + /// + /// A value that specifies whether to fetch the total count of results. Default is + /// false. Setting this value to true may have a performance impact. Note that the + /// count returned is an approximation. + /// + /// + /// The list of facet expressions to apply to the search query. Each facet + /// expression contains a field name, optionally followed by a comma-separated list + /// of name:value pairs. + /// + /// The OData $filter expression to apply to the search query. + /// + /// The list of field names to use for hit highlights. Only searchable fields can + /// be used for hit highlighting. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. Default is </em>. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. Default is <em>. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by a search query in order for the query to be reported as a success. + /// This parameter can be useful for ensuring search availability even for services + /// with only one replica. The default is 100. + /// + /// + /// The list of OData $orderby expressions by which to sort the results. Each + /// expression can be either a field name or a call to either the geo.distance() or + /// the search.score() functions. Each expression can be followed by asc to + /// indicate ascending, and desc to indicate descending. The default is ascending + /// order. Ties will be broken by the match scores of documents. If no OrderBy is + /// specified, the default sort order is descending by document match score. There + /// can be at most 32 $orderby clauses. + /// + /// + /// A value that specifies the syntax of the search query. The default is 'simple'. + /// Use 'full' if your query uses the Lucene query syntax. Allowed values: "simple" | "full" | "semantic" + /// + /// + /// The list of parameter values to be used in scoring functions (for example, + /// referencePointParameter) using the format name-values. For example, if the + /// scoring profile defines a function with a parameter called 'mylocation' the + /// parameter string would be "mylocation--122.2,44.8" (without the quotes). + /// + /// + /// The name of a scoring profile to evaluate match scores for matching documents + /// in order to sort the results. + /// + /// + /// The 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. Allowed values: "any" | "all" + /// + /// + /// A value that specifies whether we want to calculate scoring statistics (such as + /// document frequency) globally for more consistent scoring, or locally, for lower + /// latency. Allowed values: "local" | "global" + /// + /// + /// A value to be used to create a sticky session, which can help to get more + /// consistent results. As long as the same sessionId is used, a best-effort + /// attempt will be made to target the same replica set. Be wary that reusing the + /// same sessionID values repeatedly can interfere with the load balancing of the + /// requests across replicas and adversely affect the performance of the search + /// service. The value used as sessionId cannot start with a '_' character. + /// + /// + /// The list of fields to retrieve. If unspecified, all fields marked as + /// retrievable in the schema are included. + /// + /// + /// 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. + /// + /// + /// The name of the semantic configuration that lists which fields should be used + /// for semantic ranking, captions, highlights, and answers + /// + /// + /// Allows the user to choose whether a semantic call should fail completely, or to + /// return partial results (default). Allowed values: "partial" | "fail" + /// + /// + /// 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. + /// + /// + /// 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. + /// The maximum character length of answers can be configured by appending the pipe + /// character '|' followed by the 'count-<number of maximum character length>', + /// such as 'extractive|maxcharlength-600'. Allowed values: "none" | "extractive" + /// + /// + /// 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`. The maximum character length of captions can be configured by + /// appending the pipe character '|' followed by the 'count-<number of maximum + /// character length>', such as 'extractive|maxcharlength-600'. Allowed values: "none" | "extractive" + /// + /// + /// Allows setting a separate search query that will be solely used for semantic + /// reranking, semantic captions and semantic answers. Is useful for scenarios + /// where there is a need to use different queries between the base retrieval and + /// ranking phase, and the L2 semantic phase. + /// + /// + /// When QueryRewrites is set to `generative`, the query terms are sent to a + /// generate model which will produce 10 (default) rewrites to help increase the + /// recall of the request. The requested count can be configured by appending the + /// pipe character `|` followed by the `count-<number of rewrites>` option, such as + /// `generative|count-3`. Defaults to `None`. This parameter is only valid if the + /// query type is `semantic`. Allowed values: "none" | "generative" + /// + /// + /// Enables a debugging tool that can be used to further explore your search + /// results. Allowed values: "disabled" | "semantic" | "vector" | "queryRewrites" | "all" + /// + /// The language of the query. Allowed values: "none" | "en-us" | "en-gb" | "en-in" | "en-ca" | "en-au" | "fr-fr" | "fr-ca" | "de-de" | "es-es" | "es-mx" | "zh-cn" | "zh-tw" | "pt-br" | "pt-pt" | "it-it" | "ja-jp" | "ko-kr" | "ru-ru" | "cs-cz" | "nl-be" | "nl-nl" | "hu-hu" | "pl-pl" | "sv-se" | "tr-tr" | "hi-in" | "ar-sa" | "ar-eg" | "ar-ma" | "ar-kw" | "ar-jo" | "da-dk" | "no-no" | "bg-bg" | "hr-hr" | "hr-ba" | "ms-my" | "ms-bn" | "sl-sl" | "ta-in" | "vi-vn" | "el-gr" | "ro-ro" | "is-is" | "id-id" | "th-th" | "lt-lt" | "uk-ua" | "lv-lv" | "et-ee" | "ca-es" | "fi-fi" | "sr-ba" | "sr-me" | "sr-rs" | "sk-sk" | "nb-no" | "hy-am" | "bn-in" | "eu-es" | "gl-es" | "gu-in" | "he-il" | "ga-ie" | "kn-in" | "ml-in" | "mr-in" | "fa-ae" | "pa-in" | "te-in" | "ur-pk". + /// Improve search recall by spell-correcting individual search query terms. Allowed values: "none" | "lexicon". + /// The list of field names used for semantic ranking. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task SearchGetAsync(string indexName, string searchText, bool? includeTotalResultCount, IEnumerable facets, string filter, IEnumerable highlightFields, string highlightPostTag, string highlightPreTag, double? minimumCoverage, IEnumerable orderBy, string queryType, IEnumerable scoringParameters, string scoringProfile, IEnumerable searchFields, string searchMode, string scoringStatistics, string sessionId, IEnumerable select, int? skip, int? top, string semanticConfiguration, string semanticErrorHandling, int? semanticMaxWaitInMilliseconds, string answers, string captions, string semanticQuery, string queryRewrites, string debug, string queryLanguage, string speller, IEnumerable semanticFields, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + using var scope = ClientDiagnostics.CreateScope("Documents.SearchGet"); + scope.Start(); + try + { + using HttpMessage message = CreateSearchGetRequest(indexName, searchText, includeTotalResultCount, facets, filter, highlightFields, highlightPostTag, highlightPreTag, minimumCoverage, orderBy, queryType, scoringParameters, scoringProfile, searchFields, searchMode, scoringStatistics, sessionId, select, skip, top, semanticConfiguration, semanticErrorHandling, semanticMaxWaitInMilliseconds, answers, captions, semanticQuery, queryRewrites, debug, queryLanguage, speller, semanticFields, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Searches for documents in the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// + /// A full-text search query expression; Use "*" or omit this parameter to match + /// all documents. + /// + /// + /// A value that specifies whether to fetch the total count of results. Default is + /// false. Setting this value to true may have a performance impact. Note that the + /// count returned is an approximation. + /// + /// + /// The list of facet expressions to apply to the search query. Each facet + /// expression contains a field name, optionally followed by a comma-separated list + /// of name:value pairs. + /// + /// The OData $filter expression to apply to the search query. + /// + /// The list of field names to use for hit highlights. Only searchable fields can + /// be used for hit highlighting. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. Default is </em>. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. Default is <em>. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by a search query in order for the query to be reported as a success. + /// This parameter can be useful for ensuring search availability even for services + /// with only one replica. The default is 100. + /// + /// + /// The list of OData $orderby expressions by which to sort the results. Each + /// expression can be either a field name or a call to either the geo.distance() or + /// the search.score() functions. Each expression can be followed by asc to + /// indicate ascending, and desc to indicate descending. The default is ascending + /// order. Ties will be broken by the match scores of documents. If no OrderBy is + /// specified, the default sort order is descending by document match score. There + /// can be at most 32 $orderby clauses. + /// + /// + /// A value that specifies the syntax of the search query. The default is 'simple'. + /// Use 'full' if your query uses the Lucene query syntax. Allowed values: "simple" | "full" | "semantic" + /// + /// + /// The list of parameter values to be used in scoring functions (for example, + /// referencePointParameter) using the format name-values. For example, if the + /// scoring profile defines a function with a parameter called 'mylocation' the + /// parameter string would be "mylocation--122.2,44.8" (without the quotes). + /// + /// + /// The name of a scoring profile to evaluate match scores for matching documents + /// in order to sort the results. + /// + /// + /// The 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. Allowed values: "any" | "all" + /// + /// + /// A value that specifies whether we want to calculate scoring statistics (such as + /// document frequency) globally for more consistent scoring, or locally, for lower + /// latency. Allowed values: "local" | "global" + /// + /// + /// A value to be used to create a sticky session, which can help to get more + /// consistent results. As long as the same sessionId is used, a best-effort + /// attempt will be made to target the same replica set. Be wary that reusing the + /// same sessionID values repeatedly can interfere with the load balancing of the + /// requests across replicas and adversely affect the performance of the search + /// service. The value used as sessionId cannot start with a '_' character. + /// + /// + /// The list of fields to retrieve. If unspecified, all fields marked as + /// retrievable in the schema are included. + /// + /// + /// 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. + /// + /// + /// The name of the semantic configuration that lists which fields should be used + /// for semantic ranking, captions, highlights, and answers + /// + /// + /// Allows the user to choose whether a semantic call should fail completely, or to + /// return partial results (default). Allowed values: "partial" | "fail" + /// + /// + /// 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. + /// + /// + /// 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. + /// The maximum character length of answers can be configured by appending the pipe + /// character '|' followed by the 'count-<number of maximum character length>', + /// such as 'extractive|maxcharlength-600'. Allowed values: "none" | "extractive" + /// + /// + /// 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`. The maximum character length of captions can be configured by + /// appending the pipe character '|' followed by the 'count-<number of maximum + /// character length>', such as 'extractive|maxcharlength-600'. Allowed values: "none" | "extractive" + /// + /// + /// Allows setting a separate search query that will be solely used for semantic + /// reranking, semantic captions and semantic answers. Is useful for scenarios + /// where there is a need to use different queries between the base retrieval and + /// ranking phase, and the L2 semantic phase. + /// + /// + /// When QueryRewrites is set to `generative`, the query terms are sent to a + /// generate model which will produce 10 (default) rewrites to help increase the + /// recall of the request. The requested count can be configured by appending the + /// pipe character `|` followed by the `count-<number of rewrites>` option, such as + /// `generative|count-3`. Defaults to `None`. This parameter is only valid if the + /// query type is `semantic`. Allowed values: "none" | "generative" + /// + /// + /// Enables a debugging tool that can be used to further explore your search + /// results. Allowed values: "disabled" | "semantic" | "vector" | "queryRewrites" | "all" + /// + /// The language of the query. Allowed values: "none" | "en-us" | "en-gb" | "en-in" | "en-ca" | "en-au" | "fr-fr" | "fr-ca" | "de-de" | "es-es" | "es-mx" | "zh-cn" | "zh-tw" | "pt-br" | "pt-pt" | "it-it" | "ja-jp" | "ko-kr" | "ru-ru" | "cs-cz" | "nl-be" | "nl-nl" | "hu-hu" | "pl-pl" | "sv-se" | "tr-tr" | "hi-in" | "ar-sa" | "ar-eg" | "ar-ma" | "ar-kw" | "ar-jo" | "da-dk" | "no-no" | "bg-bg" | "hr-hr" | "hr-ba" | "ms-my" | "ms-bn" | "sl-sl" | "ta-in" | "vi-vn" | "el-gr" | "ro-ro" | "is-is" | "id-id" | "th-th" | "lt-lt" | "uk-ua" | "lv-lv" | "et-ee" | "ca-es" | "fi-fi" | "sr-ba" | "sr-me" | "sr-rs" | "sk-sk" | "nb-no" | "hy-am" | "bn-in" | "eu-es" | "gl-es" | "gu-in" | "he-il" | "ga-ie" | "kn-in" | "ml-in" | "mr-in" | "fa-ae" | "pa-in" | "te-in" | "ur-pk". + /// Improve search recall by spell-correcting individual search query terms. Allowed values: "none" | "lexicon". + /// The list of field names used for semantic ranking. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response SearchGet(string indexName, string searchText, bool? includeTotalResultCount, IEnumerable facets, string filter, IEnumerable highlightFields, string highlightPostTag, string highlightPreTag, double? minimumCoverage, IEnumerable orderBy, string queryType, IEnumerable scoringParameters, string scoringProfile, IEnumerable searchFields, string searchMode, string scoringStatistics, string sessionId, IEnumerable select, int? skip, int? top, string semanticConfiguration, string semanticErrorHandling, int? semanticMaxWaitInMilliseconds, string answers, string captions, string semanticQuery, string queryRewrites, string debug, string queryLanguage, string speller, IEnumerable semanticFields, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + + using var scope = ClientDiagnostics.CreateScope("Documents.SearchGet"); + scope.Start(); + try + { + using HttpMessage message = CreateSearchGetRequest(indexName, searchText, includeTotalResultCount, facets, filter, highlightFields, highlightPostTag, highlightPreTag, minimumCoverage, orderBy, queryType, scoringParameters, scoringProfile, searchFields, searchMode, scoringStatistics, sessionId, select, skip, top, semanticConfiguration, semanticErrorHandling, semanticMaxWaitInMilliseconds, answers, captions, semanticQuery, queryRewrites, debug, queryLanguage, speller, semanticFields, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Searches for documents in the index. + /// The name of the index. + /// The definition of the Search request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> SearchPostAsync(string indexName, SearchRequest searchRequest, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(searchRequest, nameof(searchRequest)); + + using RequestContent content = searchRequest.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await SearchPostAsync(indexName, content, context).ConfigureAwait(false); + return Response.FromValue(SearchDocumentsResult.FromResponse(response), response); + } + + /// Searches for documents in the index. + /// The name of the index. + /// The definition of the Search request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response SearchPost(string indexName, SearchRequest searchRequest, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(searchRequest, nameof(searchRequest)); + + using RequestContent content = searchRequest.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = SearchPost(indexName, content, context); + return Response.FromValue(SearchDocumentsResult.FromResponse(response), response); + } + + /// + /// [Protocol Method] Searches for documents in the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task SearchPostAsync(string indexName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Documents.SearchPost"); + scope.Start(); + try + { + using HttpMessage message = CreateSearchPostRequest(indexName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Searches for documents in the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response SearchPost(string indexName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Documents.SearchPost"); + scope.Start(); + try + { + using HttpMessage message = CreateSearchPostRequest(indexName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Retrieves a document from the index. + /// The name of the index. + /// The key of the document to retrieve. + /// + /// List of field names to retrieve for the document; Any field not retrieved will + /// be missing from the returned document. + /// + /// The cancellation token to use. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// + public virtual async Task> GetDocumentAsync(string indexName, string key, IEnumerable selectedFields = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNullOrEmpty(key, nameof(key)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await GetDocumentAsync(indexName, key, selectedFields, context).ConfigureAwait(false); + return Response.FromValue(LookupDocument.FromResponse(response), response); + } + + /// Retrieves a document from the index. + /// The name of the index. + /// The key of the document to retrieve. + /// + /// List of field names to retrieve for the document; Any field not retrieved will + /// be missing from the returned document. + /// + /// The cancellation token to use. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// + public virtual Response GetDocument(string indexName, string key, IEnumerable selectedFields = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNullOrEmpty(key, nameof(key)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = GetDocument(indexName, key, selectedFields, context); + return Response.FromValue(LookupDocument.FromResponse(response), response); + } + + /// + /// [Protocol Method] Retrieves a document from the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The key of the document to retrieve. + /// + /// List of field names to retrieve for the document; Any field not retrieved will + /// be missing from the returned document. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task GetDocumentAsync(string indexName, string key, IEnumerable selectedFields, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNullOrEmpty(key, nameof(key)); + + using var scope = ClientDiagnostics.CreateScope("Documents.GetDocument"); + scope.Start(); + try + { + using HttpMessage message = CreateGetDocumentRequest(indexName, key, selectedFields, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Retrieves a document from the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The key of the document to retrieve. + /// + /// List of field names to retrieve for the document; Any field not retrieved will + /// be missing from the returned document. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// or is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response GetDocument(string indexName, string key, IEnumerable selectedFields, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNullOrEmpty(key, nameof(key)); + + using var scope = ClientDiagnostics.CreateScope("Documents.GetDocument"); + scope.Start(); + try + { + using HttpMessage message = CreateGetDocumentRequest(indexName, key, selectedFields, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Suggests documents in the index that match the given partial query text. + /// The name of the index. + /// + /// The search text to use to suggest documents. Must be at least 1 character, and + /// no more than 100 characters. + /// + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + /// An OData expression that filters the documents considered for suggestions. + /// + /// A value indicating whether to use fuzzy matching for the suggestions query. + /// Default is false. When set to true, the query will find terms even if there's a + /// substituted or missing character in the search text. While this provides a + /// better experience in some scenarios, it comes at a performance cost as fuzzy + /// suggestions queries are slower and consume more resources. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. If omitted, hit highlighting of suggestions is disabled. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. If omitted, hit highlighting of suggestions is disabled. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by a suggestions query in order for the query to be reported as a + /// success. This parameter can be useful for ensuring search availability even for + /// services with only one replica. The default is 80. + /// + /// + /// The list of OData $orderby expressions by which to sort the results. Each + /// expression can be either a field name or a call to either the geo.distance() or + /// the search.score() functions. Each expression can be followed by asc to + /// indicate ascending, or desc to indicate descending. The default is ascending + /// order. Ties will be broken by the match scores of documents. If no $orderby is + /// specified, the default sort order is descending by document match score. There + /// can be at most 32 $orderby clauses. + /// + /// + /// The list of field names to search for the specified search text. Target fields + /// must be included in the specified suggester. + /// + /// + /// The list of fields to retrieve. If unspecified, only the key field will be + /// included in the results. + /// + /// + /// The number of suggestions to retrieve. The value must be a number between 1 and + /// 100. The default is 5. + /// + /// The cancellation token to use. + /// , or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> SuggestGetAsync(string indexName, string searchText, string suggesterName, string filter = null, bool? useFuzzyMatching = null, string highlightPostTag = null, string highlightPreTag = null, double? minimumCoverage = null, IEnumerable orderBy = null, IEnumerable searchFields = null, IEnumerable select = null, int? top = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(searchText, nameof(searchText)); + Argument.AssertNotNull(suggesterName, nameof(suggesterName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await SuggestGetAsync(indexName, searchText, suggesterName, filter, useFuzzyMatching, highlightPostTag, highlightPreTag, minimumCoverage, orderBy, searchFields, select, top, context).ConfigureAwait(false); + return Response.FromValue(SuggestDocumentsResult.FromResponse(response), response); + } + + /// Suggests documents in the index that match the given partial query text. + /// The name of the index. + /// + /// The search text to use to suggest documents. Must be at least 1 character, and + /// no more than 100 characters. + /// + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + /// An OData expression that filters the documents considered for suggestions. + /// + /// A value indicating whether to use fuzzy matching for the suggestions query. + /// Default is false. When set to true, the query will find terms even if there's a + /// substituted or missing character in the search text. While this provides a + /// better experience in some scenarios, it comes at a performance cost as fuzzy + /// suggestions queries are slower and consume more resources. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. If omitted, hit highlighting of suggestions is disabled. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. If omitted, hit highlighting of suggestions is disabled. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by a suggestions query in order for the query to be reported as a + /// success. This parameter can be useful for ensuring search availability even for + /// services with only one replica. The default is 80. + /// + /// + /// The list of OData $orderby expressions by which to sort the results. Each + /// expression can be either a field name or a call to either the geo.distance() or + /// the search.score() functions. Each expression can be followed by asc to + /// indicate ascending, or desc to indicate descending. The default is ascending + /// order. Ties will be broken by the match scores of documents. If no $orderby is + /// specified, the default sort order is descending by document match score. There + /// can be at most 32 $orderby clauses. + /// + /// + /// The list of field names to search for the specified search text. Target fields + /// must be included in the specified suggester. + /// + /// + /// The list of fields to retrieve. If unspecified, only the key field will be + /// included in the results. + /// + /// + /// The number of suggestions to retrieve. The value must be a number between 1 and + /// 100. The default is 5. + /// + /// The cancellation token to use. + /// , or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response SuggestGet(string indexName, string searchText, string suggesterName, string filter = null, bool? useFuzzyMatching = null, string highlightPostTag = null, string highlightPreTag = null, double? minimumCoverage = null, IEnumerable orderBy = null, IEnumerable searchFields = null, IEnumerable select = null, int? top = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(searchText, nameof(searchText)); + Argument.AssertNotNull(suggesterName, nameof(suggesterName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = SuggestGet(indexName, searchText, suggesterName, filter, useFuzzyMatching, highlightPostTag, highlightPreTag, minimumCoverage, orderBy, searchFields, select, top, context); + return Response.FromValue(SuggestDocumentsResult.FromResponse(response), response); + } + + /// + /// [Protocol Method] Suggests documents in the index that match the given partial query text. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// + /// The search text to use to suggest documents. Must be at least 1 character, and + /// no more than 100 characters. + /// + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + /// An OData expression that filters the documents considered for suggestions. + /// + /// A value indicating whether to use fuzzy matching for the suggestions query. + /// Default is false. When set to true, the query will find terms even if there's a + /// substituted or missing character in the search text. While this provides a + /// better experience in some scenarios, it comes at a performance cost as fuzzy + /// suggestions queries are slower and consume more resources. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. If omitted, hit highlighting of suggestions is disabled. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. If omitted, hit highlighting of suggestions is disabled. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by a suggestions query in order for the query to be reported as a + /// success. This parameter can be useful for ensuring search availability even for + /// services with only one replica. The default is 80. + /// + /// + /// The list of OData $orderby expressions by which to sort the results. Each + /// expression can be either a field name or a call to either the geo.distance() or + /// the search.score() functions. Each expression can be followed by asc to + /// indicate ascending, or desc to indicate descending. The default is ascending + /// order. Ties will be broken by the match scores of documents. If no $orderby is + /// specified, the default sort order is descending by document match score. There + /// can be at most 32 $orderby clauses. + /// + /// + /// The list of field names to search for the specified search text. Target fields + /// must be included in the specified suggester. + /// + /// + /// The list of fields to retrieve. If unspecified, only the key field will be + /// included in the results. + /// + /// + /// The number of suggestions to retrieve. The value must be a number between 1 and + /// 100. The default is 5. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task SuggestGetAsync(string indexName, string searchText, string suggesterName, string filter, bool? useFuzzyMatching, string highlightPostTag, string highlightPreTag, double? minimumCoverage, IEnumerable orderBy, IEnumerable searchFields, IEnumerable select, int? top, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(searchText, nameof(searchText)); + Argument.AssertNotNull(suggesterName, nameof(suggesterName)); + + using var scope = ClientDiagnostics.CreateScope("Documents.SuggestGet"); + scope.Start(); + try + { + using HttpMessage message = CreateSuggestGetRequest(indexName, searchText, suggesterName, filter, useFuzzyMatching, highlightPostTag, highlightPreTag, minimumCoverage, orderBy, searchFields, select, top, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Suggests documents in the index that match the given partial query text. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// + /// The search text to use to suggest documents. Must be at least 1 character, and + /// no more than 100 characters. + /// + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + /// An OData expression that filters the documents considered for suggestions. + /// + /// A value indicating whether to use fuzzy matching for the suggestions query. + /// Default is false. When set to true, the query will find terms even if there's a + /// substituted or missing character in the search text. While this provides a + /// better experience in some scenarios, it comes at a performance cost as fuzzy + /// suggestions queries are slower and consume more resources. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. If omitted, hit highlighting of suggestions is disabled. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. If omitted, hit highlighting of suggestions is disabled. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by a suggestions query in order for the query to be reported as a + /// success. This parameter can be useful for ensuring search availability even for + /// services with only one replica. The default is 80. + /// + /// + /// The list of OData $orderby expressions by which to sort the results. Each + /// expression can be either a field name or a call to either the geo.distance() or + /// the search.score() functions. Each expression can be followed by asc to + /// indicate ascending, or desc to indicate descending. The default is ascending + /// order. Ties will be broken by the match scores of documents. If no $orderby is + /// specified, the default sort order is descending by document match score. There + /// can be at most 32 $orderby clauses. + /// + /// + /// The list of field names to search for the specified search text. Target fields + /// must be included in the specified suggester. + /// + /// + /// The list of fields to retrieve. If unspecified, only the key field will be + /// included in the results. + /// + /// + /// The number of suggestions to retrieve. The value must be a number between 1 and + /// 100. The default is 5. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response SuggestGet(string indexName, string searchText, string suggesterName, string filter, bool? useFuzzyMatching, string highlightPostTag, string highlightPreTag, double? minimumCoverage, IEnumerable orderBy, IEnumerable searchFields, IEnumerable select, int? top, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(searchText, nameof(searchText)); + Argument.AssertNotNull(suggesterName, nameof(suggesterName)); + + using var scope = ClientDiagnostics.CreateScope("Documents.SuggestGet"); + scope.Start(); + try + { + using HttpMessage message = CreateSuggestGetRequest(indexName, searchText, suggesterName, filter, useFuzzyMatching, highlightPostTag, highlightPreTag, minimumCoverage, orderBy, searchFields, select, top, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Suggests documents in the index that match the given partial query text. + /// The name of the index. + /// The Suggest request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> SuggestPostAsync(string indexName, SuggestRequest suggestRequest, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(suggestRequest, nameof(suggestRequest)); + + using RequestContent content = suggestRequest.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await SuggestPostAsync(indexName, content, context).ConfigureAwait(false); + return Response.FromValue(SuggestDocumentsResult.FromResponse(response), response); + } + + /// Suggests documents in the index that match the given partial query text. + /// The name of the index. + /// The Suggest request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response SuggestPost(string indexName, SuggestRequest suggestRequest, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(suggestRequest, nameof(suggestRequest)); + + using RequestContent content = suggestRequest.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = SuggestPost(indexName, content, context); + return Response.FromValue(SuggestDocumentsResult.FromResponse(response), response); + } + + /// + /// [Protocol Method] Suggests documents in the index that match the given partial query text. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task SuggestPostAsync(string indexName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Documents.SuggestPost"); + scope.Start(); + try + { + using HttpMessage message = CreateSuggestPostRequest(indexName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Suggests documents in the index that match the given partial query text. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response SuggestPost(string indexName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Documents.SuggestPost"); + scope.Start(); + try + { + using HttpMessage message = CreateSuggestPostRequest(indexName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// Sends a batch of document write actions to the index. + /// The name of the index. + /// The batch of index actions. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> IndexAsync(string indexName, IndexBatch batch, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(batch, nameof(batch)); + + using RequestContent content = batch.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await IndexAsync(indexName, content, context).ConfigureAwait(false); + return Response.FromValue(IndexDocumentsResult.FromResponse(response), response); + } + + /// Sends a batch of document write actions to the index. + /// The name of the index. + /// The batch of index actions. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response Index(string indexName, IndexBatch batch, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(batch, nameof(batch)); + + using RequestContent content = batch.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = Index(indexName, content, context); + return Response.FromValue(IndexDocumentsResult.FromResponse(response), response); + } + + /// + /// [Protocol Method] Sends a batch of document write actions to the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task IndexAsync(string indexName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Documents.Index"); + scope.Start(); + try + { + using HttpMessage message = CreateIndexRequest(indexName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Sends a batch of document write actions to the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response Index(string indexName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Documents.Index"); + scope.Start(); + try + { + using HttpMessage message = CreateIndexRequest(indexName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Autocompletes incomplete query terms based on input text and matching terms in + /// the index. + /// + /// The name of the index. + /// The incomplete term which should be auto-completed. + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + /// + /// Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' + /// to get shingles and 'oneTermWithContext' to use the current context while + /// producing auto-completed terms. + /// + /// + /// An OData expression that filters the documents used to produce completed terms + /// for the Autocomplete result. + /// + /// + /// A value indicating whether to use fuzzy matching for the autocomplete query. + /// Default is false. When set to true, the query will find terms even if there's a + /// substituted or missing character in the search text. While this provides a + /// better experience in some scenarios, it comes at a performance cost as fuzzy + /// autocomplete queries are slower and consume more resources. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. If omitted, hit highlighting is disabled. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. If omitted, hit highlighting is disabled. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by an autocomplete query in order for the query to be reported as a + /// success. This parameter can be useful for ensuring search availability even for + /// services with only one replica. The default is 80. + /// + /// + /// The list of field names to consider when querying for auto-completed terms. + /// Target fields must be included in the specified suggester. + /// + /// + /// The number of auto-completed terms to retrieve. This must be a value between 1 + /// and 100. The default is 5. + /// + /// The cancellation token to use. + /// , or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> AutocompleteGetAsync(string indexName, string searchText, string suggesterName, AutocompleteMode? autocompleteMode = null, string filter = null, bool? useFuzzyMatching = null, string highlightPostTag = null, string highlightPreTag = null, double? minimumCoverage = null, IEnumerable searchFields = null, int? top = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(searchText, nameof(searchText)); + Argument.AssertNotNull(suggesterName, nameof(suggesterName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await AutocompleteGetAsync(indexName, searchText, suggesterName, autocompleteMode?.ToString(), filter, useFuzzyMatching, highlightPostTag, highlightPreTag, minimumCoverage, searchFields, top, context).ConfigureAwait(false); + return Response.FromValue(AutocompleteResult.FromResponse(response), response); + } + + /// + /// Autocompletes incomplete query terms based on input text and matching terms in + /// the index. + /// + /// The name of the index. + /// The incomplete term which should be auto-completed. + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + /// + /// Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' + /// to get shingles and 'oneTermWithContext' to use the current context while + /// producing auto-completed terms. + /// + /// + /// An OData expression that filters the documents used to produce completed terms + /// for the Autocomplete result. + /// + /// + /// A value indicating whether to use fuzzy matching for the autocomplete query. + /// Default is false. When set to true, the query will find terms even if there's a + /// substituted or missing character in the search text. While this provides a + /// better experience in some scenarios, it comes at a performance cost as fuzzy + /// autocomplete queries are slower and consume more resources. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. If omitted, hit highlighting is disabled. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. If omitted, hit highlighting is disabled. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by an autocomplete query in order for the query to be reported as a + /// success. This parameter can be useful for ensuring search availability even for + /// services with only one replica. The default is 80. + /// + /// + /// The list of field names to consider when querying for auto-completed terms. + /// Target fields must be included in the specified suggester. + /// + /// + /// The number of auto-completed terms to retrieve. This must be a value between 1 + /// and 100. The default is 5. + /// + /// The cancellation token to use. + /// , or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response AutocompleteGet(string indexName, string searchText, string suggesterName, AutocompleteMode? autocompleteMode = null, string filter = null, bool? useFuzzyMatching = null, string highlightPostTag = null, string highlightPreTag = null, double? minimumCoverage = null, IEnumerable searchFields = null, int? top = null, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(searchText, nameof(searchText)); + Argument.AssertNotNull(suggesterName, nameof(suggesterName)); + + RequestContext context = FromCancellationToken(cancellationToken); + Response response = AutocompleteGet(indexName, searchText, suggesterName, autocompleteMode?.ToString(), filter, useFuzzyMatching, highlightPostTag, highlightPreTag, minimumCoverage, searchFields, top, context); + return Response.FromValue(AutocompleteResult.FromResponse(response), response); + } + + /// + /// [Protocol Method] Autocompletes incomplete query terms based on input text and matching terms in + /// the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The incomplete term which should be auto-completed. + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + /// + /// Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' + /// to get shingles and 'oneTermWithContext' to use the current context while + /// producing auto-completed terms. Allowed values: "oneTerm" | "twoTerms" | "oneTermWithContext" + /// + /// + /// An OData expression that filters the documents used to produce completed terms + /// for the Autocomplete result. + /// + /// + /// A value indicating whether to use fuzzy matching for the autocomplete query. + /// Default is false. When set to true, the query will find terms even if there's a + /// substituted or missing character in the search text. While this provides a + /// better experience in some scenarios, it comes at a performance cost as fuzzy + /// autocomplete queries are slower and consume more resources. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. If omitted, hit highlighting is disabled. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. If omitted, hit highlighting is disabled. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by an autocomplete query in order for the query to be reported as a + /// success. This parameter can be useful for ensuring search availability even for + /// services with only one replica. The default is 80. + /// + /// + /// The list of field names to consider when querying for auto-completed terms. + /// Target fields must be included in the specified suggester. + /// + /// + /// The number of auto-completed terms to retrieve. This must be a value between 1 + /// and 100. The default is 5. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task AutocompleteGetAsync(string indexName, string searchText, string suggesterName, string autocompleteMode, string filter, bool? useFuzzyMatching, string highlightPostTag, string highlightPreTag, double? minimumCoverage, IEnumerable searchFields, int? top, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(searchText, nameof(searchText)); + Argument.AssertNotNull(suggesterName, nameof(suggesterName)); + + using var scope = ClientDiagnostics.CreateScope("Documents.AutocompleteGet"); + scope.Start(); + try + { + using HttpMessage message = CreateAutocompleteGetRequest(indexName, searchText, suggesterName, autocompleteMode, filter, useFuzzyMatching, highlightPostTag, highlightPreTag, minimumCoverage, searchFields, top, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Autocompletes incomplete query terms based on input text and matching terms in + /// the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The incomplete term which should be auto-completed. + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + /// + /// Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' + /// to get shingles and 'oneTermWithContext' to use the current context while + /// producing auto-completed terms. Allowed values: "oneTerm" | "twoTerms" | "oneTermWithContext" + /// + /// + /// An OData expression that filters the documents used to produce completed terms + /// for the Autocomplete result. + /// + /// + /// A value indicating whether to use fuzzy matching for the autocomplete query. + /// Default is false. When set to true, the query will find terms even if there's a + /// substituted or missing character in the search text. While this provides a + /// better experience in some scenarios, it comes at a performance cost as fuzzy + /// autocomplete queries are slower and consume more resources. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. If omitted, hit highlighting is disabled. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. If omitted, hit highlighting is disabled. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by an autocomplete query in order for the query to be reported as a + /// success. This parameter can be useful for ensuring search availability even for + /// services with only one replica. The default is 80. + /// + /// + /// The list of field names to consider when querying for auto-completed terms. + /// Target fields must be included in the specified suggester. + /// + /// + /// The number of auto-completed terms to retrieve. This must be a value between 1 + /// and 100. The default is 5. + /// + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// , or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response AutocompleteGet(string indexName, string searchText, string suggesterName, string autocompleteMode, string filter, bool? useFuzzyMatching, string highlightPostTag, string highlightPreTag, double? minimumCoverage, IEnumerable searchFields, int? top, RequestContext context) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(searchText, nameof(searchText)); + Argument.AssertNotNull(suggesterName, nameof(suggesterName)); + + using var scope = ClientDiagnostics.CreateScope("Documents.AutocompleteGet"); + scope.Start(); + try + { + using HttpMessage message = CreateAutocompleteGetRequest(indexName, searchText, suggesterName, autocompleteMode, filter, useFuzzyMatching, highlightPostTag, highlightPreTag, minimumCoverage, searchFields, top, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// Autocompletes incomplete query terms based on input text and matching terms in + /// the index. + /// + /// The name of the index. + /// The definition of the Autocomplete request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual async Task> AutocompletePostAsync(string indexName, AutocompleteRequest autocompleteRequest, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(autocompleteRequest, nameof(autocompleteRequest)); + + using RequestContent content = autocompleteRequest.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = await AutocompletePostAsync(indexName, content, context).ConfigureAwait(false); + return Response.FromValue(AutocompleteResult.FromResponse(response), response); + } + + /// + /// Autocompletes incomplete query terms based on input text and matching terms in + /// the index. + /// + /// The name of the index. + /// The definition of the Autocomplete request. + /// The cancellation token to use. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// + public virtual Response AutocompletePost(string indexName, AutocompleteRequest autocompleteRequest, CancellationToken cancellationToken = default) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(autocompleteRequest, nameof(autocompleteRequest)); + + using RequestContent content = autocompleteRequest.ToRequestContent(); + RequestContext context = FromCancellationToken(cancellationToken); + Response response = AutocompletePost(indexName, content, context); + return Response.FromValue(AutocompleteResult.FromResponse(response), response); + } + + /// + /// [Protocol Method] Autocompletes incomplete query terms based on input text and matching terms in + /// the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual async Task AutocompletePostAsync(string indexName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Documents.AutocompletePost"); + scope.Start(); + try + { + using HttpMessage message = CreateAutocompletePostRequest(indexName, content, context); + return await _pipeline.ProcessMessageAsync(message, context).ConfigureAwait(false); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + /// + /// [Protocol Method] Autocompletes incomplete query terms based on input text and matching terms in + /// the index. + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// Please try the simpler convenience overload with strongly typed models first. + /// + /// + /// + /// + /// The name of the index. + /// The content to send as the body of the request. + /// The request context, which can override default behaviors of the client pipeline on a per-call basis. + /// or is null. + /// is an empty string, and was expected to be non-empty. + /// Service returned a non-success status code. + /// The response returned from the service. + /// + public virtual Response AutocompletePost(string indexName, RequestContent content, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(indexName, nameof(indexName)); + Argument.AssertNotNull(content, nameof(content)); + + using var scope = ClientDiagnostics.CreateScope("Documents.AutocompletePost"); + scope.Start(); + try + { + using HttpMessage message = CreateAutocompletePostRequest(indexName, content, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateCountRequest(string indexName, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes('", false); + uri.AppendPath(indexName, true); + uri.AppendPath("')/docs/$count", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "text/plain"); + return message; + } + + internal HttpMessage CreateSearchGetRequest(string indexName, string searchText, bool? includeTotalResultCount, IEnumerable facets, string filter, IEnumerable highlightFields, string highlightPostTag, string highlightPreTag, double? minimumCoverage, IEnumerable orderBy, string queryType, IEnumerable scoringParameters, string scoringProfile, IEnumerable searchFields, string searchMode, string scoringStatistics, string sessionId, IEnumerable select, int? skip, int? top, string semanticConfiguration, string semanticErrorHandling, int? semanticMaxWaitInMilliseconds, string answers, string captions, string semanticQuery, string queryRewrites, string debug, string queryLanguage, string speller, IEnumerable semanticFields, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes('", false); + uri.AppendPath(indexName, true); + uri.AppendPath("')/docs", false); + uri.AppendQuery("api-version", _apiVersion, true); + if (searchText != null) + { + uri.AppendQuery("search", searchText, true); + } + if (includeTotalResultCount != null) + { + uri.AppendQuery("$count", includeTotalResultCount.Value, true); + } + if (facets != null && !(facets is ChangeTrackingList changeTrackingList && changeTrackingList.IsUndefined)) + { + foreach (var param in facets) + { + uri.AppendQuery("facet", param, true); + } + } + if (filter != null) + { + uri.AppendQuery("$filter", filter, true); + } + if (highlightFields != null && !(highlightFields is ChangeTrackingList changeTrackingList0 && changeTrackingList0.IsUndefined)) + { + uri.AppendQueryDelimited("highlight", highlightFields, ",", true); + } + if (highlightPostTag != null) + { + uri.AppendQuery("highlightPostTag", highlightPostTag, true); + } + if (highlightPreTag != null) + { + uri.AppendQuery("highlightPreTag", highlightPreTag, true); + } + if (minimumCoverage != null) + { + uri.AppendQuery("minimumCoverage", minimumCoverage.Value, true); + } + if (orderBy != null && !(orderBy is ChangeTrackingList changeTrackingList1 && changeTrackingList1.IsUndefined)) + { + uri.AppendQueryDelimited("$orderby", orderBy, ",", true); + } + if (queryType != null) + { + uri.AppendQuery("queryType", queryType, true); + } + if (scoringParameters != null && !(scoringParameters is ChangeTrackingList changeTrackingList2 && changeTrackingList2.IsUndefined)) + { + foreach (var param in scoringParameters) + { + uri.AppendQuery("scoringParameter", param, true); + } + } + if (scoringProfile != null) + { + uri.AppendQuery("scoringProfile", scoringProfile, true); + } + if (searchFields != null && !(searchFields is ChangeTrackingList changeTrackingList3 && changeTrackingList3.IsUndefined)) + { + uri.AppendQueryDelimited("searchFields", searchFields, ",", true); + } + if (searchMode != null) + { + uri.AppendQuery("searchMode", searchMode, true); + } + if (scoringStatistics != null) + { + uri.AppendQuery("scoringStatistics", scoringStatistics, true); + } + if (sessionId != null) + { + uri.AppendQuery("sessionId", sessionId, true); + } + if (select != null && !(select is ChangeTrackingList changeTrackingList4 && changeTrackingList4.IsUndefined)) + { + uri.AppendQueryDelimited("$select", select, ",", true); + } + if (skip != null) + { + uri.AppendQuery("$skip", skip.Value, true); + } + if (top != null) + { + uri.AppendQuery("$top", top.Value, true); + } + if (semanticConfiguration != null) + { + uri.AppendQuery("semanticConfiguration", semanticConfiguration, true); + } + if (semanticErrorHandling != null) + { + uri.AppendQuery("semanticErrorHandling", semanticErrorHandling, true); + } + if (semanticMaxWaitInMilliseconds != null) + { + uri.AppendQuery("semanticMaxWaitInMilliseconds", semanticMaxWaitInMilliseconds.Value, true); + } + if (answers != null) + { + uri.AppendQuery("answers", answers, true); + } + if (captions != null) + { + uri.AppendQuery("captions", captions, true); + } + if (semanticQuery != null) + { + uri.AppendQuery("semanticQuery", semanticQuery, true); + } + if (queryRewrites != null) + { + uri.AppendQuery("queryRewrites", queryRewrites, true); + } + if (debug != null) + { + uri.AppendQuery("debug", debug, true); + } + if (queryLanguage != null) + { + uri.AppendQuery("queryLanguage", queryLanguage, true); + } + if (speller != null) + { + uri.AppendQuery("speller", speller, true); + } + if (semanticFields != null && !(semanticFields is ChangeTrackingList changeTrackingList5 && changeTrackingList5.IsUndefined)) + { + uri.AppendQueryDelimited("semanticFields", semanticFields, ",", true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateSearchPostRequest(string indexName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes('", false); + uri.AppendPath(indexName, true); + uri.AppendPath("')/docs/search.post.search", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateGetDocumentRequest(string indexName, string key, IEnumerable selectedFields, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes('", false); + uri.AppendPath(indexName, true); + uri.AppendPath("')/docs('", false); + uri.AppendPath(key, true); + uri.AppendPath("')", false); + uri.AppendQuery("api-version", _apiVersion, true); + if (selectedFields != null && !(selectedFields is ChangeTrackingList changeTrackingList && changeTrackingList.IsUndefined)) + { + uri.AppendQueryDelimited("$select", selectedFields, ",", true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateSuggestGetRequest(string indexName, string searchText, string suggesterName, string filter, bool? useFuzzyMatching, string highlightPostTag, string highlightPreTag, double? minimumCoverage, IEnumerable orderBy, IEnumerable searchFields, IEnumerable select, int? top, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes('", false); + uri.AppendPath(indexName, true); + uri.AppendPath("')/docs/search.suggest", false); + uri.AppendQuery("search", searchText, true); + uri.AppendQuery("suggesterName", suggesterName, true); + uri.AppendQuery("api-version", _apiVersion, true); + if (filter != null) + { + uri.AppendQuery("$filter", filter, true); + } + if (useFuzzyMatching != null) + { + uri.AppendQuery("fuzzy", useFuzzyMatching.Value, true); + } + if (highlightPostTag != null) + { + uri.AppendQuery("highlightPostTag", highlightPostTag, true); + } + if (highlightPreTag != null) + { + uri.AppendQuery("highlightPreTag", highlightPreTag, true); + } + if (minimumCoverage != null) + { + uri.AppendQuery("minimumCoverage", minimumCoverage.Value, true); + } + if (orderBy != null && !(orderBy is ChangeTrackingList changeTrackingList && changeTrackingList.IsUndefined)) + { + uri.AppendQueryDelimited("$orderby", orderBy, ",", true); + } + if (searchFields != null && !(searchFields is ChangeTrackingList changeTrackingList0 && changeTrackingList0.IsUndefined)) + { + uri.AppendQueryDelimited("searchFields", searchFields, ",", true); + } + if (select != null && !(select is ChangeTrackingList changeTrackingList1 && changeTrackingList1.IsUndefined)) + { + uri.AppendQueryDelimited("$select", select, ",", true); + } + if (top != null) + { + uri.AppendQuery("$top", top.Value, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateSuggestPostRequest(string indexName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes('", false); + uri.AppendPath(indexName, true); + uri.AppendPath("')/docs/search.post.suggest", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateIndexRequest(string indexName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200207); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes('", false); + uri.AppendPath(indexName, true); + uri.AppendPath("')/docs/search.index", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + internal HttpMessage CreateAutocompleteGetRequest(string indexName, string searchText, string suggesterName, string autocompleteMode, string filter, bool? useFuzzyMatching, string highlightPostTag, string highlightPreTag, double? minimumCoverage, IEnumerable searchFields, int? top, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes('", false); + uri.AppendPath(indexName, true); + uri.AppendPath("')/docs/search.autocomplete", false); + uri.AppendQuery("search", searchText, true); + uri.AppendQuery("suggesterName", suggesterName, true); + uri.AppendQuery("api-version", _apiVersion, true); + if (autocompleteMode != null) + { + uri.AppendQuery("autocompleteMode", autocompleteMode, true); + } + if (filter != null) + { + uri.AppendQuery("$filter", filter, true); + } + if (useFuzzyMatching != null) + { + uri.AppendQuery("fuzzy", useFuzzyMatching.Value, true); + } + if (highlightPostTag != null) + { + uri.AppendQuery("highlightPostTag", highlightPostTag, true); + } + if (highlightPreTag != null) + { + uri.AppendQuery("highlightPreTag", highlightPreTag, true); + } + if (minimumCoverage != null) + { + uri.AppendQuery("minimumCoverage", minimumCoverage.Value, true); + } + if (searchFields != null && !(searchFields is ChangeTrackingList changeTrackingList && changeTrackingList.IsUndefined)) + { + uri.AppendQueryDelimited("searchFields", searchFields, ",", true); + } + if (top != null) + { + uri.AppendQuery("$top", top.Value, true); + } + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + internal HttpMessage CreateAutocompletePostRequest(string indexName, RequestContent content, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Post; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendPath("/indexes('", false); + uri.AppendPath(indexName, true); + uri.AppendPath("')/docs/search.post.autocomplete", false); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + request.Headers.Add("Content-Type", "application/json"); + request.Content = content; + return message; + } + + private static RequestContext DefaultRequestContext = new RequestContext(); + internal static RequestContext FromCancellationToken(CancellationToken cancellationToken = default) + { + if (!cancellationToken.CanBeCanceled) + { + return DefaultRequestContext; + } + + return new RequestContext() { CancellationToken = cancellationToken }; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + private static ResponseClassifier _responseClassifier200207; + private static ResponseClassifier ResponseClassifier200207 => _responseClassifier200207 ??= new StatusCodeClassifier(stackalloc ushort[] { 200, 207 }); + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/FacetResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/FacetResult.Serialization.cs new file mode 100644 index 000000000000..2b7710da8a59 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/FacetResult.Serialization.cs @@ -0,0 +1,206 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class FacetResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(FacetResult)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(Count)) + { + writer.WritePropertyName("count"u8); + writer.WriteNumberValue(Count.Value); + } + if (options.Format != "W" && Optional.IsCollectionDefined(Facets)) + { + writer.WritePropertyName("@search.facets"u8); + writer.WriteStartObject(); + foreach (var item in Facets) + { + writer.WritePropertyName(item.Key); + if (item.Value == null) + { + writer.WriteNullValue(); + continue; + } + writer.WriteStartArray(); + foreach (var item0 in item.Value) + { + writer.WriteObjectValue(item0, options); + } + writer.WriteEndArray(); + } + writer.WriteEndObject(); + } + if (options.Format != "W" && Optional.IsDefined(Sum)) + { + writer.WritePropertyName("sum"u8); + writer.WriteNumberValue(Sum.Value); + } + foreach (var item in AdditionalProperties) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + + FacetResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(FacetResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeFacetResult(document.RootElement, options); + } + + internal static FacetResult DeserializeFacetResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + long? count = default; + IReadOnlyDictionary> searchFacets = default; + long? sum = default; + IReadOnlyDictionary additionalProperties = default; + Dictionary additionalPropertiesDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("count"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + count = property.Value.GetInt64(); + continue; + } + if (property.NameEquals("@search.facets"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + Dictionary> dictionary = new Dictionary>(); + foreach (var property0 in property.Value.EnumerateObject()) + { + if (property0.Value.ValueKind == JsonValueKind.Null) + { + dictionary.Add(property0.Name, null); + } + else + { + List array = new List(); + foreach (var item in property0.Value.EnumerateArray()) + { + array.Add(DeserializeFacetResult(item, options)); + } + dictionary.Add(property0.Name, array); + } + } + searchFacets = dictionary; + continue; + } + if (property.NameEquals("sum"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + sum = property.Value.GetInt64(); + continue; + } + additionalPropertiesDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + additionalProperties = additionalPropertiesDictionary; + return new FacetResult(count, searchFacets ?? new ChangeTrackingDictionary>(), sum, additionalProperties); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(FacetResult)} does not support writing '{options.Format}' format."); + } + } + + FacetResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeFacetResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(FacetResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static FacetResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeFacetResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/FacetResult.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/FacetResult.cs new file mode 100644 index 000000000000..405bee198b84 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/FacetResult.cs @@ -0,0 +1,92 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// A single bucket of a facet query result. Reports the number of documents with a + /// field value falling within a particular range or having a particular value or + /// interval. + /// + public partial class FacetResult + { + /// Initializes a new instance of . + internal FacetResult() + { + Facets = new ChangeTrackingDictionary>(); + AdditionalProperties = new ChangeTrackingDictionary(); + } + + /// Initializes a new instance of . + /// + /// The approximate count of documents falling within the bucket described by this + /// facet. + /// + /// + /// The nested facet query results for the search operation, organized as a + /// collection of buckets for each faceted field; null if the query did not contain + /// any nested facets. + /// + /// The resulting total sum for the facet when a sum metric is requested. + /// Additional Properties. + internal FacetResult(long? count, IReadOnlyDictionary> facets, long? sum, IReadOnlyDictionary additionalProperties) + { + Count = count; + Facets = facets; + Sum = sum; + AdditionalProperties = additionalProperties; + } + + /// + /// The approximate count of documents falling within the bucket described by this + /// facet. + /// + public long? Count { get; } + /// + /// The nested facet query results for the search operation, organized as a + /// collection of buckets for each faceted field; null if the query did not contain + /// any nested facets. + /// + public IReadOnlyDictionary> Facets { get; } + /// The resulting total sum for the facet when a sum metric is requested. + public long? Sum { get; } + /// + /// Additional Properties + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + public IReadOnlyDictionary AdditionalProperties { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/HybridCountAndFacetMode.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/HybridCountAndFacetMode.cs new file mode 100644 index 000000000000..6866f76ec5be --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/HybridCountAndFacetMode.cs @@ -0,0 +1,62 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// + /// Determines whether the count and facets should includes all documents that + /// matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' + /// window. The default value is 'countAllResults'. + /// + public readonly partial struct HybridCountAndFacetMode : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public HybridCountAndFacetMode(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string CountRetrievableResultsValue = "countRetrievableResults"; + private const string CountAllResultsValue = "countAllResults"; + + /// + /// Only include documents that were matched within the 'maxTextRecallSize' + /// retrieval window when computing 'count' and 'facets'. + /// + public static HybridCountAndFacetMode CountRetrievableResults { get; } = new HybridCountAndFacetMode(CountRetrievableResultsValue); + /// + /// Include all documents that were matched by the search query when computing 'count' + /// and 'facets', regardless of whether or not those documents are within + /// the 'maxTextRecallSize' retrieval window. + /// + public static HybridCountAndFacetMode CountAllResults { get; } = new HybridCountAndFacetMode(CountAllResultsValue); + /// Determines if two values are the same. + public static bool operator ==(HybridCountAndFacetMode left, HybridCountAndFacetMode right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(HybridCountAndFacetMode left, HybridCountAndFacetMode right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator HybridCountAndFacetMode(string value) => new HybridCountAndFacetMode(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is HybridCountAndFacetMode other && Equals(other); + /// + public bool Equals(HybridCountAndFacetMode other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/HybridSearch.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/HybridSearch.Serialization.cs new file mode 100644 index 000000000000..4d63cdd13a55 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/HybridSearch.Serialization.cs @@ -0,0 +1,164 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class HybridSearch : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(HybridSearch)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(MaxTextRecallSize)) + { + writer.WritePropertyName("maxTextRecallSize"u8); + writer.WriteNumberValue(MaxTextRecallSize.Value); + } + if (Optional.IsDefined(CountAndFacetMode)) + { + writer.WritePropertyName("countAndFacetMode"u8); + writer.WriteStringValue(CountAndFacetMode.Value.ToString()); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + HybridSearch IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(HybridSearch)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeHybridSearch(document.RootElement, options); + } + + internal static HybridSearch DeserializeHybridSearch(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? maxTextRecallSize = default; + HybridCountAndFacetMode? countAndFacetMode = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("maxTextRecallSize"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + maxTextRecallSize = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("countAndFacetMode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + countAndFacetMode = new HybridCountAndFacetMode(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new HybridSearch(maxTextRecallSize, countAndFacetMode, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(HybridSearch)} does not support writing '{options.Format}' format."); + } + } + + HybridSearch IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeHybridSearch(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(HybridSearch)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static HybridSearch FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeHybridSearch(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/HybridSearch.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/HybridSearch.cs new file mode 100644 index 000000000000..6a1f882ff2c6 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/HybridSearch.cs @@ -0,0 +1,91 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// TThe query parameters to configure hybrid search behaviors. + public partial class HybridSearch + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public HybridSearch() + { + } + + /// Initializes a new instance of . + /// + /// Determines the maximum number of documents to be retrieved by the text query + /// portion of a hybrid search request. Those documents will be combined with the + /// documents matching the vector queries to produce a single final list of + /// results. Choosing a larger maxTextRecallSize value will allow retrieving and + /// paging through more documents (using the top and skip parameters), at the cost + /// of higher resource utilization and higher latency. The value needs to be + /// between 1 and 10,000. Default is 1000. + /// + /// + /// Determines whether the count and facets should includes all documents that + /// matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window. + /// + /// Keeps track of any properties unknown to the library. + internal HybridSearch(int? maxTextRecallSize, HybridCountAndFacetMode? countAndFacetMode, IDictionary serializedAdditionalRawData) + { + MaxTextRecallSize = maxTextRecallSize; + CountAndFacetMode = countAndFacetMode; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// + /// Determines the maximum number of documents to be retrieved by the text query + /// portion of a hybrid search request. Those documents will be combined with the + /// documents matching the vector queries to produce a single final list of + /// results. Choosing a larger maxTextRecallSize value will allow retrieving and + /// paging through more documents (using the top and skip parameters), at the cost + /// of higher resource utilization and higher latency. The value needs to be + /// between 1 and 10,000. Default is 1000. + /// + public int? MaxTextRecallSize { get; set; } + /// + /// Determines whether the count and facets should includes all documents that + /// matched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window. + /// + public HybridCountAndFacetMode? CountAndFacetMode { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexAction.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexAction.Serialization.cs new file mode 100644 index 000000000000..48c0c39204d0 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexAction.Serialization.cs @@ -0,0 +1,143 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class IndexAction : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexAction)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(ActionType)) + { + writer.WritePropertyName("@search.action"u8); + writer.WriteStringValue(ActionType.Value.ToString()); + } + foreach (var item in AdditionalProperties) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + + IndexAction IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexAction)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeIndexAction(document.RootElement, options); + } + + internal static IndexAction DeserializeIndexAction(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IndexActionType? searchAction = default; + IDictionary additionalProperties = default; + Dictionary additionalPropertiesDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@search.action"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + searchAction = new IndexActionType(property.Value.GetString()); + continue; + } + additionalPropertiesDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + additionalProperties = additionalPropertiesDictionary; + return new IndexAction(searchAction, additionalProperties); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(IndexAction)} does not support writing '{options.Format}' format."); + } + } + + IndexAction IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexAction(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(IndexAction)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static IndexAction FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexAction(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexAction.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexAction.cs new file mode 100644 index 000000000000..e852e19f0a9f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexAction.cs @@ -0,0 +1,65 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// Represents an index action that operates on a document. + public partial class IndexAction + { + /// Initializes a new instance of . + public IndexAction() + { + AdditionalProperties = new ChangeTrackingDictionary(); + } + + /// Initializes a new instance of . + /// The operation to perform on a document in an indexing batch. + /// Additional Properties. + internal IndexAction(IndexActionType? actionType, IDictionary additionalProperties) + { + ActionType = actionType; + AdditionalProperties = additionalProperties; + } + + /// The operation to perform on a document in an indexing batch. + public IndexActionType? ActionType { get; set; } + /// + /// Additional Properties + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + public IDictionary AdditionalProperties { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexActionType.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexActionType.cs new file mode 100644 index 000000000000..63c33383f508 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexActionType.cs @@ -0,0 +1,74 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// The operation to perform on a document in an indexing batch. + public readonly partial struct IndexActionType : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public IndexActionType(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string UploadValue = "upload"; + private const string MergeValue = "merge"; + private const string MergeOrUploadValue = "mergeOrUpload"; + private const string DeleteValue = "delete"; + + /// + /// Inserts the document into the index if it is new and updates it if it exists. + /// All fields are replaced in the update case. + /// + public static IndexActionType Upload { get; } = new IndexActionType(UploadValue); + /// + /// Merges the specified field values with an existing document. If the document + /// does not exist, the merge will fail. Any field you specify in a merge will + /// replace the existing field in the document. This also applies to collections of + /// primitive and complex types. + /// + public static IndexActionType Merge { get; } = new IndexActionType(MergeValue); + /// + /// Behaves like merge if a document with the given key already exists in the + /// index. If the document does not exist, it behaves like upload with a new + /// document. + /// + public static IndexActionType MergeOrUpload { get; } = new IndexActionType(MergeOrUploadValue); + /// + /// Removes the specified document from the index. Any field you specify in a + /// delete operation other than the key field will be ignored. If you want to + /// remove an individual field from a document, use merge instead and set the field + /// explicitly to null. + /// + public static IndexActionType Delete { get; } = new IndexActionType(DeleteValue); + /// Determines if two values are the same. + public static bool operator ==(IndexActionType left, IndexActionType right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(IndexActionType left, IndexActionType right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator IndexActionType(string value) => new IndexActionType(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is IndexActionType other && Equals(other); + /// + public bool Equals(IndexActionType other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexBatch.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexBatch.Serialization.cs new file mode 100644 index 000000000000..3cb1af680dde --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexBatch.Serialization.cs @@ -0,0 +1,152 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class IndexBatch : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexBatch)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("value"u8); + writer.WriteStartArray(); + foreach (var item in Value) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + IndexBatch IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexBatch)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeIndexBatch(document.RootElement, options); + } + + internal static IndexBatch DeserializeIndexBatch(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList value = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("value"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(IndexAction.DeserializeIndexAction(item, options)); + } + value = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new IndexBatch(value, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(IndexBatch)} does not support writing '{options.Format}' format."); + } + } + + IndexBatch IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexBatch(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(IndexBatch)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static IndexBatch FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexBatch(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexBatch.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexBatch.cs new file mode 100644 index 000000000000..1113c0d401a0 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexBatch.cs @@ -0,0 +1,76 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Search +{ + /// Contains a batch of document write actions to send to the index. + public partial class IndexBatch + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The actions in the batch. + /// is null. + public IndexBatch(IEnumerable value) + { + Argument.AssertNotNull(value, nameof(value)); + + Value = value.ToList(); + } + + /// Initializes a new instance of . + /// The actions in the batch. + /// Keeps track of any properties unknown to the library. + internal IndexBatch(IList value, IDictionary serializedAdditionalRawData) + { + Value = value; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal IndexBatch() + { + } + + /// The actions in the batch. + public IList Value { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexDocumentsResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexDocumentsResult.Serialization.cs new file mode 100644 index 000000000000..f3ddd549d47c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexDocumentsResult.Serialization.cs @@ -0,0 +1,152 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class IndexDocumentsResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexDocumentsResult)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("value"u8); + writer.WriteStartArray(); + foreach (var item in Value) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + IndexDocumentsResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexDocumentsResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeIndexDocumentsResult(document.RootElement, options); + } + + internal static IndexDocumentsResult DeserializeIndexDocumentsResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IReadOnlyList value = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("value"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(IndexingResult.DeserializeIndexingResult(item, options)); + } + value = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new IndexDocumentsResult(value, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(IndexDocumentsResult)} does not support writing '{options.Format}' format."); + } + } + + IndexDocumentsResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexDocumentsResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(IndexDocumentsResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static IndexDocumentsResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexDocumentsResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexDocumentsResult.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexDocumentsResult.cs new file mode 100644 index 000000000000..720e9bdaa242 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexDocumentsResult.cs @@ -0,0 +1,79 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Search +{ + /// + /// Response containing the status of operations for all documents in the indexing + /// request. + /// + public partial class IndexDocumentsResult + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The list of status information for each document in the indexing request. + /// is null. + internal IndexDocumentsResult(IEnumerable value) + { + Argument.AssertNotNull(value, nameof(value)); + + Value = value.ToList(); + } + + /// Initializes a new instance of . + /// The list of status information for each document in the indexing request. + /// Keeps track of any properties unknown to the library. + internal IndexDocumentsResult(IReadOnlyList value, IDictionary serializedAdditionalRawData) + { + Value = value; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal IndexDocumentsResult() + { + } + + /// The list of status information for each document in the indexing request. + public IReadOnlyList Value { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexingResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexingResult.Serialization.cs new file mode 100644 index 000000000000..79d74b6706ae --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexingResult.Serialization.cs @@ -0,0 +1,169 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class IndexingResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexingResult)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("key"u8); + writer.WriteStringValue(Key); + if (Optional.IsDefined(ErrorMessage)) + { + writer.WritePropertyName("errorMessage"u8); + writer.WriteStringValue(ErrorMessage); + } + writer.WritePropertyName("status"u8); + writer.WriteBooleanValue(Status); + writer.WritePropertyName("statusCode"u8); + writer.WriteNumberValue(StatusCode); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + IndexingResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(IndexingResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeIndexingResult(document.RootElement, options); + } + + internal static IndexingResult DeserializeIndexingResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string key = default; + string errorMessage = default; + bool status = default; + int statusCode = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("key"u8)) + { + key = property.Value.GetString(); + continue; + } + if (property.NameEquals("errorMessage"u8)) + { + errorMessage = property.Value.GetString(); + continue; + } + if (property.NameEquals("status"u8)) + { + status = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("statusCode"u8)) + { + statusCode = property.Value.GetInt32(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new IndexingResult(key, errorMessage, status, statusCode, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(IndexingResult)} does not support writing '{options.Format}' format."); + } + } + + IndexingResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexingResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(IndexingResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static IndexingResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeIndexingResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexingResult.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexingResult.cs new file mode 100644 index 000000000000..b86cf643dbd1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/IndexingResult.cs @@ -0,0 +1,124 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// Status of an indexing operation for a single document. + public partial class IndexingResult + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The key of a document that was in the indexing request. + /// + /// A value indicating whether the indexing operation succeeded for the document + /// identified by the key. + /// + /// + /// The status code of the indexing operation. Possible values include: 200 for a + /// successful update or delete, 201 for successful document creation, 400 for a + /// malformed input document, 404 for document not found, 409 for a version + /// conflict, 422 when the index is temporarily unavailable, or 503 for when the + /// service is too busy. + /// + /// is null. + internal IndexingResult(string key, bool status, int statusCode) + { + Argument.AssertNotNull(key, nameof(key)); + + Key = key; + Status = status; + StatusCode = statusCode; + } + + /// Initializes a new instance of . + /// The key of a document that was in the indexing request. + /// + /// The error message explaining why the indexing operation failed for the document + /// identified by the key; null if indexing succeeded. + /// + /// + /// A value indicating whether the indexing operation succeeded for the document + /// identified by the key. + /// + /// + /// The status code of the indexing operation. Possible values include: 200 for a + /// successful update or delete, 201 for successful document creation, 400 for a + /// malformed input document, 404 for document not found, 409 for a version + /// conflict, 422 when the index is temporarily unavailable, or 503 for when the + /// service is too busy. + /// + /// Keeps track of any properties unknown to the library. + internal IndexingResult(string key, string errorMessage, bool status, int statusCode, IDictionary serializedAdditionalRawData) + { + Key = key; + ErrorMessage = errorMessage; + Status = status; + StatusCode = statusCode; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal IndexingResult() + { + } + + /// The key of a document that was in the indexing request. + public string Key { get; } + /// + /// The error message explaining why the indexing operation failed for the document + /// identified by the key; null if indexing succeeded. + /// + public string ErrorMessage { get; } + /// + /// A value indicating whether the indexing operation succeeded for the document + /// identified by the key. + /// + public bool Status { get; } + /// + /// The status code of the indexing operation. Possible values include: 200 for a + /// successful update or delete, 201 for successful document creation, 400 for a + /// malformed input document, 404 for document not found, 409 for a version + /// conflict, 422 when the index is temporarily unavailable, or 503 for when the + /// service is too busy. + /// + public int StatusCode { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/Argument.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/Argument.cs new file mode 100644 index 000000000000..2966720d5ab3 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/Argument.cs @@ -0,0 +1,129 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + internal static class Argument + { + public static void AssertNotNull(T value, string name) + { + if (value is null) + { + throw new ArgumentNullException(name); + } + } + + public static void AssertNotNull(T? value, string name) + where T : struct + { + if (!value.HasValue) + { + throw new ArgumentNullException(name); + } + } + + public static void AssertNotNullOrEmpty(IEnumerable value, string name) + { + if (value is null) + { + throw new ArgumentNullException(name); + } + if (value is ICollection collectionOfT && collectionOfT.Count == 0) + { + throw new ArgumentException("Value cannot be an empty collection.", name); + } + if (value is ICollection collection && collection.Count == 0) + { + throw new ArgumentException("Value cannot be an empty collection.", name); + } + using IEnumerator e = value.GetEnumerator(); + if (!e.MoveNext()) + { + throw new ArgumentException("Value cannot be an empty collection.", name); + } + } + + public static void AssertNotNullOrEmpty(string value, string name) + { + if (value is null) + { + throw new ArgumentNullException(name); + } + if (value.Length == 0) + { + throw new ArgumentException("Value cannot be an empty string.", name); + } + } + + public static void AssertNotNullOrWhiteSpace(string value, string name) + { + if (value is null) + { + throw new ArgumentNullException(name); + } + if (string.IsNullOrWhiteSpace(value)) + { + throw new ArgumentException("Value cannot be empty or contain only white-space characters.", name); + } + } + + public static void AssertNotDefault(ref T value, string name) + where T : struct, IEquatable + { + if (value.Equals(default)) + { + throw new ArgumentException("Value cannot be empty.", name); + } + } + + public static void AssertInRange(T value, T minimum, T maximum, string name) + where T : notnull, IComparable + { + if (minimum.CompareTo(value) > 0) + { + throw new ArgumentOutOfRangeException(name, "Value is less than the minimum allowed."); + } + if (maximum.CompareTo(value) < 0) + { + throw new ArgumentOutOfRangeException(name, "Value is greater than the maximum allowed."); + } + } + + public static void AssertEnumDefined(Type enumType, object value, string name) + { + if (!Enum.IsDefined(enumType, value)) + { + throw new ArgumentException($"Value not defined for {enumType.FullName}.", name); + } + } + + public static T CheckNotNull(T value, string name) + where T : class + { + AssertNotNull(value, name); + return value; + } + + public static string CheckNotNullOrEmpty(string value, string name) + { + AssertNotNullOrEmpty(value, name); + return value; + } + + public static void AssertNull(T value, string name, string message = null) + { + if (value != null) + { + throw new ArgumentException(message ?? "Value must be null.", name); + } + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/ChangeTrackingDictionary.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/ChangeTrackingDictionary.cs new file mode 100644 index 000000000000..1fc1838d3c67 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/ChangeTrackingDictionary.cs @@ -0,0 +1,167 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + internal class ChangeTrackingDictionary : IDictionary, IReadOnlyDictionary where TKey : notnull + { + private IDictionary _innerDictionary; + + public ChangeTrackingDictionary() + { + } + + public ChangeTrackingDictionary(IDictionary dictionary) + { + if (dictionary == null) + { + return; + } + _innerDictionary = new Dictionary(dictionary); + } + + public ChangeTrackingDictionary(IReadOnlyDictionary dictionary) + { + if (dictionary == null) + { + return; + } + _innerDictionary = new Dictionary(); + foreach (var pair in dictionary) + { + _innerDictionary.Add(pair); + } + } + + public bool IsUndefined => _innerDictionary == null; + + public int Count => IsUndefined ? 0 : EnsureDictionary().Count; + + public bool IsReadOnly => IsUndefined ? false : EnsureDictionary().IsReadOnly; + + public ICollection Keys => IsUndefined ? Array.Empty() : EnsureDictionary().Keys; + + public ICollection Values => IsUndefined ? Array.Empty() : EnsureDictionary().Values; + + public TValue this[TKey key] + { + get + { + if (IsUndefined) + { + throw new KeyNotFoundException(nameof(key)); + } + return EnsureDictionary()[key]; + } + set + { + EnsureDictionary()[key] = value; + } + } + + IEnumerable IReadOnlyDictionary.Keys => Keys; + + IEnumerable IReadOnlyDictionary.Values => Values; + + public IEnumerator> GetEnumerator() + { + if (IsUndefined) + { + IEnumerator> enumerateEmpty() + { + yield break; + } + return enumerateEmpty(); + } + return EnsureDictionary().GetEnumerator(); + } + + IEnumerator IEnumerable.GetEnumerator() + { + return GetEnumerator(); + } + + public void Add(KeyValuePair item) + { + EnsureDictionary().Add(item); + } + + public void Clear() + { + EnsureDictionary().Clear(); + } + + public bool Contains(KeyValuePair item) + { + if (IsUndefined) + { + return false; + } + return EnsureDictionary().Contains(item); + } + + public void CopyTo(KeyValuePair[] array, int index) + { + if (IsUndefined) + { + return; + } + EnsureDictionary().CopyTo(array, index); + } + + public bool Remove(KeyValuePair item) + { + if (IsUndefined) + { + return false; + } + return EnsureDictionary().Remove(item); + } + + public void Add(TKey key, TValue value) + { + EnsureDictionary().Add(key, value); + } + + public bool ContainsKey(TKey key) + { + if (IsUndefined) + { + return false; + } + return EnsureDictionary().ContainsKey(key); + } + + public bool Remove(TKey key) + { + if (IsUndefined) + { + return false; + } + return EnsureDictionary().Remove(key); + } + + public bool TryGetValue(TKey key, out TValue value) + { + if (IsUndefined) + { + value = default; + return false; + } + return EnsureDictionary().TryGetValue(key, out value); + } + + public IDictionary EnsureDictionary() + { + return _innerDictionary ??= new Dictionary(); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/ChangeTrackingList.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/ChangeTrackingList.cs new file mode 100644 index 000000000000..57c7a54ec7bd --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/ChangeTrackingList.cs @@ -0,0 +1,153 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Search +{ + internal class ChangeTrackingList : IList, IReadOnlyList + { + private IList _innerList; + + public ChangeTrackingList() + { + } + + public ChangeTrackingList(IList innerList) + { + if (innerList != null) + { + _innerList = innerList; + } + } + + public ChangeTrackingList(IReadOnlyList innerList) + { + if (innerList != null) + { + _innerList = innerList.ToList(); + } + } + + public bool IsUndefined => _innerList == null; + + public int Count => IsUndefined ? 0 : EnsureList().Count; + + public bool IsReadOnly => IsUndefined ? false : EnsureList().IsReadOnly; + + public T this[int index] + { + get + { + if (IsUndefined) + { + throw new ArgumentOutOfRangeException(nameof(index)); + } + return EnsureList()[index]; + } + set + { + if (IsUndefined) + { + throw new ArgumentOutOfRangeException(nameof(index)); + } + EnsureList()[index] = value; + } + } + + public void Reset() + { + _innerList = null; + } + + public IEnumerator GetEnumerator() + { + if (IsUndefined) + { + IEnumerator enumerateEmpty() + { + yield break; + } + return enumerateEmpty(); + } + return EnsureList().GetEnumerator(); + } + + IEnumerator IEnumerable.GetEnumerator() + { + return GetEnumerator(); + } + + public void Add(T item) + { + EnsureList().Add(item); + } + + public void Clear() + { + EnsureList().Clear(); + } + + public bool Contains(T item) + { + if (IsUndefined) + { + return false; + } + return EnsureList().Contains(item); + } + + public void CopyTo(T[] array, int arrayIndex) + { + if (IsUndefined) + { + return; + } + EnsureList().CopyTo(array, arrayIndex); + } + + public bool Remove(T item) + { + if (IsUndefined) + { + return false; + } + return EnsureList().Remove(item); + } + + public int IndexOf(T item) + { + if (IsUndefined) + { + return -1; + } + return EnsureList().IndexOf(item); + } + + public void Insert(int index, T item) + { + EnsureList().Insert(index, item); + } + + public void RemoveAt(int index) + { + if (IsUndefined) + { + throw new ArgumentOutOfRangeException(nameof(index)); + } + EnsureList().RemoveAt(index); + } + + public IList EnsureList() + { + return _innerList ??= new List(); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/ModelSerializationExtensions.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/ModelSerializationExtensions.cs new file mode 100644 index 000000000000..b920e0eeebbe --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/ModelSerializationExtensions.cs @@ -0,0 +1,399 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Diagnostics; +using System.Globalization; +using System.Text.Json; +using System.Xml; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + internal static class ModelSerializationExtensions + { + internal static readonly JsonDocumentOptions JsonDocumentOptions = new JsonDocumentOptions { MaxDepth = 256 }; + internal static readonly ModelReaderWriterOptions WireOptions = new ModelReaderWriterOptions("W"); + + public static object GetObject(this JsonElement element) + { + switch (element.ValueKind) + { + case JsonValueKind.String: + return element.GetString(); + case JsonValueKind.Number: + if (element.TryGetInt32(out int intValue)) + { + return intValue; + } + if (element.TryGetInt64(out long longValue)) + { + return longValue; + } + return element.GetDouble(); + case JsonValueKind.True: + return true; + case JsonValueKind.False: + return false; + case JsonValueKind.Undefined: + case JsonValueKind.Null: + return null; + case JsonValueKind.Object: + var dictionary = new Dictionary(); + foreach (var jsonProperty in element.EnumerateObject()) + { + dictionary.Add(jsonProperty.Name, jsonProperty.Value.GetObject()); + } + return dictionary; + case JsonValueKind.Array: + var list = new List(); + foreach (var item in element.EnumerateArray()) + { + list.Add(item.GetObject()); + } + return list.ToArray(); + default: + throw new NotSupportedException($"Not supported value kind {element.ValueKind}"); + } + } + + public static byte[] GetBytesFromBase64(this JsonElement element, string format) + { + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + + return format switch + { + "U" => TypeFormatters.FromBase64UrlString(element.GetRequiredString()), + "D" => element.GetBytesFromBase64(), + _ => throw new ArgumentException($"Format is not supported: '{format}'", nameof(format)) + }; + } + + public static DateTimeOffset GetDateTimeOffset(this JsonElement element, string format) => format switch + { + "U" when element.ValueKind == JsonValueKind.Number => DateTimeOffset.FromUnixTimeSeconds(element.GetInt64()), + _ => TypeFormatters.ParseDateTimeOffset(element.GetString(), format) + }; + + public static TimeSpan GetTimeSpan(this JsonElement element, string format) => TypeFormatters.ParseTimeSpan(element.GetString(), format); + + public static char GetChar(this JsonElement element) + { + if (element.ValueKind == JsonValueKind.String) + { + var text = element.GetString(); + if (text == null || text.Length != 1) + { + throw new NotSupportedException($"Cannot convert \"{text}\" to a char"); + } + return text[0]; + } + else + { + throw new NotSupportedException($"Cannot convert {element.ValueKind} to a char"); + } + } + + [Conditional("DEBUG")] + public static void ThrowNonNullablePropertyIsNull(this JsonProperty property) + { + throw new JsonException($"A property '{property.Name}' defined as non-nullable but received as null from the service. This exception only happens in DEBUG builds of the library and would be ignored in the release build"); + } + + public static string GetRequiredString(this JsonElement element) + { + var value = element.GetString(); + if (value == null) + { + throw new InvalidOperationException($"The requested operation requires an element of type 'String', but the target element has type '{element.ValueKind}'."); + } + return value; + } + + public static void WriteStringValue(this Utf8JsonWriter writer, DateTimeOffset value, string format) + { + writer.WriteStringValue(TypeFormatters.ToString(value, format)); + } + + public static void WriteStringValue(this Utf8JsonWriter writer, DateTime value, string format) + { + writer.WriteStringValue(TypeFormatters.ToString(value, format)); + } + + public static void WriteStringValue(this Utf8JsonWriter writer, TimeSpan value, string format) + { + writer.WriteStringValue(TypeFormatters.ToString(value, format)); + } + + public static void WriteStringValue(this Utf8JsonWriter writer, char value) + { + writer.WriteStringValue(value.ToString(CultureInfo.InvariantCulture)); + } + + public static void WriteBase64StringValue(this Utf8JsonWriter writer, byte[] value, string format) + { + if (value == null) + { + writer.WriteNullValue(); + return; + } + switch (format) + { + case "U": + writer.WriteStringValue(TypeFormatters.ToBase64UrlString(value)); + break; + case "D": + writer.WriteBase64StringValue(value); + break; + default: + throw new ArgumentException($"Format is not supported: '{format}'", nameof(format)); + } + } + + public static void WriteNumberValue(this Utf8JsonWriter writer, DateTimeOffset value, string format) + { + if (format != "U") + { + throw new ArgumentOutOfRangeException(nameof(format), "Only 'U' format is supported when writing a DateTimeOffset as a Number."); + } + writer.WriteNumberValue(value.ToUnixTimeSeconds()); + } + + public static void WriteObjectValue(this Utf8JsonWriter writer, T value, ModelReaderWriterOptions options = null) + { + switch (value) + { + case null: + writer.WriteNullValue(); + break; + case IJsonModel jsonModel: + jsonModel.Write(writer, options ?? WireOptions); + break; + case IUtf8JsonSerializable serializable: + serializable.Write(writer); + break; + case byte[] bytes: + writer.WriteBase64StringValue(bytes); + break; + case BinaryData bytes0: + writer.WriteBase64StringValue(bytes0); + break; + case JsonElement json: + json.WriteTo(writer); + break; + case int i: + writer.WriteNumberValue(i); + break; + case decimal d: + writer.WriteNumberValue(d); + break; + case double d0: + if (double.IsNaN(d0)) + { + writer.WriteStringValue("NaN"); + } + else + { + writer.WriteNumberValue(d0); + } + break; + case float f: + writer.WriteNumberValue(f); + break; + case long l: + writer.WriteNumberValue(l); + break; + case string s: + writer.WriteStringValue(s); + break; + case bool b: + writer.WriteBooleanValue(b); + break; + case Guid g: + writer.WriteStringValue(g); + break; + case DateTimeOffset dateTimeOffset: + writer.WriteStringValue(dateTimeOffset, "O"); + break; + case DateTime dateTime: + writer.WriteStringValue(dateTime, "O"); + break; + case IEnumerable> enumerable: + writer.WriteStartObject(); + foreach (var pair in enumerable) + { + writer.WritePropertyName(pair.Key); + writer.WriteObjectValue(pair.Value, options); + } + writer.WriteEndObject(); + break; + case IEnumerable objectEnumerable: + writer.WriteStartArray(); + foreach (var item in objectEnumerable) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + break; + case TimeSpan timeSpan: + writer.WriteStringValue(timeSpan, "P"); + break; + default: + throw new NotSupportedException($"Not supported type {value.GetType()}"); + } + } + + public static void WriteObjectValue(this Utf8JsonWriter writer, object value, ModelReaderWriterOptions options = null) + { + writer.WriteObjectValue(value, options); + } + + internal static class TypeFormatters + { + private const string RoundtripZFormat = "yyyy-MM-ddTHH:mm:ss.fffffffZ"; + public const string DefaultNumberFormat = "G"; + + public static string ToString(bool value) => value ? "true" : "false"; + + public static string ToString(DateTime value, string format) => value.Kind switch + { + DateTimeKind.Utc => ToString((DateTimeOffset)value, format), + _ => throw new NotSupportedException($"DateTime {value} has a Kind of {value.Kind}. Azure SDK requires it to be UTC. You can call DateTime.SpecifyKind to change Kind property value to DateTimeKind.Utc.") + }; + + public static string ToString(DateTimeOffset value, string format) => format switch + { + "D" => value.ToString("yyyy-MM-dd", CultureInfo.InvariantCulture), + "U" => value.ToUnixTimeSeconds().ToString(CultureInfo.InvariantCulture), + "O" => value.ToUniversalTime().ToString(RoundtripZFormat, CultureInfo.InvariantCulture), + "o" => value.ToUniversalTime().ToString(RoundtripZFormat, CultureInfo.InvariantCulture), + "R" => value.ToString("r", CultureInfo.InvariantCulture), + _ => value.ToString(format, CultureInfo.InvariantCulture) + }; + + public static string ToString(TimeSpan value, string format) => format switch + { + "P" => XmlConvert.ToString(value), + _ => value.ToString(format, CultureInfo.InvariantCulture) + }; + + public static string ToString(byte[] value, string format) => format switch + { + "U" => ToBase64UrlString(value), + "D" => Convert.ToBase64String(value), + _ => throw new ArgumentException($"Format is not supported: '{format}'", nameof(format)) + }; + + public static string ToBase64UrlString(byte[] value) + { + int numWholeOrPartialInputBlocks = checked(value.Length + 2) / 3; + int size = checked(numWholeOrPartialInputBlocks * 4); + char[] output = new char[size]; + + int numBase64Chars = Convert.ToBase64CharArray(value, 0, value.Length, output, 0); + + int i = 0; + for (; i < numBase64Chars; i++) + { + char ch = output[i]; + if (ch == '+') + { + output[i] = '-'; + } + else + { + if (ch == '/') + { + output[i] = '_'; + } + else + { + if (ch == '=') + { + break; + } + } + } + } + + return new string(output, 0, i); + } + + public static byte[] FromBase64UrlString(string value) + { + int paddingCharsToAdd = (value.Length % 4) switch + { + 0 => 0, + 2 => 2, + 3 => 1, + _ => throw new InvalidOperationException("Malformed input") + }; + char[] output = new char[(value.Length + paddingCharsToAdd)]; + int i = 0; + for (; i < value.Length; i++) + { + char ch = value[i]; + if (ch == '-') + { + output[i] = '+'; + } + else + { + if (ch == '_') + { + output[i] = '/'; + } + else + { + output[i] = ch; + } + } + } + + for (; i < output.Length; i++) + { + output[i] = '='; + } + + return Convert.FromBase64CharArray(output, 0, output.Length); + } + + public static DateTimeOffset ParseDateTimeOffset(string value, string format) => format switch + { + "U" => DateTimeOffset.FromUnixTimeSeconds(long.Parse(value, CultureInfo.InvariantCulture)), + _ => DateTimeOffset.Parse(value, CultureInfo.InvariantCulture, DateTimeStyles.AssumeUniversal) + }; + + public static TimeSpan ParseTimeSpan(string value, string format) => format switch + { + "P" => XmlConvert.ToTimeSpan(value), + _ => TimeSpan.ParseExact(value, format, CultureInfo.InvariantCulture) + }; + + public static string ConvertToString(object value, string format = null) => value switch + { + null => "null", + string s => s, + bool b => ToString(b), + int or float or double or long or decimal => ((IFormattable)value).ToString(DefaultNumberFormat, CultureInfo.InvariantCulture), + byte[] b0 when format != null => ToString(b0, format), + IEnumerable s0 => string.Join(",", s0), + DateTimeOffset dateTime when format != null => ToString(dateTime, format), + TimeSpan timeSpan when format != null => ToString(timeSpan, format), + TimeSpan timeSpan0 => XmlConvert.ToString(timeSpan0), + Guid guid => guid.ToString(), + BinaryData binaryData => ConvertToString(binaryData.ToArray(), format), + _ => value.ToString() + }; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/Optional.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/Optional.cs new file mode 100644 index 000000000000..7e0b52668ab3 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/Optional.cs @@ -0,0 +1,51 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System.Collections.Generic; +using System.Text.Json; + +namespace Azure.Search.Documents.Search +{ + internal static class Optional + { + public static bool IsCollectionDefined(IEnumerable collection) + { + return !(collection is ChangeTrackingList changeTrackingList && changeTrackingList.IsUndefined); + } + + public static bool IsCollectionDefined(IDictionary collection) + { + return !(collection is ChangeTrackingDictionary changeTrackingDictionary && changeTrackingDictionary.IsUndefined); + } + + public static bool IsCollectionDefined(IReadOnlyDictionary collection) + { + return !(collection is ChangeTrackingDictionary changeTrackingDictionary && changeTrackingDictionary.IsUndefined); + } + + public static bool IsDefined(T? value) + where T : struct + { + return value.HasValue; + } + + public static bool IsDefined(object value) + { + return value != null; + } + + public static bool IsDefined(JsonElement value) + { + return value.ValueKind != JsonValueKind.Undefined; + } + + public static bool IsDefined(string value) + { + return value != null; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/Utf8JsonRequestContent.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/Utf8JsonRequestContent.cs new file mode 100644 index 000000000000..bed7b1df0708 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/Internal/Utf8JsonRequestContent.cs @@ -0,0 +1,55 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System.IO; +using System.Text.Json; +using System.Threading; +using System.Threading.Tasks; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + internal class Utf8JsonRequestContent : RequestContent + { + private readonly MemoryStream _stream; + private readonly RequestContent _content; + + public Utf8JsonRequestContent() + { + _stream = new MemoryStream(); + _content = Create(_stream); + JsonWriter = new Utf8JsonWriter(_stream); + } + + public Utf8JsonWriter JsonWriter { get; } + + public override async Task WriteToAsync(Stream stream, CancellationToken cancellationToken = default) + { + await JsonWriter.FlushAsync().ConfigureAwait(false); + await _content.WriteToAsync(stream, cancellationToken).ConfigureAwait(false); + } + + public override void WriteTo(Stream stream, CancellationToken cancellationToken = default) + { + JsonWriter.Flush(); + _content.WriteTo(stream, cancellationToken); + } + + public override bool TryComputeLength(out long length) + { + length = JsonWriter.BytesCommitted + JsonWriter.BytesPending; + return true; + } + + public override void Dispose() + { + JsonWriter.Dispose(); + _content.Dispose(); + _stream.Dispose(); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/LookupDocument.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/LookupDocument.Serialization.cs new file mode 100644 index 000000000000..fe1d88195b8a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/LookupDocument.Serialization.cs @@ -0,0 +1,128 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class LookupDocument : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LookupDocument)} does not support writing '{format}' format."); + } + + foreach (var item in AdditionalProperties) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + + LookupDocument IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(LookupDocument)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeLookupDocument(document.RootElement, options); + } + + internal static LookupDocument DeserializeLookupDocument(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IReadOnlyDictionary additionalProperties = default; + Dictionary additionalPropertiesDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + additionalPropertiesDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + additionalProperties = additionalPropertiesDictionary; + return new LookupDocument(additionalProperties); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(LookupDocument)} does not support writing '{options.Format}' format."); + } + } + + LookupDocument IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLookupDocument(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(LookupDocument)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static LookupDocument FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeLookupDocument(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/LookupDocument.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/LookupDocument.cs new file mode 100644 index 000000000000..0370a7187fb9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/LookupDocument.cs @@ -0,0 +1,61 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// A document retrieved via a document lookup operation. + public partial class LookupDocument + { + /// Initializes a new instance of . + internal LookupDocument() + { + AdditionalProperties = new ChangeTrackingDictionary(); + } + + /// Initializes a new instance of . + /// Additional Properties. + internal LookupDocument(IReadOnlyDictionary additionalProperties) + { + AdditionalProperties = additionalProperties; + } + + /// + /// Additional Properties + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + public IReadOnlyDictionary AdditionalProperties { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryAnswerResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryAnswerResult.Serialization.cs new file mode 100644 index 000000000000..a7baf452e5f8 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryAnswerResult.Serialization.cs @@ -0,0 +1,176 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class QueryAnswerResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(QueryAnswerResult)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(Score)) + { + writer.WritePropertyName("score"u8); + writer.WriteNumberValue(Score.Value); + } + if (Optional.IsDefined(Key)) + { + writer.WritePropertyName("key"u8); + writer.WriteStringValue(Key); + } + if (Optional.IsDefined(Text)) + { + writer.WritePropertyName("text"u8); + writer.WriteStringValue(Text); + } + if (Optional.IsDefined(Highlights)) + { + writer.WritePropertyName("highlights"u8); + writer.WriteStringValue(Highlights); + } + foreach (var item in AdditionalProperties) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + + QueryAnswerResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(QueryAnswerResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeQueryAnswerResult(document.RootElement, options); + } + + internal static QueryAnswerResult DeserializeQueryAnswerResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + double? score = default; + string key = default; + string text = default; + string highlights = default; + IReadOnlyDictionary additionalProperties = default; + Dictionary additionalPropertiesDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("score"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + score = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("key"u8)) + { + key = property.Value.GetString(); + continue; + } + if (property.NameEquals("text"u8)) + { + text = property.Value.GetString(); + continue; + } + if (property.NameEquals("highlights"u8)) + { + highlights = property.Value.GetString(); + continue; + } + additionalPropertiesDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + additionalProperties = additionalPropertiesDictionary; + return new QueryAnswerResult(score, key, text, highlights, additionalProperties); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(QueryAnswerResult)} does not support writing '{options.Format}' format."); + } + } + + QueryAnswerResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeQueryAnswerResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(QueryAnswerResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static QueryAnswerResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeQueryAnswerResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryAnswerResult.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryAnswerResult.cs new file mode 100644 index 000000000000..e918b6ee78b7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryAnswerResult.cs @@ -0,0 +1,93 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// An answer is a text passage extracted from the contents of the most relevant + /// documents that matched the query. Answers are extracted from the top search + /// results. Answer candidates are scored and the top answers are selected. + /// + public partial class QueryAnswerResult + { + /// Initializes a new instance of . + internal QueryAnswerResult() + { + AdditionalProperties = new ChangeTrackingDictionary(); + } + + /// Initializes a new instance of . + /// + /// 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. + internal QueryAnswerResult(double? score, string key, string text, string highlights, IReadOnlyDictionary additionalProperties) + { + Score = score; + Key = key; + Text = text; + Highlights = highlights; + AdditionalProperties = additionalProperties; + } + + /// + /// The score value represents how relevant the answer is to the query relative to + /// other answers returned for the query. + /// + public double? Score { get; } + /// The key of the document the answer was extracted from. + public string Key { get; } + /// The text passage extracted from the document contents as the answer. + public string Text { get; } + /// + /// Same text passage as in the Text property with highlighted text phrases most + /// relevant to the query. + /// + public string Highlights { get; } + /// + /// Additional Properties + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + public IReadOnlyDictionary AdditionalProperties { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryAnswerType.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryAnswerType.cs new file mode 100644 index 000000000000..cf3ebac26799 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryAnswerType.cs @@ -0,0 +1,66 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// + /// 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-` 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-` option after the answers + /// parameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7. + /// The maximum character length of answers can be configured by appending the pipe + /// character '|' followed by the 'count-', + /// such as 'extractive|maxcharlength-600'. + /// + public readonly partial struct QueryAnswerType : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public QueryAnswerType(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string NoneValue = "none"; + private const string ExtractiveValue = "extractive"; + + /// Do not return answers for the query. + public static QueryAnswerType None { get; } = new QueryAnswerType(NoneValue); + /// + /// Extracts answer candidates from the contents of the documents returned in + /// response to a query expressed as a question in natural language. + /// + public static QueryAnswerType Extractive { get; } = new QueryAnswerType(ExtractiveValue); + /// Determines if two values are the same. + public static bool operator ==(QueryAnswerType left, QueryAnswerType right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(QueryAnswerType left, QueryAnswerType right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator QueryAnswerType(string value) => new QueryAnswerType(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is QueryAnswerType other && Equals(other); + /// + public bool Equals(QueryAnswerType other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryCaptionResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryCaptionResult.Serialization.cs new file mode 100644 index 000000000000..0eb4140a498c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryCaptionResult.Serialization.cs @@ -0,0 +1,150 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class QueryCaptionResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(QueryCaptionResult)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(Text)) + { + writer.WritePropertyName("text"u8); + writer.WriteStringValue(Text); + } + if (Optional.IsDefined(Highlights)) + { + writer.WritePropertyName("highlights"u8); + writer.WriteStringValue(Highlights); + } + foreach (var item in AdditionalProperties) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + + QueryCaptionResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(QueryCaptionResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeQueryCaptionResult(document.RootElement, options); + } + + internal static QueryCaptionResult DeserializeQueryCaptionResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string text = default; + string highlights = default; + IReadOnlyDictionary additionalProperties = default; + Dictionary additionalPropertiesDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("text"u8)) + { + text = property.Value.GetString(); + continue; + } + if (property.NameEquals("highlights"u8)) + { + highlights = property.Value.GetString(); + continue; + } + additionalPropertiesDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + additionalProperties = additionalPropertiesDictionary; + return new QueryCaptionResult(text, highlights, additionalProperties); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(QueryCaptionResult)} does not support writing '{options.Format}' format."); + } + } + + QueryCaptionResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeQueryCaptionResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(QueryCaptionResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static QueryCaptionResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeQueryCaptionResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryCaptionResult.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryCaptionResult.cs new file mode 100644 index 000000000000..ed17c34dbb36 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryCaptionResult.cs @@ -0,0 +1,85 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// Captions are the most representative passages from the document relatively to + /// the search query. They are often used as document summary. Captions are only + /// returned for queries of type `semantic`. + /// + public partial class QueryCaptionResult + { + /// Initializes a new instance of . + internal QueryCaptionResult() + { + AdditionalProperties = new ChangeTrackingDictionary(); + } + + /// Initializes a new instance of . + /// + /// 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. + internal QueryCaptionResult(string text, string highlights, IReadOnlyDictionary additionalProperties) + { + Text = text; + Highlights = highlights; + AdditionalProperties = additionalProperties; + } + + /// + /// A representative text passage extracted from the document most relevant to the + /// search query. + /// + public string Text { get; } + /// + /// Same text passage as in the Text property with highlighted phrases most + /// relevant to the query. + /// + public string Highlights { get; } + /// + /// Additional Properties + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + public IReadOnlyDictionary AdditionalProperties { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryCaptionType.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryCaptionType.cs new file mode 100644 index 000000000000..6b850e001b6b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryCaptionType.cs @@ -0,0 +1,63 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// + /// 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-` option, such as `extractive|highlight-true`. Defaults + /// to `None`. The maximum character length of captions can be configured by + /// appending the pipe character '|' followed by the 'count-', such as 'extractive|maxcharlength-600'. + /// + public readonly partial struct QueryCaptionType : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public QueryCaptionType(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string NoneValue = "none"; + private const string ExtractiveValue = "extractive"; + + /// Do not return captions for the query. + public static QueryCaptionType None { get; } = new QueryCaptionType(NoneValue); + /// + /// Extracts captions from the matching documents that contain passages relevant to + /// the search query. + /// + public static QueryCaptionType Extractive { get; } = new QueryCaptionType(ExtractiveValue); + /// Determines if two values are the same. + public static bool operator ==(QueryCaptionType left, QueryCaptionType right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(QueryCaptionType left, QueryCaptionType right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator QueryCaptionType(string value) => new QueryCaptionType(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is QueryCaptionType other && Equals(other); + /// + public bool Equals(QueryCaptionType other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryDebugMode.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryDebugMode.cs new file mode 100644 index 000000000000..75bfa5740e64 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryDebugMode.cs @@ -0,0 +1,67 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// + /// Enables a debugging tool that can be used to further explore your search + /// results. You can enable multiple debug modes simultaneously by separating them + /// with a | character, for example: semantic|queryRewrites. + /// + public readonly partial struct QueryDebugMode : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public QueryDebugMode(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string DisabledValue = "disabled"; + private const string SemanticValue = "semantic"; + private const string VectorValue = "vector"; + private const string QueryRewritesValue = "queryRewrites"; + private const string AllValue = "all"; + + /// No query debugging information will be returned. + public static QueryDebugMode Disabled { get; } = new QueryDebugMode(DisabledValue); + /// Allows the user to further explore their reranked results. + public static QueryDebugMode Semantic { get; } = new QueryDebugMode(SemanticValue); + /// Allows the user to further explore their hybrid and vector query results. + public static QueryDebugMode Vector { get; } = new QueryDebugMode(VectorValue); + /// + /// Allows the user to explore the list of query rewrites generated for their + /// search request. + /// + public static QueryDebugMode QueryRewrites { get; } = new QueryDebugMode(QueryRewritesValue); + /// Turn on all debug options. + public static QueryDebugMode All { get; } = new QueryDebugMode(AllValue); + /// Determines if two values are the same. + public static bool operator ==(QueryDebugMode left, QueryDebugMode right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(QueryDebugMode left, QueryDebugMode right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator QueryDebugMode(string value) => new QueryDebugMode(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is QueryDebugMode other && Equals(other); + /// + public bool Equals(QueryDebugMode other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryLanguage.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryLanguage.cs new file mode 100644 index 000000000000..68bfac8b6e66 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryLanguage.cs @@ -0,0 +1,261 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// The language of the query. + public readonly partial struct QueryLanguage : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public QueryLanguage(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string NoneValue = "none"; + private const string EnUsValue = "en-us"; + private const string EnGbValue = "en-gb"; + private const string EnInValue = "en-in"; + private const string EnCaValue = "en-ca"; + private const string EnAuValue = "en-au"; + private const string FrFrValue = "fr-fr"; + private const string FrCaValue = "fr-ca"; + private const string DeDeValue = "de-de"; + private const string EsEsValue = "es-es"; + private const string EsMxValue = "es-mx"; + private const string ZhCnValue = "zh-cn"; + private const string ZhTwValue = "zh-tw"; + private const string PtBrValue = "pt-br"; + private const string PtPtValue = "pt-pt"; + private const string ItItValue = "it-it"; + private const string JaJpValue = "ja-jp"; + private const string KoKrValue = "ko-kr"; + private const string RuRuValue = "ru-ru"; + private const string CsCzValue = "cs-cz"; + private const string NlBeValue = "nl-be"; + private const string NlNlValue = "nl-nl"; + private const string HuHuValue = "hu-hu"; + private const string PlPlValue = "pl-pl"; + private const string SvSeValue = "sv-se"; + private const string TrTrValue = "tr-tr"; + private const string HiInValue = "hi-in"; + private const string ArSaValue = "ar-sa"; + private const string ArEgValue = "ar-eg"; + private const string ArMaValue = "ar-ma"; + private const string ArKwValue = "ar-kw"; + private const string ArJoValue = "ar-jo"; + private const string DaDkValue = "da-dk"; + private const string NoNoValue = "no-no"; + private const string BgBgValue = "bg-bg"; + private const string HrHrValue = "hr-hr"; + private const string HrBaValue = "hr-ba"; + private const string MsMyValue = "ms-my"; + private const string MsBnValue = "ms-bn"; + private const string SlSlValue = "sl-sl"; + private const string TaInValue = "ta-in"; + private const string ViVnValue = "vi-vn"; + private const string ElGrValue = "el-gr"; + private const string RoRoValue = "ro-ro"; + private const string IsIsValue = "is-is"; + private const string IdIdValue = "id-id"; + private const string ThThValue = "th-th"; + private const string LtLtValue = "lt-lt"; + private const string UkUaValue = "uk-ua"; + private const string LvLvValue = "lv-lv"; + private const string EtEeValue = "et-ee"; + private const string CaEsValue = "ca-es"; + private const string FiFiValue = "fi-fi"; + private const string SrBaValue = "sr-ba"; + private const string SrMeValue = "sr-me"; + private const string SrRsValue = "sr-rs"; + private const string SkSkValue = "sk-sk"; + private const string NbNoValue = "nb-no"; + private const string HyAmValue = "hy-am"; + private const string BnInValue = "bn-in"; + private const string EuEsValue = "eu-es"; + private const string GlEsValue = "gl-es"; + private const string GuInValue = "gu-in"; + private const string HeIlValue = "he-il"; + private const string GaIeValue = "ga-ie"; + private const string KnInValue = "kn-in"; + private const string MlInValue = "ml-in"; + private const string MrInValue = "mr-in"; + private const string FaAeValue = "fa-ae"; + private const string PaInValue = "pa-in"; + private const string TeInValue = "te-in"; + private const string UrPkValue = "ur-pk"; + + /// Query language not specified. + public static QueryLanguage None { get; } = new QueryLanguage(NoneValue); + /// Query language value for English (United States). + public static QueryLanguage EnUs { get; } = new QueryLanguage(EnUsValue); + /// Query language value for English (Great Britain). + public static QueryLanguage EnGb { get; } = new QueryLanguage(EnGbValue); + /// Query language value for English (India). + public static QueryLanguage EnIn { get; } = new QueryLanguage(EnInValue); + /// Query language value for English (Canada). + public static QueryLanguage EnCa { get; } = new QueryLanguage(EnCaValue); + /// Query language value for English (Australia). + public static QueryLanguage EnAu { get; } = new QueryLanguage(EnAuValue); + /// Query language value for French (France). + public static QueryLanguage FrFr { get; } = new QueryLanguage(FrFrValue); + /// Query language value for French (Canada). + public static QueryLanguage FrCa { get; } = new QueryLanguage(FrCaValue); + /// Query language value for German (Germany). + public static QueryLanguage DeDe { get; } = new QueryLanguage(DeDeValue); + /// Query language value for Spanish (Spain). + public static QueryLanguage EsEs { get; } = new QueryLanguage(EsEsValue); + /// Query language value for Spanish (Mexico). + public static QueryLanguage EsMx { get; } = new QueryLanguage(EsMxValue); + /// Query language value for Chinese (China). + public static QueryLanguage ZhCn { get; } = new QueryLanguage(ZhCnValue); + /// Query language value for Chinese (Taiwan). + public static QueryLanguage ZhTw { get; } = new QueryLanguage(ZhTwValue); + /// Query language value for Portuguese (Brazil). + public static QueryLanguage PtBr { get; } = new QueryLanguage(PtBrValue); + /// Query language value for Portuguese (Portugal). + public static QueryLanguage PtPt { get; } = new QueryLanguage(PtPtValue); + /// Query language value for Italian (Italy). + public static QueryLanguage ItIt { get; } = new QueryLanguage(ItItValue); + /// Query language value for Japanese (Japan). + public static QueryLanguage JaJp { get; } = new QueryLanguage(JaJpValue); + /// Query language value for Korean (Korea). + public static QueryLanguage KoKr { get; } = new QueryLanguage(KoKrValue); + /// Query language value for Russian (Russia). + public static QueryLanguage RuRu { get; } = new QueryLanguage(RuRuValue); + /// Query language value for Czech (Czech Republic). + public static QueryLanguage CsCz { get; } = new QueryLanguage(CsCzValue); + /// Query language value for Dutch (Belgium). + public static QueryLanguage NlBe { get; } = new QueryLanguage(NlBeValue); + /// Query language value for Dutch (Netherlands). + public static QueryLanguage NlNl { get; } = new QueryLanguage(NlNlValue); + /// Query language value for Hungarian (Hungary). + public static QueryLanguage HuHu { get; } = new QueryLanguage(HuHuValue); + /// Query language value for Polish (Poland). + public static QueryLanguage PlPl { get; } = new QueryLanguage(PlPlValue); + /// Query language value for Swedish (Sweden). + public static QueryLanguage SvSe { get; } = new QueryLanguage(SvSeValue); + /// Query language value for Turkish (Turkey). + public static QueryLanguage TrTr { get; } = new QueryLanguage(TrTrValue); + /// Query language value for Hindi (India). + public static QueryLanguage HiIn { get; } = new QueryLanguage(HiInValue); + /// Query language value for Arabic (Saudi Arabia). + public static QueryLanguage ArSa { get; } = new QueryLanguage(ArSaValue); + /// Query language value for Arabic (Egypt). + public static QueryLanguage ArEg { get; } = new QueryLanguage(ArEgValue); + /// Query language value for Arabic (Morocco). + public static QueryLanguage ArMa { get; } = new QueryLanguage(ArMaValue); + /// Query language value for Arabic (Kuwait). + public static QueryLanguage ArKw { get; } = new QueryLanguage(ArKwValue); + /// Query language value for Arabic (Jordan). + public static QueryLanguage ArJo { get; } = new QueryLanguage(ArJoValue); + /// Query language value for Danish (Denmark). + public static QueryLanguage DaDk { get; } = new QueryLanguage(DaDkValue); + /// Query language value for Norwegian (Norway). + public static QueryLanguage NoNo { get; } = new QueryLanguage(NoNoValue); + /// Query language value for Bulgarian (Bulgaria). + public static QueryLanguage BgBg { get; } = new QueryLanguage(BgBgValue); + /// Query language value for Croatian (Croatia). + public static QueryLanguage HrHr { get; } = new QueryLanguage(HrHrValue); + /// Query language value for Croatian (Bosnia and Herzegovina). + public static QueryLanguage HrBa { get; } = new QueryLanguage(HrBaValue); + /// Query language value for Malay (Malaysia). + public static QueryLanguage MsMy { get; } = new QueryLanguage(MsMyValue); + /// Query language value for Malay (Brunei Darussalam). + public static QueryLanguage MsBn { get; } = new QueryLanguage(MsBnValue); + /// Query language value for Slovenian (Slovenia). + public static QueryLanguage SlSl { get; } = new QueryLanguage(SlSlValue); + /// Query language value for Tamil (India). + public static QueryLanguage TaIn { get; } = new QueryLanguage(TaInValue); + /// Query language value for Vietnamese (Viet Nam). + public static QueryLanguage ViVn { get; } = new QueryLanguage(ViVnValue); + /// Query language value for Greek (Greece). + public static QueryLanguage ElGr { get; } = new QueryLanguage(ElGrValue); + /// Query language value for Romanian (Romania). + public static QueryLanguage RoRo { get; } = new QueryLanguage(RoRoValue); + /// Query language value for Icelandic (Iceland). + public static QueryLanguage IsIs { get; } = new QueryLanguage(IsIsValue); + /// Query language value for Indonesian (Indonesia). + public static QueryLanguage IdId { get; } = new QueryLanguage(IdIdValue); + /// Query language value for Thai (Thailand). + public static QueryLanguage ThTh { get; } = new QueryLanguage(ThThValue); + /// Query language value for Lithuanian (Lithuania). + public static QueryLanguage LtLt { get; } = new QueryLanguage(LtLtValue); + /// Query language value for Ukrainian (Ukraine). + public static QueryLanguage UkUa { get; } = new QueryLanguage(UkUaValue); + /// Query language value for Latvian (Latvia). + 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. + public static QueryLanguage CaEs { get; } = new QueryLanguage(CaEsValue); + /// Query language value for Finnish (Finland). + public static QueryLanguage FiFi { get; } = new QueryLanguage(FiFiValue); + /// Query language value for Serbian (Bosnia and Herzegovina). + public static QueryLanguage SrBa { get; } = new QueryLanguage(SrBaValue); + /// Query language value for Serbian (Montenegro). + public static QueryLanguage SrMe { get; } = new QueryLanguage(SrMeValue); + /// Query language value for Serbian (Serbia). + public static QueryLanguage SrRs { get; } = new QueryLanguage(SrRsValue); + /// Query language value for Slovak (Slovakia). + public static QueryLanguage SkSk { get; } = new QueryLanguage(SkSkValue); + /// Query language value for Norwegian (Norway). + public static QueryLanguage NbNo { get; } = new QueryLanguage(NbNoValue); + /// Query language value for Armenian (Armenia). + 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. + public static QueryLanguage EuEs { get; } = new QueryLanguage(EuEsValue); + /// 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); + /// Query language value for Hebrew (Israel). + public static QueryLanguage HeIl { get; } = new QueryLanguage(HeIlValue); + /// Query language value for Irish (Ireland). + public static QueryLanguage GaIe { get; } = new QueryLanguage(GaIeValue); + /// Query language value for Kannada (India). + public static QueryLanguage KnIn { get; } = new QueryLanguage(KnInValue); + /// Query language value for Malayalam (India). + public static QueryLanguage MlIn { get; } = new QueryLanguage(MlInValue); + /// Query language value for Marathi (India). + public static QueryLanguage MrIn { get; } = new QueryLanguage(MrInValue); + /// Query language value for Persian (U.A.E.). + public static QueryLanguage FaAe { get; } = new QueryLanguage(FaAeValue); + /// Query language value for Punjabi (India). + public static QueryLanguage PaIn { get; } = new QueryLanguage(PaInValue); + /// Query language value for Telugu (India). + public static QueryLanguage TeIn { get; } = new QueryLanguage(TeInValue); + /// Query language value for Urdu (Pakistan). + public static QueryLanguage UrPk { get; } = new QueryLanguage(UrPkValue); + /// Determines if two values are the same. + public static bool operator ==(QueryLanguage left, QueryLanguage right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(QueryLanguage left, QueryLanguage right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator QueryLanguage(string value) => new QueryLanguage(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is QueryLanguage other && Equals(other); + /// + public bool Equals(QueryLanguage other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentRerankerInput.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentRerankerInput.Serialization.cs new file mode 100644 index 000000000000..d9673d860d7b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentRerankerInput.Serialization.cs @@ -0,0 +1,167 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class QueryResultDocumentRerankerInput : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(QueryResultDocumentRerankerInput)} does not support writing '{format}' format."); + } + + if (options.Format != "W" && Optional.IsDefined(Title)) + { + writer.WritePropertyName("title"u8); + writer.WriteStringValue(Title); + } + if (options.Format != "W" && Optional.IsDefined(Content)) + { + writer.WritePropertyName("content"u8); + writer.WriteStringValue(Content); + } + if (options.Format != "W" && Optional.IsDefined(Keywords)) + { + writer.WritePropertyName("keywords"u8); + writer.WriteStringValue(Keywords); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + QueryResultDocumentRerankerInput IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(QueryResultDocumentRerankerInput)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeQueryResultDocumentRerankerInput(document.RootElement, options); + } + + internal static QueryResultDocumentRerankerInput DeserializeQueryResultDocumentRerankerInput(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string title = default; + string content = default; + string keywords = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("title"u8)) + { + title = property.Value.GetString(); + continue; + } + if (property.NameEquals("content"u8)) + { + content = property.Value.GetString(); + continue; + } + if (property.NameEquals("keywords"u8)) + { + keywords = property.Value.GetString(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new QueryResultDocumentRerankerInput(title, content, keywords, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(QueryResultDocumentRerankerInput)} does not support writing '{options.Format}' format."); + } + } + + QueryResultDocumentRerankerInput IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeQueryResultDocumentRerankerInput(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(QueryResultDocumentRerankerInput)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static QueryResultDocumentRerankerInput FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeQueryResultDocumentRerankerInput(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentRerankerInput.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentRerankerInput.cs new file mode 100644 index 000000000000..cfcb994a399c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentRerankerInput.cs @@ -0,0 +1,85 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// The raw concatenated strings that were sent to the semantic enrichment process. + public partial class QueryResultDocumentRerankerInput + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + internal QueryResultDocumentRerankerInput() + { + } + + /// Initializes a new instance of . + /// 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. + /// + /// Keeps track of any properties unknown to the library. + internal QueryResultDocumentRerankerInput(string title, string content, string keywords, IDictionary serializedAdditionalRawData) + { + Title = title; + Content = content; + Keywords = keywords; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The raw string for the title field that was used for semantic enrichment. + public string Title { get; } + /// + /// The raw concatenated strings for the content fields that were used for semantic + /// enrichment. + /// + public string Content { get; } + /// + /// The raw concatenated strings for the keyword fields that were used for semantic + /// enrichment. + /// + public string Keywords { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentSemanticField.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentSemanticField.Serialization.cs new file mode 100644 index 000000000000..d258ce856fd5 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentSemanticField.Serialization.cs @@ -0,0 +1,160 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class QueryResultDocumentSemanticField : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(QueryResultDocumentSemanticField)} does not support writing '{format}' format."); + } + + if (options.Format != "W" && Optional.IsDefined(Name)) + { + writer.WritePropertyName("name"u8); + writer.WriteStringValue(Name); + } + if (options.Format != "W" && Optional.IsDefined(State)) + { + writer.WritePropertyName("state"u8); + writer.WriteStringValue(State.Value.ToString()); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + QueryResultDocumentSemanticField IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(QueryResultDocumentSemanticField)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeQueryResultDocumentSemanticField(document.RootElement, options); + } + + internal static QueryResultDocumentSemanticField DeserializeQueryResultDocumentSemanticField(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string name = default; + SemanticFieldState? state = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("name"u8)) + { + name = property.Value.GetString(); + continue; + } + if (property.NameEquals("state"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + state = new SemanticFieldState(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new QueryResultDocumentSemanticField(name, state, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(QueryResultDocumentSemanticField)} does not support writing '{options.Format}' format."); + } + } + + QueryResultDocumentSemanticField IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeQueryResultDocumentSemanticField(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(QueryResultDocumentSemanticField)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static QueryResultDocumentSemanticField FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeQueryResultDocumentSemanticField(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentSemanticField.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentSemanticField.cs new file mode 100644 index 000000000000..161d2c8bc620 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentSemanticField.cs @@ -0,0 +1,78 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// Description of fields that were sent to the semantic enrichment process, as + /// well as how they were used + /// + public partial class QueryResultDocumentSemanticField + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + internal QueryResultDocumentSemanticField() + { + } + + /// Initializes a new instance of . + /// 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) + /// + /// Keeps track of any properties unknown to the library. + internal QueryResultDocumentSemanticField(string name, SemanticFieldState? state, IDictionary serializedAdditionalRawData) + { + Name = name; + State = state; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The name of the field that was sent to the semantic enrichment process. + public string Name { get; } + /// + /// The way the field was used for the semantic enrichment process (fully used, + /// partially used, or unused) + /// + public SemanticFieldState? State { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentSubscores.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentSubscores.Serialization.cs new file mode 100644 index 000000000000..ead7c31b6720 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentSubscores.Serialization.cs @@ -0,0 +1,212 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class QueryResultDocumentSubscores : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(QueryResultDocumentSubscores)} does not support writing '{format}' format."); + } + + if (options.Format != "W" && Optional.IsDefined(Text)) + { + writer.WritePropertyName("text"u8); + writer.WriteObjectValue(Text, options); + } + if (options.Format != "W" && Optional.IsCollectionDefined(Vectors)) + { + writer.WritePropertyName("vectors"u8); + writer.WriteStartArray(); + foreach (var item in Vectors) + { + if (item == null) + { + writer.WriteNullValue(); + continue; + } + writer.WriteStartObject(); + foreach (var item0 in item) + { + writer.WritePropertyName(item0.Key); + writer.WriteObjectValue(item0.Value, options); + } + writer.WriteEndObject(); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && Optional.IsDefined(DocumentBoost)) + { + writer.WritePropertyName("documentBoost"u8); + writer.WriteNumberValue(DocumentBoost.Value); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + QueryResultDocumentSubscores IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(QueryResultDocumentSubscores)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeQueryResultDocumentSubscores(document.RootElement, options); + } + + internal static QueryResultDocumentSubscores DeserializeQueryResultDocumentSubscores(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + TextResult text = default; + IReadOnlyList> vectors = default; + double? documentBoost = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("text"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + text = TextResult.DeserializeTextResult(property.Value, options); + continue; + } + if (property.NameEquals("vectors"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List> array = new List>(); + foreach (var item in property.Value.EnumerateArray()) + { + if (item.ValueKind == JsonValueKind.Null) + { + array.Add(null); + } + else + { + Dictionary dictionary = new Dictionary(); + foreach (var property0 in item.EnumerateObject()) + { + dictionary.Add(property0.Name, SingleVectorFieldResult.DeserializeSingleVectorFieldResult(property0.Value, options)); + } + array.Add(dictionary); + } + } + vectors = array; + continue; + } + if (property.NameEquals("documentBoost"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + documentBoost = property.Value.GetDouble(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new QueryResultDocumentSubscores(text, vectors ?? new ChangeTrackingList>(), documentBoost, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(QueryResultDocumentSubscores)} does not support writing '{options.Format}' format."); + } + } + + QueryResultDocumentSubscores IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeQueryResultDocumentSubscores(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(QueryResultDocumentSubscores)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static QueryResultDocumentSubscores FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeQueryResultDocumentSubscores(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentSubscores.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentSubscores.cs new file mode 100644 index 000000000000..e8bb80b3f395 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryResultDocumentSubscores.cs @@ -0,0 +1,78 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// The breakdown of subscores between the text and vector query components of the + /// search query for this document. Each vector query is shown as a separate object + /// in the same order they were received. + /// + public partial class QueryResultDocumentSubscores + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + internal QueryResultDocumentSubscores() + { + Vectors = new ChangeTrackingList>(); + } + + /// Initializes a new instance of . + /// The BM25 or Classic score for the text portion of the query. + /// The vector similarity and @search.score values for each vector query. + /// The BM25 or Classic score for the text portion of the query. + /// Keeps track of any properties unknown to the library. + internal QueryResultDocumentSubscores(TextResult text, IReadOnlyList> vectors, double? documentBoost, IDictionary serializedAdditionalRawData) + { + Text = text; + Vectors = vectors; + DocumentBoost = documentBoost; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The BM25 or Classic score for the text portion of the query. + public TextResult Text { get; } + /// The vector similarity and @search.score values for each vector query. + public IReadOnlyList> Vectors { get; } + /// The BM25 or Classic score for the text portion of the query. + public double? DocumentBoost { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryRewritesDebugInfo.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryRewritesDebugInfo.Serialization.cs new file mode 100644 index 000000000000..031895154e86 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryRewritesDebugInfo.Serialization.cs @@ -0,0 +1,174 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class QueryRewritesDebugInfo : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(QueryRewritesDebugInfo)} does not support writing '{format}' format."); + } + + if (options.Format != "W" && Optional.IsDefined(Text)) + { + writer.WritePropertyName("text"u8); + writer.WriteObjectValue(Text, options); + } + if (options.Format != "W" && Optional.IsCollectionDefined(Vectors)) + { + writer.WritePropertyName("vectors"u8); + writer.WriteStartArray(); + foreach (var item in Vectors) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + QueryRewritesDebugInfo IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(QueryRewritesDebugInfo)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeQueryRewritesDebugInfo(document.RootElement, options); + } + + internal static QueryRewritesDebugInfo DeserializeQueryRewritesDebugInfo(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + QueryRewritesValuesDebugInfo text = default; + IReadOnlyList vectors = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("text"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + text = QueryRewritesValuesDebugInfo.DeserializeQueryRewritesValuesDebugInfo(property.Value, options); + continue; + } + if (property.NameEquals("vectors"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(QueryRewritesValuesDebugInfo.DeserializeQueryRewritesValuesDebugInfo(item, options)); + } + vectors = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new QueryRewritesDebugInfo(text, vectors ?? new ChangeTrackingList(), serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(QueryRewritesDebugInfo)} does not support writing '{options.Format}' format."); + } + } + + QueryRewritesDebugInfo IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeQueryRewritesDebugInfo(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(QueryRewritesDebugInfo)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static QueryRewritesDebugInfo FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeQueryRewritesDebugInfo(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryRewritesDebugInfo.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryRewritesDebugInfo.cs new file mode 100644 index 000000000000..9edee0cca309 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryRewritesDebugInfo.cs @@ -0,0 +1,70 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// Contains debugging information specific to query rewrites. + public partial class QueryRewritesDebugInfo + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + internal QueryRewritesDebugInfo() + { + Vectors = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// List of query rewrites generated for the text query. + /// List of query rewrites generated for the vectorizable text queries. + /// Keeps track of any properties unknown to the library. + internal QueryRewritesDebugInfo(QueryRewritesValuesDebugInfo text, IReadOnlyList vectors, IDictionary serializedAdditionalRawData) + { + Text = text; + Vectors = vectors; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// List of query rewrites generated for the text query. + public QueryRewritesValuesDebugInfo Text { get; } + /// List of query rewrites generated for the vectorizable text queries. + public IReadOnlyList Vectors { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryRewritesType.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryRewritesType.cs new file mode 100644 index 000000000000..043c5d25371b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryRewritesType.cs @@ -0,0 +1,58 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// + /// This parameter is only valid if the query type is `semantic`. When + /// QueryRewrites is set to `generative`, the query terms are sent to a generate + /// model which will produce 10 (default) rewrites to help increase the recall of + /// the request. The requested count can be configured by appending the pipe + /// character `|` followed by the `count-` option, such as + /// `generative|count-3`. Defaults to `None`. + /// + public readonly partial struct QueryRewritesType : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public QueryRewritesType(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string NoneValue = "none"; + private const string GenerativeValue = "generative"; + + /// Do not generate additional query rewrites for this query. + public static QueryRewritesType None { get; } = new QueryRewritesType(NoneValue); + /// Generate alternative query terms to increase the recall of a search request. + public static QueryRewritesType Generative { get; } = new QueryRewritesType(GenerativeValue); + /// Determines if two values are the same. + public static bool operator ==(QueryRewritesType left, QueryRewritesType right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(QueryRewritesType left, QueryRewritesType right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator QueryRewritesType(string value) => new QueryRewritesType(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is QueryRewritesType other && Equals(other); + /// + public bool Equals(QueryRewritesType other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryRewritesValuesDebugInfo.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryRewritesValuesDebugInfo.Serialization.cs new file mode 100644 index 000000000000..ace19c4c53aa --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryRewritesValuesDebugInfo.Serialization.cs @@ -0,0 +1,170 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class QueryRewritesValuesDebugInfo : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(QueryRewritesValuesDebugInfo)} does not support writing '{format}' format."); + } + + if (options.Format != "W" && Optional.IsDefined(InputQuery)) + { + writer.WritePropertyName("inputQuery"u8); + writer.WriteStringValue(InputQuery); + } + if (options.Format != "W" && Optional.IsCollectionDefined(Rewrites)) + { + writer.WritePropertyName("rewrites"u8); + writer.WriteStartArray(); + foreach (var item in Rewrites) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + QueryRewritesValuesDebugInfo IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(QueryRewritesValuesDebugInfo)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeQueryRewritesValuesDebugInfo(document.RootElement, options); + } + + internal static QueryRewritesValuesDebugInfo DeserializeQueryRewritesValuesDebugInfo(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string inputQuery = default; + IReadOnlyList rewrites = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("inputQuery"u8)) + { + inputQuery = property.Value.GetString(); + continue; + } + if (property.NameEquals("rewrites"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + rewrites = array; + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new QueryRewritesValuesDebugInfo(inputQuery, rewrites ?? new ChangeTrackingList(), serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(QueryRewritesValuesDebugInfo)} does not support writing '{options.Format}' format."); + } + } + + QueryRewritesValuesDebugInfo IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeQueryRewritesValuesDebugInfo(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(QueryRewritesValuesDebugInfo)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static QueryRewritesValuesDebugInfo FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeQueryRewritesValuesDebugInfo(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryRewritesValuesDebugInfo.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryRewritesValuesDebugInfo.cs new file mode 100644 index 000000000000..0add652efc5c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryRewritesValuesDebugInfo.cs @@ -0,0 +1,76 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// Contains debugging information specific to query rewrites. + public partial class QueryRewritesValuesDebugInfo + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + internal QueryRewritesValuesDebugInfo() + { + Rewrites = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// + /// The input text to the generative query rewriting model. There may be cases + /// where the user query and the input to the generative model are not identical. + /// + /// List of query rewrites. + /// Keeps track of any properties unknown to the library. + internal QueryRewritesValuesDebugInfo(string inputQuery, IReadOnlyList rewrites, IDictionary serializedAdditionalRawData) + { + InputQuery = inputQuery; + Rewrites = rewrites; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// + /// The input text to the generative query rewriting model. There may be cases + /// where the user query and the input to the generative model are not identical. + /// + public string InputQuery { get; } + /// List of query rewrites. + public IReadOnlyList Rewrites { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QuerySpellerType.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QuerySpellerType.cs new file mode 100644 index 000000000000..5b12d034551a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QuerySpellerType.cs @@ -0,0 +1,54 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// Improve search recall by spell-correcting individual search query terms. + public readonly partial struct QuerySpellerType : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public QuerySpellerType(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string NoneValue = "none"; + private const string LexiconValue = "lexicon"; + + /// Speller not enabled. + public static QuerySpellerType None { get; } = new QuerySpellerType(NoneValue); + /// + /// Speller corrects individual query terms using a static lexicon for the language + /// specified by the queryLanguage parameter. + /// + public static QuerySpellerType Lexicon { get; } = new QuerySpellerType(LexiconValue); + /// Determines if two values are the same. + public static bool operator ==(QuerySpellerType left, QuerySpellerType right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(QuerySpellerType left, QuerySpellerType right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator QuerySpellerType(string value) => new QuerySpellerType(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is QuerySpellerType other && Equals(other); + /// + public bool Equals(QuerySpellerType other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryType.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryType.cs new file mode 100644 index 000000000000..da6ffdec6442 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/QueryType.cs @@ -0,0 +1,71 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// + /// Specifies the syntax of the search query. The default is 'simple'. Use 'full' + /// if your query uses the Lucene query syntax and 'semantic' if query syntax is + /// not needed. + /// + public readonly partial struct QueryType : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public QueryType(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string SimpleValue = "simple"; + private const string FullValue = "full"; + private const string SemanticValue = "semantic"; + + /// + /// Uses the simple query syntax for searches. Search text is interpreted using a + /// simple query language that allows for symbols such as +, * and "". Queries are + /// evaluated across all searchable fields by default, unless the searchFields + /// parameter is specified. + /// + public static QueryType Simple { get; } = new QueryType(SimpleValue); + /// + /// Uses the full Lucene query syntax for searches. Search text is interpreted + /// using the Lucene query language which allows field-specific and weighted + /// searches, as well as other advanced features. + /// + public static QueryType Full { get; } = new QueryType(FullValue); + /// + /// Best suited for queries expressed in natural language as opposed to keywords. + /// Improves precision of search results by re-ranking the top search results using + /// a ranking model trained on the Web corpus. + /// + public static QueryType Semantic { get; } = new QueryType(SemanticValue); + /// Determines if two values are the same. + public static bool operator ==(QueryType left, QueryType right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(QueryType left, QueryType right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator QueryType(string value) => new QueryType(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is QueryType other && Equals(other); + /// + public bool Equals(QueryType other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/ScoringStatistics.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/ScoringStatistics.cs new file mode 100644 index 000000000000..92dfcc334e6a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/ScoringStatistics.cs @@ -0,0 +1,57 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// + /// A value that specifies whether we want to calculate scoring statistics (such as + /// document frequency) globally for more consistent scoring, or locally, for lower + /// latency. The default is 'local'. Use 'global' to aggregate scoring statistics + /// globally before scoring. Using global scoring statistics can increase latency + /// of search queries. + /// + public readonly partial struct ScoringStatistics : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public ScoringStatistics(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string LocalValue = "local"; + private const string GlobalValue = "global"; + + /// The scoring statistics will be calculated locally for lower latency. + public static ScoringStatistics Local { get; } = new ScoringStatistics(LocalValue); + /// The scoring statistics will be calculated globally for more consistent scoring. + public static ScoringStatistics Global { get; } = new ScoringStatistics(GlobalValue); + /// Determines if two values are the same. + public static bool operator ==(ScoringStatistics left, ScoringStatistics right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(ScoringStatistics left, ScoringStatistics right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator ScoringStatistics(string value) => new ScoringStatistics(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is ScoringStatistics other && Equals(other); + /// + public bool Equals(ScoringStatistics other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchClient.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchClient.cs new file mode 100644 index 000000000000..9dd34ef32e33 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchClient.cs @@ -0,0 +1,96 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Search.Documents.Search +{ + // Data plane generated client. + /// Client that can be used to query an index and upload, merge, or delete documents. + public partial class SearchClient + { + private const string AuthorizationHeader = "api-key"; + private readonly AzureKeyCredential _keyCredential; + private static readonly string[] AuthorizationScopes = new string[] { "https://search.azure.com/.default" }; + private readonly TokenCredential _tokenCredential; + private readonly HttpPipeline _pipeline; + private readonly Uri _endpoint; + + /// The ClientDiagnostics is used to provide tracing support for the client library. + internal ClientDiagnostics ClientDiagnostics { get; } + + /// The HTTP pipeline for sending and receiving REST requests and responses. + public virtual HttpPipeline Pipeline => _pipeline; + + /// Initializes a new instance of SearchClient for mocking. + protected SearchClient() + { + } + + /// Initializes a new instance of SearchClient. + /// Service host. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public SearchClient(Uri endpoint, AzureKeyCredential credential) : this(endpoint, credential, new SearchClientOptions()) + { + } + + /// Initializes a new instance of SearchClient. + /// Service host. + /// A credential used to authenticate to an Azure Service. + /// or is null. + public SearchClient(Uri endpoint, TokenCredential credential) : this(endpoint, credential, new SearchClientOptions()) + { + } + + /// Initializes a new instance of SearchClient. + /// Service host. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public SearchClient(Uri endpoint, AzureKeyCredential credential, SearchClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new SearchClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _keyCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new AzureKeyCredentialPolicy(_keyCredential, AuthorizationHeader) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Initializes a new instance of SearchClient. + /// Service host. + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public SearchClient(Uri endpoint, TokenCredential credential, SearchClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new SearchClientOptions(); + + ClientDiagnostics = new ClientDiagnostics(options, true); + _tokenCredential = credential; + _pipeline = HttpPipelineBuilder.Build(options, Array.Empty(), new HttpPipelinePolicy[] { new BearerTokenAuthenticationPolicy(_tokenCredential, AuthorizationScopes) }, new ResponseClassifier()); + _endpoint = endpoint; + } + + /// Initializes a new instance of Documents. + /// The API version to use for this operation. + /// is null. + public virtual Documents GetDocumentsClient(string apiVersion = "2025-03-01-preview") + { + Argument.AssertNotNull(apiVersion, nameof(apiVersion)); + + return new Documents(ClientDiagnostics, _pipeline, _keyCredential, _tokenCredential, _endpoint, apiVersion); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchClientOptions.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchClientOptions.cs new file mode 100644 index 000000000000..7a0b28348355 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchClientOptions.cs @@ -0,0 +1,40 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + /// Client options for SearchClient. + public partial class SearchClientOptions : ClientOptions + { + private const ServiceVersion LatestVersion = ServiceVersion.V2025_03_01_Preview; + + /// The version of the service to use. + public enum ServiceVersion + { + /// Service version "2024-07-01". + V2024_07_01 = 1, + /// Service version "2025-03-01-preview". + V2025_03_01_Preview = 2, + } + + internal string Version { get; } + + /// Initializes new instance of SearchClientOptions. + public SearchClientOptions(ServiceVersion version = LatestVersion) + { + Version = version switch + { + ServiceVersion.V2024_07_01 => "2024-07-01", + ServiceVersion.V2025_03_01_Preview => "2025-03-01-preview", + _ => throw new NotSupportedException() + }; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchDocumentsResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchDocumentsResult.Serialization.cs new file mode 100644 index 000000000000..374504af7e8a --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchDocumentsResult.Serialization.cs @@ -0,0 +1,353 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class SearchDocumentsResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchDocumentsResult)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(Count)) + { + writer.WritePropertyName("@odata.count"u8); + writer.WriteNumberValue(Count.Value); + } + if (Optional.IsDefined(Coverage)) + { + writer.WritePropertyName("@search.coverage"u8); + writer.WriteNumberValue(Coverage.Value); + } + if (Optional.IsCollectionDefined(Facets)) + { + writer.WritePropertyName("@search.facets"u8); + writer.WriteStartObject(); + foreach (var item in Facets) + { + writer.WritePropertyName(item.Key); + if (item.Value == null) + { + writer.WriteNullValue(); + continue; + } + writer.WriteStartArray(); + foreach (var item0 in item.Value) + { + writer.WriteObjectValue(item0, options); + } + writer.WriteEndArray(); + } + writer.WriteEndObject(); + } + if (Optional.IsCollectionDefined(Answers)) + { + writer.WritePropertyName("@search.answers"u8); + writer.WriteStartArray(); + foreach (var item in Answers) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && Optional.IsDefined(DebugInfo)) + { + writer.WritePropertyName("@search.debug"u8); + writer.WriteObjectValue(DebugInfo, options); + } + if (Optional.IsDefined(NextPageParameters)) + { + writer.WritePropertyName("@search.nextPageParameters"u8); + writer.WriteObjectValue(NextPageParameters, options); + } + writer.WritePropertyName("value"u8); + writer.WriteStartArray(); + foreach (var item in Value) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (Optional.IsDefined(NextLink)) + { + writer.WritePropertyName("@odata.nextLink"u8); + writer.WriteStringValue(NextLink); + } + if (Optional.IsDefined(SemanticPartialResponseReason)) + { + writer.WritePropertyName("@search.semanticPartialResponseReason"u8); + writer.WriteStringValue(SemanticPartialResponseReason.Value.ToString()); + } + if (Optional.IsDefined(SemanticPartialResponseType)) + { + writer.WritePropertyName("@search.semanticPartialResponseType"u8); + writer.WriteStringValue(SemanticPartialResponseType.Value.ToString()); + } + if (options.Format != "W" && Optional.IsDefined(SemanticQueryRewritesResultType)) + { + writer.WritePropertyName("@search.semanticQueryRewritesResultType"u8); + writer.WriteStringValue(SemanticQueryRewritesResultType.Value.ToString()); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchDocumentsResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchDocumentsResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchDocumentsResult(document.RootElement, options); + } + + internal static SearchDocumentsResult DeserializeSearchDocumentsResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + long? odataCount = default; + double? searchCoverage = default; + IReadOnlyDictionary> searchFacets = default; + IReadOnlyList searchAnswers = default; + DebugInfo searchDebug = default; + SearchRequest searchNextPageParameters = default; + IReadOnlyList value = default; + string odataNextLink = default; + SemanticErrorReason? searchSemanticPartialResponseReason = default; + SemanticSearchResultsType? searchSemanticPartialResponseType = default; + SemanticQueryRewritesResultType? searchSemanticQueryRewritesResultType = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@odata.count"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + odataCount = property.Value.GetInt64(); + continue; + } + if (property.NameEquals("@search.coverage"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + searchCoverage = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("@search.facets"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + Dictionary> dictionary = new Dictionary>(); + foreach (var property0 in property.Value.EnumerateObject()) + { + if (property0.Value.ValueKind == JsonValueKind.Null) + { + dictionary.Add(property0.Name, null); + } + else + { + List array = new List(); + foreach (var item in property0.Value.EnumerateArray()) + { + array.Add(FacetResult.DeserializeFacetResult(item, options)); + } + dictionary.Add(property0.Name, array); + } + } + searchFacets = dictionary; + continue; + } + if (property.NameEquals("@search.answers"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(QueryAnswerResult.DeserializeQueryAnswerResult(item, options)); + } + searchAnswers = array; + continue; + } + if (property.NameEquals("@search.debug"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + searchDebug = DebugInfo.DeserializeDebugInfo(property.Value, options); + continue; + } + if (property.NameEquals("@search.nextPageParameters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + searchNextPageParameters = SearchRequest.DeserializeSearchRequest(property.Value, options); + continue; + } + if (property.NameEquals("value"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SearchResult.DeserializeSearchResult(item, options)); + } + value = array; + continue; + } + if (property.NameEquals("@odata.nextLink"u8)) + { + odataNextLink = property.Value.GetString(); + continue; + } + if (property.NameEquals("@search.semanticPartialResponseReason"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + searchSemanticPartialResponseReason = new SemanticErrorReason(property.Value.GetString()); + continue; + } + if (property.NameEquals("@search.semanticPartialResponseType"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + searchSemanticPartialResponseType = new SemanticSearchResultsType(property.Value.GetString()); + continue; + } + if (property.NameEquals("@search.semanticQueryRewritesResultType"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + searchSemanticQueryRewritesResultType = new SemanticQueryRewritesResultType(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchDocumentsResult( + odataCount, + searchCoverage, + searchFacets ?? new ChangeTrackingDictionary>(), + searchAnswers ?? new ChangeTrackingList(), + searchDebug, + searchNextPageParameters, + value, + odataNextLink, + searchSemanticPartialResponseReason, + searchSemanticPartialResponseType, + searchSemanticQueryRewritesResultType, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchDocumentsResult)} does not support writing '{options.Format}' format."); + } + } + + SearchDocumentsResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchDocumentsResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchDocumentsResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchDocumentsResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchDocumentsResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchDocumentsResult.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchDocumentsResult.cs new file mode 100644 index 000000000000..d83cf58ee09f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchDocumentsResult.cs @@ -0,0 +1,166 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Search +{ + /// Response containing search results from an index. + public partial class SearchDocumentsResult + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The sequence of results returned by the query. + /// is null. + internal SearchDocumentsResult(IEnumerable value) + { + Argument.AssertNotNull(value, nameof(value)); + + Facets = new ChangeTrackingDictionary>(); + Answers = new ChangeTrackingList(); + Value = value.ToList(); + } + + /// Initializes a new instance of . + /// + /// 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'. + /// + /// Debug information that applies to the search results as a whole. + /// + /// 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 + /// + /// The sequence of results returned by the query. + /// + /// 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. + /// + /// Reason that a partial response was returned for a semantic ranking request. + /// Type of partial response that was returned for a semantic ranking request. + /// Type of query rewrite that was used to retrieve documents. + /// Keeps track of any properties unknown to the library. + internal SearchDocumentsResult(long? count, double? coverage, IReadOnlyDictionary> facets, IReadOnlyList answers, DebugInfo debugInfo, SearchRequest nextPageParameters, IReadOnlyList value, string nextLink, SemanticErrorReason? semanticPartialResponseReason, SemanticSearchResultsType? semanticPartialResponseType, SemanticQueryRewritesResultType? semanticQueryRewritesResultType, IDictionary serializedAdditionalRawData) + { + Count = count; + Coverage = coverage; + Facets = facets; + Answers = answers; + DebugInfo = debugInfo; + NextPageParameters = nextPageParameters; + Value = value; + NextLink = nextLink; + SemanticPartialResponseReason = semanticPartialResponseReason; + SemanticPartialResponseType = semanticPartialResponseType; + SemanticQueryRewritesResultType = semanticQueryRewritesResultType; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal 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 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; } + /// + /// 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. + /// + 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; } + /// Debug information that applies to the search results as a whole. + public DebugInfo DebugInfo { get; } + /// + /// 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 + /// + public SearchRequest NextPageParameters { get; } + /// The sequence of results returned by the query. + public IReadOnlyList Value { get; } + /// + /// 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; } + /// Reason that a partial response was returned for a semantic ranking request. + public SemanticErrorReason? SemanticPartialResponseReason { get; } + /// Type of partial response that was returned for a semantic ranking request. + public SemanticSearchResultsType? SemanticPartialResponseType { get; } + /// Type of query rewrite that was used to retrieve documents. + public SemanticQueryRewritesResultType? SemanticQueryRewritesResultType { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchDocumentsSearchClientBuilderExtensions.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchDocumentsSearchClientBuilderExtensions.cs new file mode 100644 index 000000000000..5baed71f5518 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchDocumentsSearchClientBuilderExtensions.cs @@ -0,0 +1,46 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using Azure; +using Azure.Core.Extensions; +using Azure.Search.Documents.Search; + +namespace Microsoft.Extensions.Azure +{ + /// Extension methods to add to client builder. + public static partial class SearchDocumentsSearchClientBuilderExtensions + { + /// Registers a instance. + /// The builder to register with. + /// Service host. + /// A credential used to authenticate to an Azure Service. + public static IAzureClientBuilder AddSearchClient(this TBuilder builder, Uri endpoint, AzureKeyCredential credential) + where TBuilder : IAzureClientFactoryBuilder + { + return builder.RegisterClientFactory((options) => new SearchClient(endpoint, credential, options)); + } + + /// Registers a instance. + /// The builder to register with. + /// Service host. + public static IAzureClientBuilder AddSearchClient(this TBuilder builder, Uri endpoint) + where TBuilder : IAzureClientFactoryBuilderWithCredential + { + return builder.RegisterClientFactory((options, cred) => new SearchClient(endpoint, cred, options)); + } + + /// Registers a instance. + /// The builder to register with. + /// The configuration values. + public static IAzureClientBuilder AddSearchClient(this TBuilder builder, TConfiguration configuration) + where TBuilder : IAzureClientFactoryBuilderWithConfiguration + { + return builder.RegisterClientFactory(configuration); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchDocumentsSearchModelFactory.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchDocumentsSearchModelFactory.cs new file mode 100644 index 000000000000..ba1396981e70 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchDocumentsSearchModelFactory.cs @@ -0,0 +1,540 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Search +{ + /// Model factory for models. + public static partial class SearchDocumentsSearchModelFactory + { + /// Initializes a new instance of . + /// + /// 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'. + /// + /// Debug information that applies to the search results as a whole. + /// + /// 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 + /// + /// The sequence of results returned by the query. + /// + /// 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. + /// + /// Reason that a partial response was returned for a semantic ranking request. + /// Type of partial response that was returned for a semantic ranking request. + /// Type of query rewrite that was used to retrieve documents. + /// A new instance for mocking. + public static SearchDocumentsResult SearchDocumentsResult(long? count = null, double? coverage = null, IReadOnlyDictionary> facets = null, IEnumerable answers = null, DebugInfo debugInfo = null, SearchRequest nextPageParameters = null, IEnumerable value = null, string nextLink = null, SemanticErrorReason? semanticPartialResponseReason = null, SemanticSearchResultsType? semanticPartialResponseType = null, SemanticQueryRewritesResultType? semanticQueryRewritesResultType = null) + { + facets ??= new Dictionary>(); + answers ??= new List(); + value ??= new List(); + + return new SearchDocumentsResult( + count, + coverage, + facets, + answers?.ToList(), + debugInfo, + nextPageParameters, + value?.ToList(), + nextLink, + semanticPartialResponseReason, + semanticPartialResponseType, + semanticQueryRewritesResultType, + serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// + /// The approximate count of documents falling within the bucket described by this + /// facet. + /// + /// + /// The nested facet query results for the search operation, organized as a + /// collection of buckets for each faceted field; null if the query did not contain + /// any nested facets. + /// + /// The resulting total sum for the facet when a sum metric is requested. + /// Additional Properties. + /// A new instance for mocking. + public static FacetResult FacetResult(long? count = null, IReadOnlyDictionary> facets = null, long? sum = null, IReadOnlyDictionary additionalProperties = null) + { + facets ??= new Dictionary>(); + additionalProperties ??= new Dictionary(); + + return new FacetResult(count, facets, sum, additionalProperties); + } + + /// Initializes a new instance of . + /// + /// 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 QueryAnswerResult QueryAnswerResult(double? score = null, string key = null, string text = null, string highlights = null, IReadOnlyDictionary additionalProperties = null) + { + additionalProperties ??= new Dictionary(); + + return new QueryAnswerResult(score, key, text, highlights, additionalProperties); + } + + /// Initializes a new instance of . + /// Contains debugging information specific to query rewrites. + /// A new instance for mocking. + public static DebugInfo DebugInfo(QueryRewritesDebugInfo queryRewrites = null) + { + return new DebugInfo(queryRewrites, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// List of query rewrites generated for the text query. + /// List of query rewrites generated for the vectorizable text queries. + /// A new instance for mocking. + public static QueryRewritesDebugInfo QueryRewritesDebugInfo(QueryRewritesValuesDebugInfo text = null, IEnumerable vectors = null) + { + vectors ??= new List(); + + return new QueryRewritesDebugInfo(text, vectors?.ToList(), serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// + /// The input text to the generative query rewriting model. There may be cases + /// where the user query and the input to the generative model are not identical. + /// + /// List of query rewrites. + /// A new instance for mocking. + public static QueryRewritesValuesDebugInfo QueryRewritesValuesDebugInfo(string inputQuery = null, IEnumerable rewrites = null) + { + rewrites ??= new List(); + + return new QueryRewritesValuesDebugInfo(inputQuery, rewrites?.ToList(), serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// + /// The relevance score of the document compared to other documents returned by the + /// query. + /// + /// + /// The relevance score computed by the semantic ranker for the top search results. + /// Search results are sorted by the RerankerScore first and then by the Score. + /// RerankerScore is only returned for queries of type 'semantic'. + /// + /// + /// Text fragments from the document that indicate the matching search terms, + /// organized by each applicable field; null if hit highlighting was not enabled + /// for the query. + /// + /// + /// Captions are the most representative passages from the document relatively to + /// the search query. They are often used as document summary. Captions are only + /// returned for queries of type 'semantic'. + /// + /// + /// Contains debugging information that can be used to further explore your search + /// results. + /// + /// Additional Properties. + /// A new instance for mocking. + public static SearchResult SearchResult(double score = default, double? rerankerScore = null, IReadOnlyDictionary> highlights = null, IEnumerable captions = null, IEnumerable documentDebugInfo = null, IReadOnlyDictionary additionalProperties = null) + { + highlights ??= new Dictionary>(); + captions ??= new List(); + documentDebugInfo ??= new List(); + additionalProperties ??= new Dictionary(); + + return new SearchResult( + score, + rerankerScore, + highlights, + captions?.ToList(), + documentDebugInfo?.ToList(), + additionalProperties); + } + + /// Initializes a new instance of . + /// + /// 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 QueryCaptionResult QueryCaptionResult(string text = null, string highlights = null, IReadOnlyDictionary additionalProperties = null) + { + additionalProperties ??= new Dictionary(); + + return new QueryCaptionResult(text, highlights, additionalProperties); + } + + /// Initializes a new instance of . + /// Contains debugging information specific to semantic ranking requests. + /// Contains debugging information specific to vector and hybrid search. + /// A new instance for mocking. + public static DocumentDebugInfo DocumentDebugInfo(SemanticDebugInfo semantic = null, VectorsDebugInfo vectors = null) + { + return new DocumentDebugInfo(semantic, vectors, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// + /// 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, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// 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, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// 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, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// + /// The breakdown of subscores of the document prior to the chosen result set + /// fusion/combination method such as RRF. + /// + /// A new instance for mocking. + public static VectorsDebugInfo VectorsDebugInfo(QueryResultDocumentSubscores subscores = null) + { + return new VectorsDebugInfo(subscores, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The BM25 or Classic score for the text portion of the query. + /// The vector similarity and @search.score values for each vector query. + /// The BM25 or Classic score for the text portion of the query. + /// A new instance for mocking. + public static QueryResultDocumentSubscores QueryResultDocumentSubscores(TextResult text = null, IEnumerable> vectors = null, double? documentBoost = null) + { + vectors ??= new List>(); + + return new QueryResultDocumentSubscores(text, vectors?.ToList(), documentBoost, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The BM25 or Classic score for the text portion of the query. + /// A new instance for mocking. + public static TextResult TextResult(double? searchScore = null) + { + return new TextResult(searchScore, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// + /// The @search.score value that is calculated from the vector similarity score. + /// This is the score that's visible in a pure single-field single-vector query. + /// + /// + /// The vector similarity score for this document. Note this is the canonical + /// definition of similarity metric, not the 'distance' version. For example, + /// cosine similarity instead of cosine distance. + /// + /// A new instance for mocking. + public static SingleVectorFieldResult SingleVectorFieldResult(double? searchScore = null, double? vectorSimilarity = null) + { + return new SingleVectorFieldResult(searchScore, vectorSimilarity, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// Additional Properties. + /// A new instance for mocking. + public static LookupDocument LookupDocument(IReadOnlyDictionary additionalProperties = null) + { + additionalProperties ??= new Dictionary(); + + return new LookupDocument(additionalProperties); + } + + /// Initializes a new instance of . + /// The sequence of results returned by the query. + /// + /// A value indicating the percentage of the index that was included in the query, + /// or null if minimumCoverage was not set in the request. + /// + /// A new instance for mocking. + public static SuggestDocumentsResult SuggestDocumentsResult(IEnumerable value = null, double? coverage = null) + { + value ??= new List(); + + return new SuggestDocumentsResult(value?.ToList(), coverage, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The text of the suggestion result. + /// Additional Properties. + /// A new instance for mocking. + public static SuggestResult SuggestResult(string text = null, IReadOnlyDictionary additionalProperties = null) + { + additionalProperties ??= new Dictionary(); + + return new SuggestResult(text, additionalProperties); + } + + /// Initializes a new instance of . + /// An OData expression that filters the documents considered for suggestions. + /// + /// A value indicating whether to use fuzzy matching for the suggestion query. + /// Default is false. When set to true, the query will find suggestions even if + /// there's a substituted or missing character in the search text. While this + /// provides a better experience in some scenarios, it comes at a performance cost + /// as fuzzy suggestion searches are slower and consume more resources. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. If omitted, hit highlighting of suggestions is disabled. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. If omitted, hit highlighting of suggestions is disabled. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by a suggestion query in order for the query to be reported as a + /// success. This parameter can be useful for ensuring search availability even for + /// services with only one replica. The default is 80. + /// + /// + /// The comma-separated list of OData $orderby expressions by which to sort the + /// results. Each expression can be either a field name or a call to either the + /// geo.distance() or the search.score() functions. Each expression can be followed + /// by asc to indicate ascending, or desc to indicate descending. The default is + /// ascending order. Ties will be broken by the match scores of documents. If no + /// $orderby is specified, the default sort order is descending by document match + /// score. There can be at most 32 $orderby clauses. + /// + /// + /// The search text to use to suggest documents. Must be at least 1 character, and + /// no more than 100 characters. + /// + /// + /// The comma-separated list of field names to search for the specified search + /// text. Target fields must be included in the specified suggester. + /// + /// + /// The comma-separated list of fields to retrieve. If unspecified, only the key + /// field will be included in the results. + /// + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + /// + /// The number of suggestions to retrieve. This must be a value between 1 and 100. + /// The default is 5. + /// + /// A new instance for mocking. + public static SuggestRequest SuggestRequest(string filter = null, bool? fuzzy = null, string highlightPostTag = null, string highlightPreTag = null, double? minimumCoverage = null, string orderby = null, string search = null, string searchFields = null, string select = null, string suggesterName = null, int? top = null) + { + return new SuggestRequest( + filter, + fuzzy, + highlightPostTag, + highlightPreTag, + minimumCoverage, + orderby, + search, + searchFields, + select, + suggesterName, + top, + serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The list of status information for each document in the indexing request. + /// A new instance for mocking. + public static IndexDocumentsResult IndexDocumentsResult(IEnumerable value = null) + { + value ??= new List(); + + return new IndexDocumentsResult(value?.ToList(), serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The key of a document that was in the indexing request. + /// + /// The error message explaining why the indexing operation failed for the document + /// identified by the key; null if indexing succeeded. + /// + /// + /// A value indicating whether the indexing operation succeeded for the document + /// identified by the key. + /// + /// + /// The status code of the indexing operation. Possible values include: 200 for a + /// successful update or delete, 201 for successful document creation, 400 for a + /// malformed input document, 404 for document not found, 409 for a version + /// conflict, 422 when the index is temporarily unavailable, or 503 for when the + /// service is too busy. + /// + /// A new instance for mocking. + public static IndexingResult IndexingResult(string key = null, string errorMessage = null, bool status = default, int statusCode = default) + { + return new IndexingResult(key, errorMessage, status, statusCode, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// + /// 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 AutocompleteResult AutocompleteResult(double? coverage = null, IEnumerable value = null) + { + value ??= new List(); + + return new AutocompleteResult(coverage, value?.ToList(), serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The completed term. + /// The query along with the completed term. + /// A new instance for mocking. + public static AutocompleteItem AutocompleteItem(string text = null, string queryPlusText = null) + { + return new AutocompleteItem(text, queryPlusText, serializedAdditionalRawData: null); + } + + /// Initializes a new instance of . + /// The search text on which to base autocomplete results. + /// + /// Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' + /// to get shingles and 'oneTermWithContext' to use the current context while + /// producing auto-completed terms. + /// + /// + /// An OData expression that filters the documents used to produce completed terms + /// for the Autocomplete result. + /// + /// + /// A value indicating whether to use fuzzy matching for the autocomplete query. + /// Default is false. When set to true, the query will autocomplete terms even if + /// there's a substituted or missing character in the search text. While this + /// provides a better experience in some scenarios, it comes at a performance cost + /// as fuzzy autocomplete queries are slower and consume more resources. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. If omitted, hit highlighting is disabled. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. If omitted, hit highlighting is disabled. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by an autocomplete query in order for the query to be reported as a + /// success. This parameter can be useful for ensuring search availability even for + /// services with only one replica. The default is 80. + /// + /// + /// The comma-separated list of field names to consider when querying for + /// auto-completed terms. Target fields must be included in the specified + /// suggester. + /// + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + /// + /// The number of auto-completed terms to retrieve. This must be a value between 1 + /// and 100. The default is 5. + /// + /// A new instance for mocking. + public static AutocompleteRequest AutocompleteRequest(string search = null, AutocompleteMode? autocompleteMode = null, string filter = null, bool? fuzzy = null, string highlightPostTag = null, string highlightPreTag = null, double? minimumCoverage = null, string searchFields = null, string suggesterName = null, int? top = null) + { + return new AutocompleteRequest( + search, + autocompleteMode, + filter, + fuzzy, + highlightPostTag, + highlightPreTag, + minimumCoverage, + searchFields, + suggesterName, + top, + serializedAdditionalRawData: null); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchMode.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchMode.cs new file mode 100644 index 000000000000..48478047f056 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchMode.cs @@ -0,0 +1,60 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// + /// Specifies whether any or all of the search terms must be matched in order to + /// count the document as a match. + /// + public readonly partial struct SearchMode : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public SearchMode(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string AnyValue = "any"; + private const string AllValue = "all"; + + /// + /// Any of the search terms must be matched in order to count the document as a + /// match. + /// + public static SearchMode Any { get; } = new SearchMode(AnyValue); + /// + /// All of the search terms must be matched in order to count the document as a + /// match. + /// + public static SearchMode All { get; } = new SearchMode(AllValue); + /// Determines if two values are the same. + public static bool operator ==(SearchMode left, SearchMode right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(SearchMode left, SearchMode right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator SearchMode(string value) => new SearchMode(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is SearchMode other && Equals(other); + /// + public bool Equals(SearchMode other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchRequest.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchRequest.Serialization.cs new file mode 100644 index 000000000000..92de0b2df70d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchRequest.Serialization.cs @@ -0,0 +1,641 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class SearchRequest : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchRequest)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(Count)) + { + writer.WritePropertyName("count"u8); + writer.WriteBooleanValue(Count.Value); + } + if (Optional.IsCollectionDefined(Facets)) + { + writer.WritePropertyName("facets"u8); + writer.WriteStartArray(); + foreach (var item in Facets) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + if (Optional.IsDefined(Filter)) + { + writer.WritePropertyName("filter"u8); + writer.WriteStringValue(Filter); + } + if (Optional.IsDefined(Highlight)) + { + writer.WritePropertyName("highlight"u8); + writer.WriteStringValue(Highlight); + } + if (Optional.IsDefined(HighlightPostTag)) + { + writer.WritePropertyName("highlightPostTag"u8); + writer.WriteStringValue(HighlightPostTag); + } + if (Optional.IsDefined(HighlightPreTag)) + { + writer.WritePropertyName("highlightPreTag"u8); + writer.WriteStringValue(HighlightPreTag); + } + if (Optional.IsDefined(MinimumCoverage)) + { + writer.WritePropertyName("minimumCoverage"u8); + writer.WriteNumberValue(MinimumCoverage.Value); + } + if (Optional.IsDefined(Orderby)) + { + writer.WritePropertyName("orderby"u8); + writer.WriteStringValue(Orderby); + } + if (Optional.IsDefined(QueryType)) + { + writer.WritePropertyName("queryType"u8); + writer.WriteStringValue(QueryType.Value.ToString()); + } + if (Optional.IsDefined(ScoringStatistics)) + { + writer.WritePropertyName("scoringStatistics"u8); + writer.WriteStringValue(ScoringStatistics.Value.ToString()); + } + if (Optional.IsDefined(SessionId)) + { + writer.WritePropertyName("sessionId"u8); + writer.WriteStringValue(SessionId); + } + if (Optional.IsCollectionDefined(ScoringParameters)) + { + writer.WritePropertyName("scoringParameters"u8); + writer.WriteStartArray(); + foreach (var item in ScoringParameters) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + } + if (Optional.IsDefined(ScoringProfile)) + { + writer.WritePropertyName("scoringProfile"u8); + writer.WriteStringValue(ScoringProfile); + } + if (Optional.IsDefined(Debug)) + { + writer.WritePropertyName("debug"u8); + writer.WriteStringValue(Debug.Value.ToString()); + } + if (Optional.IsDefined(Search)) + { + writer.WritePropertyName("search"u8); + writer.WriteStringValue(Search); + } + if (Optional.IsDefined(SearchFields)) + { + writer.WritePropertyName("searchFields"u8); + writer.WriteStringValue(SearchFields); + } + if (Optional.IsDefined(SearchMode)) + { + writer.WritePropertyName("searchMode"u8); + writer.WriteStringValue(SearchMode.Value.ToString()); + } + if (Optional.IsDefined(QueryLanguage)) + { + writer.WritePropertyName("queryLanguage"u8); + writer.WriteStringValue(QueryLanguage.Value.ToString()); + } + if (Optional.IsDefined(Speller)) + { + writer.WritePropertyName("speller"u8); + writer.WriteStringValue(Speller.Value.ToString()); + } + if (Optional.IsDefined(Select)) + { + writer.WritePropertyName("select"u8); + writer.WriteStringValue(Select); + } + if (Optional.IsDefined(Skip)) + { + writer.WritePropertyName("skip"u8); + writer.WriteNumberValue(Skip.Value); + } + if (Optional.IsDefined(Top)) + { + writer.WritePropertyName("top"u8); + writer.WriteNumberValue(Top.Value); + } + if (Optional.IsDefined(SemanticConfiguration)) + { + writer.WritePropertyName("semanticConfiguration"u8); + writer.WriteStringValue(SemanticConfiguration); + } + if (Optional.IsDefined(SemanticErrorHandling)) + { + writer.WritePropertyName("semanticErrorHandling"u8); + writer.WriteStringValue(SemanticErrorHandling.Value.ToString()); + } + if (Optional.IsDefined(SemanticMaxWaitInMilliseconds)) + { + writer.WritePropertyName("semanticMaxWaitInMilliseconds"u8); + writer.WriteNumberValue(SemanticMaxWaitInMilliseconds.Value); + } + if (Optional.IsDefined(SemanticQuery)) + { + writer.WritePropertyName("semanticQuery"u8); + writer.WriteStringValue(SemanticQuery); + } + if (Optional.IsDefined(Answers)) + { + writer.WritePropertyName("answers"u8); + writer.WriteStringValue(Answers.Value.ToString()); + } + if (Optional.IsDefined(Captions)) + { + writer.WritePropertyName("captions"u8); + writer.WriteStringValue(Captions.Value.ToString()); + } + if (Optional.IsDefined(QueryRewrites)) + { + writer.WritePropertyName("queryRewrites"u8); + writer.WriteStringValue(QueryRewrites.Value.ToString()); + } + if (Optional.IsDefined(SemanticFields)) + { + writer.WritePropertyName("semanticFields"u8); + writer.WriteStringValue(SemanticFields); + } + if (Optional.IsCollectionDefined(VectorQueries)) + { + writer.WritePropertyName("vectorQueries"u8); + writer.WriteStartArray(); + foreach (var item in VectorQueries) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (Optional.IsDefined(VectorFilterMode)) + { + writer.WritePropertyName("vectorFilterMode"u8); + writer.WriteStringValue(VectorFilterMode.Value.ToString()); + } + if (Optional.IsDefined(HybridSearch)) + { + writer.WritePropertyName("hybridSearch"u8); + writer.WriteObjectValue(HybridSearch, options); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SearchRequest IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchRequest)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchRequest(document.RootElement, options); + } + + internal static SearchRequest DeserializeSearchRequest(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + bool? count = default; + IList facets = default; + string filter = default; + string highlight = default; + string highlightPostTag = default; + string highlightPreTag = default; + double? minimumCoverage = default; + string orderby = default; + QueryType? queryType = default; + ScoringStatistics? scoringStatistics = default; + string sessionId = default; + IList scoringParameters = default; + string scoringProfile = default; + QueryDebugMode? debug = default; + string search = default; + string searchFields = default; + SearchMode? searchMode = default; + QueryLanguage? queryLanguage = default; + QuerySpellerType? speller = default; + string select = default; + int? skip = default; + int? top = default; + string semanticConfiguration = default; + SemanticErrorMode? semanticErrorHandling = default; + int? semanticMaxWaitInMilliseconds = default; + string semanticQuery = default; + QueryAnswerType? answers = default; + QueryCaptionType? captions = default; + QueryRewritesType? queryRewrites = default; + string semanticFields = default; + IList vectorQueries = default; + VectorFilterMode? vectorFilterMode = default; + HybridSearch hybridSearch = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("count"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + count = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("facets"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + facets = array; + continue; + } + if (property.NameEquals("filter"u8)) + { + filter = property.Value.GetString(); + continue; + } + if (property.NameEquals("highlight"u8)) + { + highlight = property.Value.GetString(); + continue; + } + if (property.NameEquals("highlightPostTag"u8)) + { + highlightPostTag = property.Value.GetString(); + continue; + } + if (property.NameEquals("highlightPreTag"u8)) + { + highlightPreTag = property.Value.GetString(); + continue; + } + if (property.NameEquals("minimumCoverage"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + minimumCoverage = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("orderby"u8)) + { + orderby = property.Value.GetString(); + continue; + } + if (property.NameEquals("queryType"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + queryType = new QueryType(property.Value.GetString()); + continue; + } + if (property.NameEquals("scoringStatistics"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + scoringStatistics = new ScoringStatistics(property.Value.GetString()); + continue; + } + if (property.NameEquals("sessionId"u8)) + { + sessionId = property.Value.GetString(); + continue; + } + if (property.NameEquals("scoringParameters"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + scoringParameters = array; + continue; + } + if (property.NameEquals("scoringProfile"u8)) + { + scoringProfile = property.Value.GetString(); + continue; + } + if (property.NameEquals("debug"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + debug = new QueryDebugMode(property.Value.GetString()); + continue; + } + if (property.NameEquals("search"u8)) + { + search = property.Value.GetString(); + continue; + } + if (property.NameEquals("searchFields"u8)) + { + searchFields = property.Value.GetString(); + continue; + } + if (property.NameEquals("searchMode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + searchMode = new SearchMode(property.Value.GetString()); + continue; + } + if (property.NameEquals("queryLanguage"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + queryLanguage = new QueryLanguage(property.Value.GetString()); + continue; + } + if (property.NameEquals("speller"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + speller = new QuerySpellerType(property.Value.GetString()); + continue; + } + if (property.NameEquals("select"u8)) + { + select = property.Value.GetString(); + continue; + } + if (property.NameEquals("skip"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + skip = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("top"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + top = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("semanticConfiguration"u8)) + { + semanticConfiguration = property.Value.GetString(); + continue; + } + if (property.NameEquals("semanticErrorHandling"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + semanticErrorHandling = new SemanticErrorMode(property.Value.GetString()); + continue; + } + if (property.NameEquals("semanticMaxWaitInMilliseconds"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + semanticMaxWaitInMilliseconds = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("semanticQuery"u8)) + { + semanticQuery = property.Value.GetString(); + continue; + } + if (property.NameEquals("answers"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + answers = new QueryAnswerType(property.Value.GetString()); + continue; + } + if (property.NameEquals("captions"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + captions = new QueryCaptionType(property.Value.GetString()); + continue; + } + if (property.NameEquals("queryRewrites"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + queryRewrites = new QueryRewritesType(property.Value.GetString()); + continue; + } + if (property.NameEquals("semanticFields"u8)) + { + semanticFields = property.Value.GetString(); + continue; + } + if (property.NameEquals("vectorQueries"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(VectorQuery.DeserializeVectorQuery(item, options)); + } + vectorQueries = array; + continue; + } + if (property.NameEquals("vectorFilterMode"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + vectorFilterMode = new VectorFilterMode(property.Value.GetString()); + continue; + } + if (property.NameEquals("hybridSearch"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + hybridSearch = HybridSearch.DeserializeHybridSearch(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchRequest( + count, + facets ?? new ChangeTrackingList(), + filter, + highlight, + highlightPostTag, + highlightPreTag, + minimumCoverage, + orderby, + queryType, + scoringStatistics, + sessionId, + scoringParameters ?? new ChangeTrackingList(), + scoringProfile, + debug, + search, + searchFields, + searchMode, + queryLanguage, + speller, + select, + skip, + top, + semanticConfiguration, + semanticErrorHandling, + semanticMaxWaitInMilliseconds, + semanticQuery, + answers, + captions, + queryRewrites, + semanticFields, + vectorQueries ?? new ChangeTrackingList(), + vectorFilterMode, + hybridSearch, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchRequest)} does not support writing '{options.Format}' format."); + } + } + + SearchRequest IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchRequest(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchRequest)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchRequest FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchRequest(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchRequest.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchRequest.cs new file mode 100644 index 000000000000..2891129c0743 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchRequest.cs @@ -0,0 +1,429 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// Parameters for filtering, sorting, faceting, paging, and other search query + /// behaviors. + /// + public partial class SearchRequest + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + public SearchRequest() + { + Facets = new ChangeTrackingList(); + ScoringParameters = new ChangeTrackingList(); + VectorQueries = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// + /// A value that specifies whether to fetch the total count of results. Default is + /// false. Setting this value to true may have a performance impact. Note that the + /// count returned is an approximation. + /// + /// + /// The list of facet expressions to apply to the search query. Each facet + /// expression contains a field name, optionally followed by a comma-separated list + /// of name:value pairs. + /// + /// The OData $filter expression to apply to the search query. + /// + /// The comma-separated list of field names to use for hit highlights. Only + /// searchable fields can be used for hit highlighting. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. Default is </em>. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. Default is <em>. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by a search query in order for the query to be reported as a success. + /// This parameter can be useful for ensuring search availability even for services + /// with only one replica. The default is 100. + /// + /// + /// The comma-separated list of OData $orderby expressions by which to sort the + /// results. Each expression can be either a field name or a call to either the + /// geo.distance() or the search.score() functions. Each expression can be followed + /// by asc to indicate ascending, or desc to indicate descending. The default is + /// ascending order. Ties will be broken by the match scores of documents. If no + /// $orderby is specified, the default sort order is descending by document match + /// score. There can be at most 32 $orderby clauses. + /// + /// + /// A value that specifies the syntax of the search query. The default is 'simple'. + /// Use 'full' if your query uses the Lucene query syntax. + /// + /// + /// A value that specifies whether we want to calculate scoring statistics (such as + /// document frequency) globally for more consistent scoring, or locally, for lower + /// latency. The default is 'local'. Use 'global' to aggregate scoring statistics + /// globally before scoring. Using global scoring statistics can increase latency + /// of search queries. + /// + /// + /// A value to be used to create a sticky session, which can help getting more + /// consistent results. As long as the same sessionId is used, a best-effort + /// attempt will be made to target the same replica set. Be wary that reusing the + /// same sessionID values repeatedly can interfere with the load balancing of the + /// requests across replicas and adversely affect the performance of the search + /// service. The value used as sessionId cannot start with a '_' character. + /// + /// + /// The list of parameter values to be used in scoring functions (for example, + /// referencePointParameter) using the format name-values. For example, if the + /// scoring profile defines a function with a parameter called 'mylocation' the + /// parameter string would be "mylocation--122.2,44.8" (without the quotes). + /// + /// + /// The name of a scoring profile to evaluate match scores for matching documents + /// in order to sort the 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. + /// + /// A value that specifies the language of the search query. + /// + /// A value that specified the type of the speller to use to spell-correct + /// individual search query terms. + /// + /// + /// The comma-separated list of fields to retrieve. If unspecified, all fields + /// marked as retrievable in the schema are included. + /// + /// + /// 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. + /// + /// + /// 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 + /// (default / current behavior), or to return partial results. + /// + /// + /// 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. + /// + /// + /// Allows setting a separate search query that will be solely used for semantic + /// reranking, semantic captions and semantic answers. Is useful for scenarios + /// where there is a need to use different queries between the base retrieval and + /// ranking phase, and the L2 semantic phase. + /// + /// + /// A value that specifies whether answers should be returned as part of the search + /// response. + /// + /// + /// A value that specifies whether captions should be returned as part of the + /// search response. + /// + /// + /// A value that specifies whether query rewrites should be generated to augment + /// the search query. + /// + /// 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. + /// The available derived classes include , , and . + /// + /// + /// Determines whether or not filters are applied before or after the vector search + /// is performed. Default is 'preFilter' for new indexes. + /// + /// The query parameters to configure hybrid search behaviors. + /// Keeps track of any properties unknown to the library. + internal SearchRequest(bool? count, IList facets, string filter, string highlight, string highlightPostTag, string highlightPreTag, double? minimumCoverage, string orderby, QueryType? queryType, ScoringStatistics? scoringStatistics, string sessionId, IList scoringParameters, string scoringProfile, QueryDebugMode? debug, string search, string searchFields, SearchMode? searchMode, QueryLanguage? queryLanguage, QuerySpellerType? speller, string select, int? skip, int? top, string semanticConfiguration, SemanticErrorMode? semanticErrorHandling, int? semanticMaxWaitInMilliseconds, string semanticQuery, QueryAnswerType? answers, QueryCaptionType? captions, QueryRewritesType? queryRewrites, string semanticFields, IList vectorQueries, VectorFilterMode? vectorFilterMode, HybridSearch hybridSearch, IDictionary serializedAdditionalRawData) + { + Count = count; + Facets = facets; + Filter = filter; + Highlight = highlight; + HighlightPostTag = highlightPostTag; + HighlightPreTag = highlightPreTag; + MinimumCoverage = minimumCoverage; + Orderby = orderby; + QueryType = queryType; + ScoringStatistics = scoringStatistics; + SessionId = sessionId; + ScoringParameters = scoringParameters; + ScoringProfile = scoringProfile; + Debug = debug; + Search = search; + SearchFields = searchFields; + SearchMode = searchMode; + QueryLanguage = queryLanguage; + Speller = speller; + Select = select; + Skip = skip; + Top = top; + SemanticConfiguration = semanticConfiguration; + SemanticErrorHandling = semanticErrorHandling; + SemanticMaxWaitInMilliseconds = semanticMaxWaitInMilliseconds; + SemanticQuery = semanticQuery; + Answers = answers; + Captions = captions; + QueryRewrites = queryRewrites; + SemanticFields = semanticFields; + VectorQueries = vectorQueries; + VectorFilterMode = vectorFilterMode; + HybridSearch = hybridSearch; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// + /// A value that specifies whether to fetch the total count of results. Default is + /// false. Setting this value to true may have a performance impact. Note that the + /// count returned is an approximation. + /// + public bool? Count { get; set; } + /// + /// The list of facet expressions to apply to the search query. Each facet + /// expression contains a field name, optionally followed by a comma-separated list + /// of name:value pairs. + /// + public IList Facets { get; } + /// The OData $filter expression to apply to the search query. + public string Filter { get; set; } + /// + /// The comma-separated list of field names to use for hit highlights. Only + /// searchable fields can be used for hit highlighting. + /// + public string Highlight { get; set; } + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. Default is </em>. + /// + public string HighlightPostTag { get; set; } + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. Default is <em>. + /// + public string HighlightPreTag { get; set; } + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by a search query in order for the query to be reported as a success. + /// This parameter can be useful for ensuring search availability even for services + /// with only one replica. The default is 100. + /// + public double? MinimumCoverage { get; set; } + /// + /// The comma-separated list of OData $orderby expressions by which to sort the + /// results. Each expression can be either a field name or a call to either the + /// geo.distance() or the search.score() functions. Each expression can be followed + /// by asc to indicate ascending, or desc to indicate descending. The default is + /// ascending order. Ties will be broken by the match scores of documents. If no + /// $orderby is specified, the default sort order is descending by document match + /// score. There can be at most 32 $orderby clauses. + /// + public string Orderby { get; set; } + /// + /// A value that specifies the syntax of the search query. The default is 'simple'. + /// Use 'full' if your query uses the Lucene query syntax. + /// + public QueryType? QueryType { get; set; } + /// + /// A value that specifies whether we want to calculate scoring statistics (such as + /// document frequency) globally for more consistent scoring, or locally, for lower + /// latency. The default is 'local'. Use 'global' to aggregate scoring statistics + /// globally before scoring. Using global scoring statistics can increase latency + /// of search queries. + /// + public ScoringStatistics? ScoringStatistics { get; set; } + /// + /// A value to be used to create a sticky session, which can help getting more + /// consistent results. As long as the same sessionId is used, a best-effort + /// attempt will be made to target the same replica set. Be wary that reusing the + /// same sessionID values repeatedly can interfere with the load balancing of the + /// requests across replicas and adversely affect the performance of the search + /// service. The value used as sessionId cannot start with a '_' character. + /// + public string SessionId { get; set; } + /// + /// The list of parameter values to be used in scoring functions (for example, + /// referencePointParameter) using the format name-values. For example, if the + /// scoring profile defines a function with a parameter called 'mylocation' the + /// parameter string would be "mylocation--122.2,44.8" (without the quotes). + /// + public IList ScoringParameters { get; } + /// + /// The name of a scoring profile to evaluate match scores for matching documents + /// in order to sort the results. + /// + public string ScoringProfile { get; set; } + /// + /// Enables a debugging tool that can be used to further explore your reranked + /// results. + /// + public QueryDebugMode? Debug { get; set; } + /// + /// A full-text search query expression; Use "*" or omit this parameter to match + /// all documents. + /// + public string Search { get; set; } + /// + /// 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. + /// + public string SearchFields { 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; } + /// A value that specifies the language of the search query. + public QueryLanguage? QueryLanguage { get; set; } + /// + /// A value that specified the type of the speller to use to spell-correct + /// individual search query terms. + /// + public QuerySpellerType? Speller { get; set; } + /// + /// The comma-separated list of fields to retrieve. If unspecified, all fields + /// marked as retrievable in the schema are included. + /// + public string Select { get; set; } + /// + /// 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. + /// + public int? Skip { get; set; } + /// + /// 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. + /// + public int? Top { get; set; } + /// + /// The name of a semantic configuration that will be used when processing + /// documents for queries of type semantic. + /// + public string SemanticConfiguration { get; set; } + /// + /// Allows the user to choose whether a semantic call should fail completely + /// (default / current behavior), or to return partial results. + /// + public SemanticErrorMode? 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; } + /// + /// Allows setting a separate search query that will be solely used for semantic + /// reranking, semantic captions and semantic answers. Is useful for scenarios + /// where there is a need to use different queries between the base retrieval and + /// ranking phase, and the L2 semantic phase. + /// + public string SemanticQuery { get; set; } + /// + /// A value that specifies whether answers should be returned as part of the search + /// response. + /// + public QueryAnswerType? Answers { get; set; } + /// + /// A value that specifies whether captions should be returned as part of the + /// search response. + /// + public QueryCaptionType? Captions { get; set; } + /// + /// A value that specifies whether query rewrites should be generated to augment + /// the search query. + /// + public QueryRewritesType? QueryRewrites { get; set; } + /// The comma-separated list of field names used for semantic ranking. + public string SemanticFields { get; set; } + /// + /// 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. + /// The available derived classes include , , and . + /// + public IList VectorQueries { get; } + /// + /// Determines whether or not filters are applied before or after the vector search + /// is performed. Default is 'preFilter' for new indexes. + /// + public VectorFilterMode? VectorFilterMode { get; set; } + /// The query parameters to configure hybrid search behaviors. + public HybridSearch HybridSearch { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchResult.Serialization.cs new file mode 100644 index 000000000000..99bbed6c824d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchResult.Serialization.cs @@ -0,0 +1,255 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class SearchResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchResult)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("@search.score"u8); + writer.WriteNumberValue(Score); + if (Optional.IsDefined(RerankerScore)) + { + writer.WritePropertyName("@search.rerankerScore"u8); + writer.WriteNumberValue(RerankerScore.Value); + } + if (Optional.IsCollectionDefined(Highlights)) + { + writer.WritePropertyName("@search.highlights"u8); + writer.WriteStartObject(); + foreach (var item in Highlights) + { + writer.WritePropertyName(item.Key); + if (item.Value == null) + { + writer.WriteNullValue(); + continue; + } + writer.WriteStartArray(); + foreach (var item0 in item.Value) + { + writer.WriteStringValue(item0); + } + writer.WriteEndArray(); + } + writer.WriteEndObject(); + } + if (Optional.IsCollectionDefined(Captions)) + { + writer.WritePropertyName("@search.captions"u8); + writer.WriteStartArray(); + foreach (var item in Captions) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && Optional.IsCollectionDefined(DocumentDebugInfo)) + { + writer.WritePropertyName("@search.documentDebugInfo"u8); + writer.WriteStartArray(); + foreach (var item in DocumentDebugInfo) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + foreach (var item in AdditionalProperties) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + + SearchResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchResult(document.RootElement, options); + } + + internal static SearchResult DeserializeSearchResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + double searchScore = default; + double? searchRerankerScore = default; + IReadOnlyDictionary> searchHighlights = default; + IReadOnlyList searchCaptions = default; + IReadOnlyList searchDocumentDebugInfo = default; + IReadOnlyDictionary additionalProperties = default; + Dictionary additionalPropertiesDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@search.score"u8)) + { + searchScore = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("@search.rerankerScore"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + searchRerankerScore = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("@search.highlights"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + Dictionary> dictionary = new Dictionary>(); + foreach (var property0 in property.Value.EnumerateObject()) + { + if (property0.Value.ValueKind == JsonValueKind.Null) + { + dictionary.Add(property0.Name, null); + } + else + { + List array = new List(); + foreach (var item in property0.Value.EnumerateArray()) + { + array.Add(item.GetString()); + } + dictionary.Add(property0.Name, array); + } + } + searchHighlights = dictionary; + continue; + } + if (property.NameEquals("@search.captions"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(QueryCaptionResult.DeserializeQueryCaptionResult(item, options)); + } + searchCaptions = array; + continue; + } + if (property.NameEquals("@search.documentDebugInfo"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(Search.DocumentDebugInfo.DeserializeDocumentDebugInfo(item, options)); + } + searchDocumentDebugInfo = array; + continue; + } + additionalPropertiesDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + additionalProperties = additionalPropertiesDictionary; + return new SearchResult( + searchScore, + searchRerankerScore, + searchHighlights ?? new ChangeTrackingDictionary>(), + searchCaptions ?? new ChangeTrackingList(), + searchDocumentDebugInfo ?? new ChangeTrackingList(), + additionalProperties); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchResult)} does not support writing '{options.Format}' format."); + } + } + + SearchResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SearchResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchResult.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchResult.cs new file mode 100644 index 000000000000..4ae16b3ab93f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchResult.cs @@ -0,0 +1,130 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// Contains a document found by a search query, plus associated metadata. + public partial class SearchResult + { + /// Initializes a new instance of . + /// + /// The relevance score of the document compared to other documents returned by the + /// query. + /// + internal SearchResult(double score) + { + Score = score; + Highlights = new ChangeTrackingDictionary>(); + Captions = new ChangeTrackingList(); + DocumentDebugInfo = new ChangeTrackingList(); + AdditionalProperties = new ChangeTrackingDictionary(); + } + + /// Initializes a new instance of . + /// + /// The relevance score of the document compared to other documents returned by the + /// query. + /// + /// + /// The relevance score computed by the semantic ranker for the top search results. + /// Search results are sorted by the RerankerScore first and then by the Score. + /// RerankerScore is only returned for queries of type 'semantic'. + /// + /// + /// Text fragments from the document that indicate the matching search terms, + /// organized by each applicable field; null if hit highlighting was not enabled + /// for the query. + /// + /// + /// Captions are the most representative passages from the document relatively to + /// the search query. They are often used as document summary. Captions are only + /// returned for queries of type 'semantic'. + /// + /// + /// Contains debugging information that can be used to further explore your search + /// results. + /// + /// Additional Properties. + internal SearchResult(double score, double? rerankerScore, IReadOnlyDictionary> highlights, IReadOnlyList captions, IReadOnlyList documentDebugInfo, IReadOnlyDictionary additionalProperties) + { + Score = score; + RerankerScore = rerankerScore; + Highlights = highlights; + Captions = captions; + DocumentDebugInfo = documentDebugInfo; + AdditionalProperties = additionalProperties; + } + + /// Initializes a new instance of for deserialization. + internal SearchResult() + { + } + + /// + /// The relevance score of the document compared to other documents returned by the + /// query. + /// + public double Score { get; } + /// + /// The relevance score computed by the semantic ranker for the top search results. + /// Search results are sorted by the RerankerScore first and then by the Score. + /// RerankerScore is only returned for queries of type 'semantic'. + /// + public double? RerankerScore { get; } + /// + /// Text fragments from the document that indicate the matching search terms, + /// organized by each applicable field; null if hit highlighting was not enabled + /// for the query. + /// + public IReadOnlyDictionary> Highlights { get; } + /// + /// Captions are the most representative passages from the document relatively to + /// the search query. They are often used as document summary. Captions are only + /// returned for queries of type 'semantic'. + /// + public IReadOnlyList Captions { get; } + /// + /// Contains debugging information that can be used to further explore your search + /// results. + /// + public IReadOnlyList DocumentDebugInfo { get; } + /// + /// Additional Properties + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + public IReadOnlyDictionary AdditionalProperties { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchScoreThreshold.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchScoreThreshold.Serialization.cs new file mode 100644 index 000000000000..f766d18dbcb2 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchScoreThreshold.Serialization.cs @@ -0,0 +1,134 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class SearchScoreThreshold : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchScoreThreshold)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("value"u8); + writer.WriteNumberValue(Value); + } + + SearchScoreThreshold IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SearchScoreThreshold)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSearchScoreThreshold(document.RootElement, options); + } + + internal static SearchScoreThreshold DeserializeSearchScoreThreshold(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + double value = default; + VectorThresholdKind kind = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("value"u8)) + { + value = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorThresholdKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SearchScoreThreshold(kind, serializedAdditionalRawData, value); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SearchScoreThreshold)} does not support writing '{options.Format}' format."); + } + } + + SearchScoreThreshold IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchScoreThreshold(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SearchScoreThreshold)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new SearchScoreThreshold FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSearchScoreThreshold(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchScoreThreshold.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchScoreThreshold.cs new file mode 100644 index 000000000000..2b7450fa83dc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SearchScoreThreshold.cs @@ -0,0 +1,57 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// The results of the vector query will filter based on the '@search.score' value. + /// Note this is the @search.score returned as part of the search response. The + /// threshold direction will be chosen for higher @search.score. + /// + public partial class SearchScoreThreshold : VectorThreshold + { + /// Initializes a new instance of . + /// + /// The threshold will filter based on the '@search.score' value. Note this is the + /// @search.score returned as part of the search response. The threshold direction + /// will be chosen for higher @search.score. + /// + public SearchScoreThreshold(double value) + { + Kind = VectorThresholdKind.SearchScore; + Value = value; + } + + /// Initializes a new instance of . + /// Type of threshold. + /// Keeps track of any properties unknown to the library. + /// + /// The threshold will filter based on the '@search.score' value. Note this is the + /// @search.score returned as part of the search response. The threshold direction + /// will be chosen for higher @search.score. + /// + internal SearchScoreThreshold(VectorThresholdKind kind, IDictionary serializedAdditionalRawData, double value) : base(kind, serializedAdditionalRawData) + { + Value = value; + } + + /// Initializes a new instance of for deserialization. + internal SearchScoreThreshold() + { + } + + /// + /// The threshold will filter based on the '@search.score' value. Note this is the + /// @search.score returned as part of the search response. The threshold direction + /// will be chosen for higher @search.score. + /// + public double Value { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticDebugInfo.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticDebugInfo.Serialization.cs new file mode 100644 index 000000000000..f168f24528ed --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticDebugInfo.Serialization.cs @@ -0,0 +1,214 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class SemanticDebugInfo : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SemanticDebugInfo)} does not support writing '{format}' format."); + } + + if (options.Format != "W" && Optional.IsDefined(TitleField)) + { + writer.WritePropertyName("titleField"u8); + writer.WriteObjectValue(TitleField, options); + } + if (options.Format != "W" && Optional.IsCollectionDefined(ContentFields)) + { + writer.WritePropertyName("contentFields"u8); + writer.WriteStartArray(); + foreach (var item in ContentFields) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && Optional.IsCollectionDefined(KeywordFields)) + { + writer.WritePropertyName("keywordFields"u8); + writer.WriteStartArray(); + foreach (var item in KeywordFields) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + } + if (options.Format != "W" && Optional.IsDefined(RerankerInput)) + { + writer.WritePropertyName("rerankerInput"u8); + writer.WriteObjectValue(RerankerInput, options); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SemanticDebugInfo IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SemanticDebugInfo)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSemanticDebugInfo(document.RootElement, options); + } + + internal static SemanticDebugInfo DeserializeSemanticDebugInfo(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + QueryResultDocumentSemanticField titleField = default; + IReadOnlyList contentFields = default; + IReadOnlyList keywordFields = default; + QueryResultDocumentRerankerInput rerankerInput = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("titleField"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + titleField = QueryResultDocumentSemanticField.DeserializeQueryResultDocumentSemanticField(property.Value, options); + continue; + } + if (property.NameEquals("contentFields"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(QueryResultDocumentSemanticField.DeserializeQueryResultDocumentSemanticField(item, options)); + } + contentFields = array; + continue; + } + if (property.NameEquals("keywordFields"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(QueryResultDocumentSemanticField.DeserializeQueryResultDocumentSemanticField(item, options)); + } + keywordFields = array; + continue; + } + if (property.NameEquals("rerankerInput"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + rerankerInput = QueryResultDocumentRerankerInput.DeserializeQueryResultDocumentRerankerInput(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SemanticDebugInfo(titleField, contentFields ?? new ChangeTrackingList(), keywordFields ?? new ChangeTrackingList(), rerankerInput, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SemanticDebugInfo)} does not support writing '{options.Format}' format."); + } + } + + SemanticDebugInfo IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSemanticDebugInfo(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SemanticDebugInfo)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SemanticDebugInfo FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSemanticDebugInfo(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticDebugInfo.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticDebugInfo.cs new file mode 100644 index 000000000000..e6ff4cb9bb72 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticDebugInfo.cs @@ -0,0 +1,97 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// Contains debugging information specific to semantic ranking requests. + public partial class SemanticDebugInfo + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + internal SemanticDebugInfo() + { + ContentFields = new ChangeTrackingList(); + KeywordFields = new ChangeTrackingList(); + } + + /// Initializes a new instance of . + /// + /// 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. + /// Keeps track of any properties unknown to the library. + internal SemanticDebugInfo(QueryResultDocumentSemanticField titleField, IReadOnlyList contentFields, IReadOnlyList keywordFields, QueryResultDocumentRerankerInput rerankerInput, IDictionary serializedAdditionalRawData) + { + TitleField = titleField; + ContentFields = contentFields; + KeywordFields = keywordFields; + RerankerInput = rerankerInput; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// + /// The title field that was sent to the semantic enrichment process, as well as + /// how it was used + /// + public QueryResultDocumentSemanticField TitleField { get; } + /// + /// The content fields that were sent to the semantic enrichment process, as well + /// as how they were used + /// + public IReadOnlyList ContentFields { get; } + /// + /// The keyword fields that were sent to the semantic enrichment process, as well + /// as how they were used + /// + public IReadOnlyList KeywordFields { get; } + /// The raw concatenated strings that were sent to the semantic enrichment process. + public QueryResultDocumentRerankerInput RerankerInput { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticErrorMode.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticErrorMode.cs new file mode 100644 index 000000000000..d7a02bbd09c7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticErrorMode.cs @@ -0,0 +1,61 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// + /// Allows the user to choose whether a semantic call should fail completely, or to + /// return partial results. + /// + public readonly partial struct SemanticErrorMode : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public SemanticErrorMode(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string PartialValue = "partial"; + private const string FailValue = "fail"; + + /// + /// If the semantic processing fails, partial results still return. The definition + /// of partial results depends on what semantic step failed and what was the reason + /// for failure. + /// + public static SemanticErrorMode Partial { get; } = new SemanticErrorMode(PartialValue); + /// + /// If there is an exception during the semantic processing step, the query will + /// fail and return the appropriate HTTP code depending on the error. + /// + public static SemanticErrorMode Fail { get; } = new SemanticErrorMode(FailValue); + /// Determines if two values are the same. + public static bool operator ==(SemanticErrorMode left, SemanticErrorMode right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(SemanticErrorMode left, SemanticErrorMode right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator SemanticErrorMode(string value) => new SemanticErrorMode(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is SemanticErrorMode other && Equals(other); + /// + public bool Equals(SemanticErrorMode other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticErrorReason.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticErrorReason.cs new file mode 100644 index 000000000000..78b8db7713f1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticErrorReason.cs @@ -0,0 +1,57 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// Reason that a partial response was returned for a semantic ranking request. + public readonly partial struct SemanticErrorReason : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public SemanticErrorReason(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string MaxWaitExceededValue = "maxWaitExceeded"; + private const string CapacityOverloadedValue = "capacityOverloaded"; + private const string TransientValue = "transient"; + + /// + /// If `semanticMaxWaitInMilliseconds` was set and the semantic processing duration + /// exceeded that value. Only the base results were returned. + /// + public static SemanticErrorReason MaxWaitExceeded { get; } = new SemanticErrorReason(MaxWaitExceededValue); + /// The request was throttled. Only the base results were returned. + public static SemanticErrorReason CapacityOverloaded { get; } = new SemanticErrorReason(CapacityOverloadedValue); + /// At least one step of the semantic process failed. + public static SemanticErrorReason Transient { get; } = new SemanticErrorReason(TransientValue); + /// Determines if two values are the same. + public static bool operator ==(SemanticErrorReason left, SemanticErrorReason right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(SemanticErrorReason left, SemanticErrorReason right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator SemanticErrorReason(string value) => new SemanticErrorReason(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is SemanticErrorReason other && Equals(other); + /// + public bool Equals(SemanticErrorReason other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticFieldState.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticFieldState.cs new file mode 100644 index 000000000000..0fcaa3ddd6bc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticFieldState.cs @@ -0,0 +1,54 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// The way the field was used for the semantic enrichment process. + public readonly partial struct SemanticFieldState : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public SemanticFieldState(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string UsedValue = "used"; + private const string UnusedValue = "unused"; + private const string PartialValue = "partial"; + + /// The field was fully used for semantic enrichment. + public static SemanticFieldState Used { get; } = new SemanticFieldState(UsedValue); + /// The field was not used for semantic enrichment. + public static SemanticFieldState Unused { get; } = new SemanticFieldState(UnusedValue); + /// The field was partially used for semantic enrichment. + public static SemanticFieldState Partial { get; } = new SemanticFieldState(PartialValue); + /// Determines if two values are the same. + public static bool operator ==(SemanticFieldState left, SemanticFieldState right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(SemanticFieldState left, SemanticFieldState right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator SemanticFieldState(string value) => new SemanticFieldState(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is SemanticFieldState other && Equals(other); + /// + public bool Equals(SemanticFieldState other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticQueryRewritesResultType.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticQueryRewritesResultType.cs new file mode 100644 index 000000000000..0b51b217e722 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticQueryRewritesResultType.cs @@ -0,0 +1,51 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// Type of query rewrite that was used for this request. + public readonly partial struct SemanticQueryRewritesResultType : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public SemanticQueryRewritesResultType(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string OriginalQueryOnlyValue = "originalQueryOnly"; + + /// + /// Query rewrites were not successfully generated for this request. Only the + /// original query was used to retrieve the results. + /// + public static SemanticQueryRewritesResultType OriginalQueryOnly { get; } = new SemanticQueryRewritesResultType(OriginalQueryOnlyValue); + /// Determines if two values are the same. + public static bool operator ==(SemanticQueryRewritesResultType left, SemanticQueryRewritesResultType right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(SemanticQueryRewritesResultType left, SemanticQueryRewritesResultType right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator SemanticQueryRewritesResultType(string value) => new SemanticQueryRewritesResultType(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is SemanticQueryRewritesResultType other && Equals(other); + /// + public bool Equals(SemanticQueryRewritesResultType other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticSearchResultsType.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticSearchResultsType.cs new file mode 100644 index 000000000000..c632e4575087 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SemanticSearchResultsType.cs @@ -0,0 +1,55 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// Type of partial response that was returned for a semantic ranking request. + public readonly partial struct SemanticSearchResultsType : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public SemanticSearchResultsType(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string BaseResultsValue = "baseResults"; + private const string RerankedResultsValue = "rerankedResults"; + + /// Results without any semantic enrichment or reranking. + public static SemanticSearchResultsType BaseResults { get; } = new SemanticSearchResultsType(BaseResultsValue); + /// + /// Results have been reranked with the reranker model and will include semantic + /// captions. They will not include any answers, answers highlights or caption + /// highlights. + /// + public static SemanticSearchResultsType RerankedResults { get; } = new SemanticSearchResultsType(RerankedResultsValue); + /// Determines if two values are the same. + public static bool operator ==(SemanticSearchResultsType left, SemanticSearchResultsType right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(SemanticSearchResultsType left, SemanticSearchResultsType right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator SemanticSearchResultsType(string value) => new SemanticSearchResultsType(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is SemanticSearchResultsType other && Equals(other); + /// + public bool Equals(SemanticSearchResultsType other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SingleVectorFieldResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SingleVectorFieldResult.Serialization.cs new file mode 100644 index 000000000000..278526d93784 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SingleVectorFieldResult.Serialization.cs @@ -0,0 +1,164 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class SingleVectorFieldResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SingleVectorFieldResult)} does not support writing '{format}' format."); + } + + if (options.Format != "W" && Optional.IsDefined(SearchScore)) + { + writer.WritePropertyName("searchScore"u8); + writer.WriteNumberValue(SearchScore.Value); + } + if (options.Format != "W" && Optional.IsDefined(VectorSimilarity)) + { + writer.WritePropertyName("vectorSimilarity"u8); + writer.WriteNumberValue(VectorSimilarity.Value); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SingleVectorFieldResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SingleVectorFieldResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSingleVectorFieldResult(document.RootElement, options); + } + + internal static SingleVectorFieldResult DeserializeSingleVectorFieldResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + double? searchScore = default; + double? vectorSimilarity = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("searchScore"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + searchScore = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("vectorSimilarity"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + vectorSimilarity = property.Value.GetDouble(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SingleVectorFieldResult(searchScore, vectorSimilarity, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SingleVectorFieldResult)} does not support writing '{options.Format}' format."); + } + } + + SingleVectorFieldResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSingleVectorFieldResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SingleVectorFieldResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SingleVectorFieldResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSingleVectorFieldResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SingleVectorFieldResult.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SingleVectorFieldResult.cs new file mode 100644 index 000000000000..b6197dfe6c38 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SingleVectorFieldResult.cs @@ -0,0 +1,86 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// A single vector field result. Both @search.score and vector similarity values + /// are returned. Vector similarity is related to @search.score by an equation. + /// + public partial class SingleVectorFieldResult + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + internal SingleVectorFieldResult() + { + } + + /// Initializes a new instance of . + /// + /// The @search.score value that is calculated from the vector similarity score. + /// This is the score that's visible in a pure single-field single-vector query. + /// + /// + /// The vector similarity score for this document. Note this is the canonical + /// definition of similarity metric, not the 'distance' version. For example, + /// cosine similarity instead of cosine distance. + /// + /// Keeps track of any properties unknown to the library. + internal SingleVectorFieldResult(double? searchScore, double? vectorSimilarity, IDictionary serializedAdditionalRawData) + { + SearchScore = searchScore; + VectorSimilarity = vectorSimilarity; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// + /// The @search.score value that is calculated from the vector similarity score. + /// This is the score that's visible in a pure single-field single-vector query. + /// + public double? SearchScore { get; } + /// + /// The vector similarity score for this document. Note this is the canonical + /// definition of similarity metric, not the 'distance' version. For example, + /// cosine similarity instead of cosine distance. + /// + public double? VectorSimilarity { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestDocumentsResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestDocumentsResult.Serialization.cs new file mode 100644 index 000000000000..0fbab9a19bda --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestDocumentsResult.Serialization.cs @@ -0,0 +1,167 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class SuggestDocumentsResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SuggestDocumentsResult)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("value"u8); + writer.WriteStartArray(); + foreach (var item in Value) + { + writer.WriteObjectValue(item, options); + } + writer.WriteEndArray(); + if (Optional.IsDefined(Coverage)) + { + writer.WritePropertyName("@search.coverage"u8); + writer.WriteNumberValue(Coverage.Value); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SuggestDocumentsResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SuggestDocumentsResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSuggestDocumentsResult(document.RootElement, options); + } + + internal static SuggestDocumentsResult DeserializeSuggestDocumentsResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IReadOnlyList value = default; + double? searchCoverage = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("value"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(SuggestResult.DeserializeSuggestResult(item, options)); + } + value = array; + continue; + } + if (property.NameEquals("@search.coverage"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + searchCoverage = property.Value.GetDouble(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SuggestDocumentsResult(value, searchCoverage, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SuggestDocumentsResult)} does not support writing '{options.Format}' format."); + } + } + + SuggestDocumentsResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSuggestDocumentsResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SuggestDocumentsResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SuggestDocumentsResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSuggestDocumentsResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestDocumentsResult.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestDocumentsResult.cs new file mode 100644 index 000000000000..1a2ad4860e24 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestDocumentsResult.cs @@ -0,0 +1,86 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Search +{ + /// Response containing suggestion query results from an index. + public partial class SuggestDocumentsResult + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// The sequence of results returned by the query. + /// is null. + internal SuggestDocumentsResult(IEnumerable value) + { + Argument.AssertNotNull(value, nameof(value)); + + Value = value.ToList(); + } + + /// Initializes a new instance of . + /// The sequence of results returned by the query. + /// + /// A value indicating the percentage of the index that was included in the query, + /// or null if minimumCoverage was not set in the request. + /// + /// Keeps track of any properties unknown to the library. + internal SuggestDocumentsResult(IReadOnlyList value, double? coverage, IDictionary serializedAdditionalRawData) + { + Value = value; + Coverage = coverage; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SuggestDocumentsResult() + { + } + + /// The sequence of results returned by the query. + public IReadOnlyList Value { get; } + /// + /// A value indicating the percentage of the index that was included in the query, + /// or null if minimumCoverage was not set in the request. + /// + public double? Coverage { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestRequest.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestRequest.Serialization.cs new file mode 100644 index 000000000000..b97399bb199e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestRequest.Serialization.cs @@ -0,0 +1,273 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class SuggestRequest : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SuggestRequest)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(Filter)) + { + writer.WritePropertyName("filter"u8); + writer.WriteStringValue(Filter); + } + if (Optional.IsDefined(Fuzzy)) + { + writer.WritePropertyName("fuzzy"u8); + writer.WriteBooleanValue(Fuzzy.Value); + } + if (Optional.IsDefined(HighlightPostTag)) + { + writer.WritePropertyName("highlightPostTag"u8); + writer.WriteStringValue(HighlightPostTag); + } + if (Optional.IsDefined(HighlightPreTag)) + { + writer.WritePropertyName("highlightPreTag"u8); + writer.WriteStringValue(HighlightPreTag); + } + if (Optional.IsDefined(MinimumCoverage)) + { + writer.WritePropertyName("minimumCoverage"u8); + writer.WriteNumberValue(MinimumCoverage.Value); + } + if (Optional.IsDefined(Orderby)) + { + writer.WritePropertyName("orderby"u8); + writer.WriteStringValue(Orderby); + } + writer.WritePropertyName("search"u8); + writer.WriteStringValue(Search); + if (Optional.IsDefined(SearchFields)) + { + writer.WritePropertyName("searchFields"u8); + writer.WriteStringValue(SearchFields); + } + if (Optional.IsDefined(Select)) + { + writer.WritePropertyName("select"u8); + writer.WriteStringValue(Select); + } + writer.WritePropertyName("suggesterName"u8); + writer.WriteStringValue(SuggesterName); + if (Optional.IsDefined(Top)) + { + writer.WritePropertyName("top"u8); + writer.WriteNumberValue(Top.Value); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + SuggestRequest IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SuggestRequest)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSuggestRequest(document.RootElement, options); + } + + internal static SuggestRequest DeserializeSuggestRequest(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string filter = default; + bool? fuzzy = default; + string highlightPostTag = default; + string highlightPreTag = default; + double? minimumCoverage = default; + string orderby = default; + string search = default; + string searchFields = default; + string select = default; + string suggesterName = default; + int? top = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("filter"u8)) + { + filter = property.Value.GetString(); + continue; + } + if (property.NameEquals("fuzzy"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + fuzzy = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("highlightPostTag"u8)) + { + highlightPostTag = property.Value.GetString(); + continue; + } + if (property.NameEquals("highlightPreTag"u8)) + { + highlightPreTag = property.Value.GetString(); + continue; + } + if (property.NameEquals("minimumCoverage"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + minimumCoverage = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("orderby"u8)) + { + orderby = property.Value.GetString(); + continue; + } + if (property.NameEquals("search"u8)) + { + search = property.Value.GetString(); + continue; + } + if (property.NameEquals("searchFields"u8)) + { + searchFields = property.Value.GetString(); + continue; + } + if (property.NameEquals("select"u8)) + { + select = property.Value.GetString(); + continue; + } + if (property.NameEquals("suggesterName"u8)) + { + suggesterName = property.Value.GetString(); + continue; + } + if (property.NameEquals("top"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + top = property.Value.GetInt32(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new SuggestRequest( + filter, + fuzzy, + highlightPostTag, + highlightPreTag, + minimumCoverage, + orderby, + search, + searchFields, + select, + suggesterName, + top, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SuggestRequest)} does not support writing '{options.Format}' format."); + } + } + + SuggestRequest IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSuggestRequest(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SuggestRequest)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SuggestRequest FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSuggestRequest(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestRequest.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestRequest.cs new file mode 100644 index 000000000000..93c22bab1f2f --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestRequest.cs @@ -0,0 +1,207 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// Parameters for filtering, sorting, fuzzy matching, and other suggestions query + /// behaviors. + /// + public partial class SuggestRequest + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + /// + /// The search text to use to suggest documents. Must be at least 1 character, and + /// no more than 100 characters. + /// + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + /// or is null. + public SuggestRequest(string search, string suggesterName) + { + Argument.AssertNotNull(search, nameof(search)); + Argument.AssertNotNull(suggesterName, nameof(suggesterName)); + + Search = search; + SuggesterName = suggesterName; + } + + /// Initializes a new instance of . + /// An OData expression that filters the documents considered for suggestions. + /// + /// A value indicating whether to use fuzzy matching for the suggestion query. + /// Default is false. When set to true, the query will find suggestions even if + /// there's a substituted or missing character in the search text. While this + /// provides a better experience in some scenarios, it comes at a performance cost + /// as fuzzy suggestion searches are slower and consume more resources. + /// + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. If omitted, hit highlighting of suggestions is disabled. + /// + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. If omitted, hit highlighting of suggestions is disabled. + /// + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by a suggestion query in order for the query to be reported as a + /// success. This parameter can be useful for ensuring search availability even for + /// services with only one replica. The default is 80. + /// + /// + /// The comma-separated list of OData $orderby expressions by which to sort the + /// results. Each expression can be either a field name or a call to either the + /// geo.distance() or the search.score() functions. Each expression can be followed + /// by asc to indicate ascending, or desc to indicate descending. The default is + /// ascending order. Ties will be broken by the match scores of documents. If no + /// $orderby is specified, the default sort order is descending by document match + /// score. There can be at most 32 $orderby clauses. + /// + /// + /// The search text to use to suggest documents. Must be at least 1 character, and + /// no more than 100 characters. + /// + /// + /// The comma-separated list of field names to search for the specified search + /// text. Target fields must be included in the specified suggester. + /// + /// + /// The comma-separated list of fields to retrieve. If unspecified, only the key + /// field will be included in the results. + /// + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + /// + /// The number of suggestions to retrieve. This must be a value between 1 and 100. + /// The default is 5. + /// + /// Keeps track of any properties unknown to the library. + internal SuggestRequest(string filter, bool? fuzzy, string highlightPostTag, string highlightPreTag, double? minimumCoverage, string orderby, string search, string searchFields, string select, string suggesterName, int? top, IDictionary serializedAdditionalRawData) + { + Filter = filter; + Fuzzy = fuzzy; + HighlightPostTag = highlightPostTag; + HighlightPreTag = highlightPreTag; + MinimumCoverage = minimumCoverage; + Orderby = orderby; + Search = search; + SearchFields = searchFields; + Select = select; + SuggesterName = suggesterName; + Top = top; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Initializes a new instance of for deserialization. + internal SuggestRequest() + { + } + + /// An OData expression that filters the documents considered for suggestions. + public string Filter { get; set; } + /// + /// A value indicating whether to use fuzzy matching for the suggestion query. + /// Default is false. When set to true, the query will find suggestions even if + /// there's a substituted or missing character in the search text. While this + /// provides a better experience in some scenarios, it comes at a performance cost + /// as fuzzy suggestion searches are slower and consume more resources. + /// + public bool? Fuzzy { get; set; } + /// + /// A string tag that is appended to hit highlights. Must be set with + /// highlightPreTag. If omitted, hit highlighting of suggestions is disabled. + /// + public string HighlightPostTag { get; set; } + /// + /// A string tag that is prepended to hit highlights. Must be set with + /// highlightPostTag. If omitted, hit highlighting of suggestions is disabled. + /// + public string HighlightPreTag { get; set; } + /// + /// A number between 0 and 100 indicating the percentage of the index that must be + /// covered by a suggestion query in order for the query to be reported as a + /// success. This parameter can be useful for ensuring search availability even for + /// services with only one replica. The default is 80. + /// + public double? MinimumCoverage { get; set; } + /// + /// The comma-separated list of OData $orderby expressions by which to sort the + /// results. Each expression can be either a field name or a call to either the + /// geo.distance() or the search.score() functions. Each expression can be followed + /// by asc to indicate ascending, or desc to indicate descending. The default is + /// ascending order. Ties will be broken by the match scores of documents. If no + /// $orderby is specified, the default sort order is descending by document match + /// score. There can be at most 32 $orderby clauses. + /// + public string Orderby { get; set; } + /// + /// The search text to use to suggest documents. Must be at least 1 character, and + /// no more than 100 characters. + /// + public string Search { get; } + /// + /// The comma-separated list of field names to search for the specified search + /// text. Target fields must be included in the specified suggester. + /// + public string SearchFields { get; set; } + /// + /// The comma-separated list of fields to retrieve. If unspecified, only the key + /// field will be included in the results. + /// + public string Select { get; set; } + /// + /// The name of the suggester as specified in the suggesters collection that's part + /// of the index definition. + /// + public string SuggesterName { get; } + /// + /// The number of suggestions to retrieve. This must be a value between 1 and 100. + /// The default is 5. + /// + public int? Top { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestResult.Serialization.cs new file mode 100644 index 000000000000..1817217b4587 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestResult.Serialization.cs @@ -0,0 +1,136 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class SuggestResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SuggestResult)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("@search.text"u8); + writer.WriteStringValue(Text); + foreach (var item in AdditionalProperties) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + + SuggestResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(SuggestResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeSuggestResult(document.RootElement, options); + } + + internal static SuggestResult DeserializeSuggestResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string searchText = default; + IReadOnlyDictionary additionalProperties = default; + Dictionary additionalPropertiesDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("@search.text"u8)) + { + searchText = property.Value.GetString(); + continue; + } + additionalPropertiesDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + additionalProperties = additionalPropertiesDictionary; + return new SuggestResult(searchText, additionalProperties); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(SuggestResult)} does not support writing '{options.Format}' format."); + } + } + + SuggestResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSuggestResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(SuggestResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static SuggestResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeSuggestResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestResult.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestResult.cs new file mode 100644 index 000000000000..7cb75fb5bf65 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/SuggestResult.cs @@ -0,0 +1,78 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// A result containing a document found by a suggestion query, plus associated + /// metadata. + /// + public partial class SuggestResult + { + /// Initializes a new instance of . + /// The text of the suggestion result. + /// is null. + internal SuggestResult(string text) + { + Argument.AssertNotNull(text, nameof(text)); + + Text = text; + AdditionalProperties = new ChangeTrackingDictionary(); + } + + /// Initializes a new instance of . + /// The text of the suggestion result. + /// Additional Properties. + internal SuggestResult(string text, IReadOnlyDictionary additionalProperties) + { + Text = text; + AdditionalProperties = additionalProperties; + } + + /// Initializes a new instance of for deserialization. + internal SuggestResult() + { + } + + /// The text of the suggestion result. + public string Text { get; } + /// + /// Additional Properties + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + public IReadOnlyDictionary AdditionalProperties { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/TextResult.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/TextResult.Serialization.cs new file mode 100644 index 000000000000..29da41f58f3e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/TextResult.Serialization.cs @@ -0,0 +1,149 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class TextResult : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TextResult)} does not support writing '{format}' format."); + } + + if (options.Format != "W" && Optional.IsDefined(SearchScore)) + { + writer.WritePropertyName("searchScore"u8); + writer.WriteNumberValue(SearchScore.Value); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + TextResult IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(TextResult)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeTextResult(document.RootElement, options); + } + + internal static TextResult DeserializeTextResult(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + double? searchScore = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("searchScore"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + searchScore = property.Value.GetDouble(); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new TextResult(searchScore, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(TextResult)} does not support writing '{options.Format}' format."); + } + } + + TextResult IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeTextResult(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(TextResult)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static TextResult FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeTextResult(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/TextResult.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/TextResult.cs new file mode 100644 index 000000000000..3d61d488df55 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/TextResult.cs @@ -0,0 +1,65 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// The BM25 or Classic score for the text portion of the query. + public partial class TextResult + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + internal TextResult() + { + } + + /// Initializes a new instance of . + /// The BM25 or Classic score for the text portion of the query. + /// Keeps track of any properties unknown to the library. + internal TextResult(double? searchScore, IDictionary serializedAdditionalRawData) + { + SearchScore = searchScore; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// The BM25 or Classic score for the text portion of the query. + public double? SearchScore { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/UnknownVectorQuery.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/UnknownVectorQuery.Serialization.cs new file mode 100644 index 000000000000..336ca970ae88 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/UnknownVectorQuery.Serialization.cs @@ -0,0 +1,197 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + internal partial class UnknownVectorQuery : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorQuery)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + VectorQuery IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorQuery)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorQuery(document.RootElement, options); + } + + internal static UnknownVectorQuery DeserializeUnknownVectorQuery(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + int? k = default; + string fields = default; + bool? exhaustive = default; + double? oversampling = default; + float? weight = default; + VectorThreshold threshold = default; + string filterOverride = default; + VectorQueryKind kind = "Unknown"; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("k"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + k = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("fields"u8)) + { + fields = property.Value.GetString(); + continue; + } + if (property.NameEquals("exhaustive"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + exhaustive = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("oversampling"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + oversampling = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("weight"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + weight = property.Value.GetSingle(); + continue; + } + if (property.NameEquals("threshold"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + threshold = VectorThreshold.DeserializeVectorThreshold(property.Value, options); + continue; + } + if (property.NameEquals("filterOverride"u8)) + { + filterOverride = property.Value.GetString(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorQueryKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownVectorQuery( + k, + fields, + exhaustive, + oversampling, + weight, + threshold, + filterOverride, + kind, + serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorQuery)} does not support writing '{options.Format}' format."); + } + } + + VectorQuery IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorQuery(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorQuery)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownVectorQuery FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownVectorQuery(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/UnknownVectorQuery.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/UnknownVectorQuery.cs new file mode 100644 index 000000000000..a6c8f913d795 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/UnknownVectorQuery.cs @@ -0,0 +1,63 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// Unknown version of VectorQuery. + internal partial class UnknownVectorQuery : VectorQuery + { + /// Initializes a new instance of . + /// Number of nearest neighbors to return as top hits. + /// + /// Vector Fields of type Collection(Edm.Single) to be included in the vector + /// searched. + /// + /// + /// When true, triggers an exhaustive k-nearest neighbor search across all vectors + /// within the vector index. Useful for scenarios where exact matches are critical, + /// such as determining ground truth values. + /// + /// + /// Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' + /// parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' + /// is true. This parameter is only permitted when a + /// compression method is used on the underlying vector field. + /// + /// + /// Relative weight of the vector query when compared to other vector query and/or + /// the text query within the same search request. This value is used when + /// combining the results of multiple ranking lists produced by the different + /// vector queries and/or the results retrieved through the text query. The higher + /// the weight, the higher the documents that matched that query will be in the + /// final ranking. Default is 1.0 and the value needs to be a positive number + /// larger than zero. + /// + /// + /// The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric. + /// 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 . + /// + /// + /// The OData filter expression to apply to this specific vector query. If no + /// filter expression is defined at the vector level, the expression defined in the + /// top level filter parameter is used instead. + /// + /// Type of query. + /// Keeps track of any properties unknown to the library. + internal UnknownVectorQuery(int? k, string fields, bool? exhaustive, double? oversampling, float? weight, VectorThreshold threshold, string filterOverride, VectorQueryKind kind, IDictionary serializedAdditionalRawData) : base(k, fields, exhaustive, oversampling, weight, threshold, filterOverride, kind, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownVectorQuery() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/UnknownVectorThreshold.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/UnknownVectorThreshold.Serialization.cs new file mode 100644 index 000000000000..1536f8c2651e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/UnknownVectorThreshold.Serialization.cs @@ -0,0 +1,126 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + internal partial class UnknownVectorThreshold : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorThreshold)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + } + + VectorThreshold IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorThreshold)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorThreshold(document.RootElement, options); + } + + internal static UnknownVectorThreshold DeserializeUnknownVectorThreshold(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + VectorThresholdKind kind = "Unknown"; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("kind"u8)) + { + kind = new VectorThresholdKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new UnknownVectorThreshold(kind, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorThreshold)} does not support writing '{options.Format}' format."); + } + } + + VectorThreshold IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorThreshold(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorThreshold)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new UnknownVectorThreshold FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeUnknownVectorThreshold(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/UnknownVectorThreshold.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/UnknownVectorThreshold.cs new file mode 100644 index 000000000000..2165afbd1667 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/UnknownVectorThreshold.cs @@ -0,0 +1,28 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// Unknown version of VectorThreshold. + internal partial class UnknownVectorThreshold : VectorThreshold + { + /// Initializes a new instance of . + /// Type of threshold. + /// Keeps track of any properties unknown to the library. + internal UnknownVectorThreshold(VectorThresholdKind kind, IDictionary serializedAdditionalRawData) : base(kind, serializedAdditionalRawData) + { + } + + /// Initializes a new instance of for deserialization. + internal UnknownVectorThreshold() + { + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorFilterMode.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorFilterMode.cs new file mode 100644 index 000000000000..3454a7ac3d3c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorFilterMode.cs @@ -0,0 +1,58 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// + /// Determines whether or not filters are applied before or after the vector search + /// is performed. + /// + public readonly partial struct VectorFilterMode : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public VectorFilterMode(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string PostFilterValue = "postFilter"; + private const string PreFilterValue = "preFilter"; + + /// + /// The filter will be applied after the candidate set of vector results is + /// returned. Depending on the filter selectivity, this can result in fewer results + /// than requested by the parameter 'k'. + /// + public static VectorFilterMode PostFilter { get; } = new VectorFilterMode(PostFilterValue); + /// The filter will be applied before the search query. + public static VectorFilterMode PreFilter { get; } = new VectorFilterMode(PreFilterValue); + /// Determines if two values are the same. + public static bool operator ==(VectorFilterMode left, VectorFilterMode right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(VectorFilterMode left, VectorFilterMode right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator VectorFilterMode(string value) => new VectorFilterMode(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is VectorFilterMode other && Equals(other); + /// + public bool Equals(VectorFilterMode other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorQuery.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorQuery.Serialization.cs new file mode 100644 index 000000000000..d1f1f0caec1d --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorQuery.Serialization.cs @@ -0,0 +1,171 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + [PersistableModelProxy(typeof(UnknownVectorQuery))] + public partial class VectorQuery : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorQuery)} does not support writing '{format}' format."); + } + + if (Optional.IsDefined(K)) + { + writer.WritePropertyName("k"u8); + writer.WriteNumberValue(K.Value); + } + if (Optional.IsDefined(Fields)) + { + writer.WritePropertyName("fields"u8); + writer.WriteStringValue(Fields); + } + if (Optional.IsDefined(Exhaustive)) + { + writer.WritePropertyName("exhaustive"u8); + writer.WriteBooleanValue(Exhaustive.Value); + } + if (Optional.IsDefined(Oversampling)) + { + writer.WritePropertyName("oversampling"u8); + writer.WriteNumberValue(Oversampling.Value); + } + if (Optional.IsDefined(Weight)) + { + writer.WritePropertyName("weight"u8); + writer.WriteNumberValue(Weight.Value); + } + if (Optional.IsDefined(Threshold)) + { + writer.WritePropertyName("threshold"u8); + writer.WriteObjectValue(Threshold, options); + } + if (Optional.IsDefined(FilterOverride)) + { + writer.WritePropertyName("filterOverride"u8); + writer.WriteStringValue(FilterOverride); + } + writer.WritePropertyName("kind"u8); + writer.WriteStringValue(Kind.ToString()); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + VectorQuery IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorQuery)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorQuery(document.RootElement, options); + } + + internal static VectorQuery DeserializeVectorQuery(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("kind", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "imageBinary": return VectorizableImageBinaryQuery.DeserializeVectorizableImageBinaryQuery(element, options); + case "imageUrl": return VectorizableImageUrlQuery.DeserializeVectorizableImageUrlQuery(element, options); + case "text": return VectorizableTextQuery.DeserializeVectorizableTextQuery(element, options); + case "vector": return VectorizedQuery.DeserializeVectorizedQuery(element, options); + } + } + return UnknownVectorQuery.DeserializeUnknownVectorQuery(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorQuery)} does not support writing '{options.Format}' format."); + } + } + + VectorQuery IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorQuery(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorQuery)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static VectorQuery FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorQuery(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorQuery.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorQuery.cs new file mode 100644 index 000000000000..65f723fc473c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorQuery.cs @@ -0,0 +1,153 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// 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. + /// The available derived classes include , , and . + /// + public abstract partial class VectorQuery + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + protected VectorQuery() + { + } + + /// Initializes a new instance of . + /// Number of nearest neighbors to return as top hits. + /// + /// Vector Fields of type Collection(Edm.Single) to be included in the vector + /// searched. + /// + /// + /// When true, triggers an exhaustive k-nearest neighbor search across all vectors + /// within the vector index. Useful for scenarios where exact matches are critical, + /// such as determining ground truth values. + /// + /// + /// Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' + /// parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' + /// is true. This parameter is only permitted when a + /// compression method is used on the underlying vector field. + /// + /// + /// Relative weight of the vector query when compared to other vector query and/or + /// the text query within the same search request. This value is used when + /// combining the results of multiple ranking lists produced by the different + /// vector queries and/or the results retrieved through the text query. The higher + /// the weight, the higher the documents that matched that query will be in the + /// final ranking. Default is 1.0 and the value needs to be a positive number + /// larger than zero. + /// + /// + /// The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric. + /// 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 . + /// + /// + /// The OData filter expression to apply to this specific vector query. If no + /// filter expression is defined at the vector level, the expression defined in the + /// top level filter parameter is used instead. + /// + /// Type of query. + /// Keeps track of any properties unknown to the library. + internal VectorQuery(int? k, string fields, bool? exhaustive, double? oversampling, float? weight, VectorThreshold threshold, string filterOverride, VectorQueryKind kind, IDictionary serializedAdditionalRawData) + { + K = k; + Fields = fields; + Exhaustive = exhaustive; + Oversampling = oversampling; + Weight = weight; + Threshold = threshold; + FilterOverride = filterOverride; + Kind = kind; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Number of nearest neighbors to return as top hits. + public int? K { get; set; } + /// + /// Vector Fields of type Collection(Edm.Single) to be included in the vector + /// searched. + /// + public string Fields { get; set; } + /// + /// When true, triggers an exhaustive k-nearest neighbor search across all vectors + /// within the vector index. Useful for scenarios where exact matches are critical, + /// such as determining ground truth values. + /// + public bool? Exhaustive { get; set; } + /// + /// Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' + /// parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' + /// is true. This parameter is only permitted when a + /// compression method is used on the underlying vector field. + /// + public double? Oversampling { get; set; } + /// + /// Relative weight of the vector query when compared to other vector query and/or + /// the text query within the same search request. This value is used when + /// combining the results of multiple ranking lists produced by the different + /// vector queries and/or the results retrieved through the text query. The higher + /// the weight, the higher the documents that matched that query will be in the + /// final ranking. Default is 1.0 and the value needs to be a positive number + /// larger than zero. + /// + public float? Weight { get; set; } + /// + /// The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric. + /// 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 VectorThreshold Threshold { get; set; } + /// + /// The OData filter expression to apply to this specific vector query. If no + /// filter expression is defined at the vector level, the expression defined in the + /// top level filter parameter is used instead. + /// + public string FilterOverride { get; set; } + /// Type of query. + internal VectorQueryKind Kind { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorQueryKind.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorQueryKind.cs new file mode 100644 index 000000000000..8de6557e0ce8 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorQueryKind.cs @@ -0,0 +1,63 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// The kind of vector query being performed. + internal readonly partial struct VectorQueryKind : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public VectorQueryKind(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string VectorValue = "vector"; + private const string TextValue = "text"; + private const string ImageUrlValue = "imageUrl"; + private const string ImageBinaryValue = "imageBinary"; + + /// Vector query where a raw vector value is provided. + public static VectorQueryKind Vector { get; } = new VectorQueryKind(VectorValue); + /// Vector query where a text value that needs to be vectorized is provided. + public static VectorQueryKind Text { get; } = new VectorQueryKind(TextValue); + /// + /// Vector query where an url that represents an image value that needs to be + /// vectorized is provided. + /// + public static VectorQueryKind ImageUrl { get; } = new VectorQueryKind(ImageUrlValue); + /// + /// Vector query where a base 64 encoded binary of an image that needs to be + /// vectorized is provided. + /// + public static VectorQueryKind ImageBinary { get; } = new VectorQueryKind(ImageBinaryValue); + /// Determines if two values are the same. + public static bool operator ==(VectorQueryKind left, VectorQueryKind right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(VectorQueryKind left, VectorQueryKind right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator VectorQueryKind(string value) => new VectorQueryKind(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is VectorQueryKind other && Equals(other); + /// + public bool Equals(VectorQueryKind other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorSimilarityThreshold.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorSimilarityThreshold.Serialization.cs new file mode 100644 index 000000000000..3847fdbed259 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorSimilarityThreshold.Serialization.cs @@ -0,0 +1,134 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class VectorSimilarityThreshold : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSimilarityThreshold)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("value"u8); + writer.WriteNumberValue(Value); + } + + VectorSimilarityThreshold IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorSimilarityThreshold)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorSimilarityThreshold(document.RootElement, options); + } + + internal static VectorSimilarityThreshold DeserializeVectorSimilarityThreshold(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + double value = default; + VectorThresholdKind kind = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("value"u8)) + { + value = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorThresholdKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new VectorSimilarityThreshold(kind, serializedAdditionalRawData, value); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorSimilarityThreshold)} does not support writing '{options.Format}' format."); + } + } + + VectorSimilarityThreshold IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorSimilarityThreshold(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorSimilarityThreshold)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new VectorSimilarityThreshold FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorSimilarityThreshold(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorSimilarityThreshold.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorSimilarityThreshold.cs new file mode 100644 index 000000000000..9ea94a78b4d7 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorSimilarityThreshold.cs @@ -0,0 +1,61 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// The results of the vector query will be filtered based on the vector similarity + /// metric. Note this is the canonical definition of similarity metric, not the 'distance' + /// version. The threshold direction (larger or smaller) will be chosen + /// automatically according to the metric used by the field. + /// + public partial class VectorSimilarityThreshold : VectorThreshold + { + /// Initializes a new instance of . + /// + /// The threshold will filter based on the similarity metric value. Note this is + /// the canonical definition of similarity metric, not the 'distance' version. The + /// threshold direction (larger or smaller) will be chosen automatically according + /// to the metric used by the field. + /// + public VectorSimilarityThreshold(double value) + { + Kind = VectorThresholdKind.VectorSimilarity; + Value = value; + } + + /// Initializes a new instance of . + /// Type of threshold. + /// Keeps track of any properties unknown to the library. + /// + /// The threshold will filter based on the similarity metric value. Note this is + /// the canonical definition of similarity metric, not the 'distance' version. The + /// threshold direction (larger or smaller) will be chosen automatically according + /// to the metric used by the field. + /// + internal VectorSimilarityThreshold(VectorThresholdKind kind, IDictionary serializedAdditionalRawData, double value) : base(kind, serializedAdditionalRawData) + { + Value = value; + } + + /// Initializes a new instance of for deserialization. + internal VectorSimilarityThreshold() + { + } + + /// + /// The threshold will filter based on the similarity metric value. Note this is + /// the canonical definition of similarity metric, not the 'distance' version. The + /// threshold direction (larger or smaller) will be chosen automatically according + /// to the metric used by the field. + /// + public double Value { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorThreshold.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorThreshold.Serialization.cs new file mode 100644 index 000000000000..f94c1ef80f8c --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorThreshold.Serialization.cs @@ -0,0 +1,134 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + [PersistableModelProxy(typeof(UnknownVectorThreshold))] + public partial class VectorThreshold : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorThreshold)} does not support writing '{format}' format."); + } + + writer.WritePropertyName("kind"u8); + writer.WriteStringValue(Kind.ToString()); + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + VectorThreshold IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorThreshold)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorThreshold(document.RootElement, options); + } + + internal static VectorThreshold DeserializeVectorThreshold(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + if (element.TryGetProperty("kind", out JsonElement discriminator)) + { + switch (discriminator.GetString()) + { + case "searchScore": return SearchScoreThreshold.DeserializeSearchScoreThreshold(element, options); + case "vectorSimilarity": return VectorSimilarityThreshold.DeserializeVectorSimilarityThreshold(element, options); + } + } + return UnknownVectorThreshold.DeserializeUnknownVectorThreshold(element, options); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorThreshold)} does not support writing '{options.Format}' format."); + } + } + + VectorThreshold IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorThreshold(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorThreshold)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static VectorThreshold FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorThreshold(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorThreshold.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorThreshold.cs new file mode 100644 index 000000000000..009e43ab4dd2 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorThreshold.cs @@ -0,0 +1,69 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// The threshold used for vector 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. + /// The available derived classes include and . + /// + public abstract partial class VectorThreshold + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private protected IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + protected VectorThreshold() + { + } + + /// Initializes a new instance of . + /// Type of threshold. + /// Keeps track of any properties unknown to the library. + internal VectorThreshold(VectorThresholdKind kind, IDictionary serializedAdditionalRawData) + { + Kind = kind; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// Type of threshold. + internal VectorThresholdKind Kind { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorThresholdKind.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorThresholdKind.cs new file mode 100644 index 000000000000..6a9b02bf0f68 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorThresholdKind.cs @@ -0,0 +1,60 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ComponentModel; + +namespace Azure.Search.Documents.Search +{ + /// The kind of vector query being performed. + internal readonly partial struct VectorThresholdKind : IEquatable + { + private readonly string _value; + + /// Initializes a new instance of . + /// is null. + public VectorThresholdKind(string value) + { + _value = value ?? throw new ArgumentNullException(nameof(value)); + } + + private const string VectorSimilarityValue = "vectorSimilarity"; + private const string SearchScoreValue = "searchScore"; + + /// + /// The results of the vector query will be filtered based on the vector similarity + /// metric. Note this is the canonical definition of similarity metric, not the 'distance' + /// version. The threshold direction (larger or smaller) will be chosen + /// automatically according to the metric used by the field. + /// + public static VectorThresholdKind VectorSimilarity { get; } = new VectorThresholdKind(VectorSimilarityValue); + /// + /// The results of the vector query will filter based on the '@search.score' value. + /// Note this is the @search.score returned as part of the search response. The + /// threshold direction will be chosen for higher @search.score. + /// + public static VectorThresholdKind SearchScore { get; } = new VectorThresholdKind(SearchScoreValue); + /// Determines if two values are the same. + public static bool operator ==(VectorThresholdKind left, VectorThresholdKind right) => left.Equals(right); + /// Determines if two values are not the same. + public static bool operator !=(VectorThresholdKind left, VectorThresholdKind right) => !left.Equals(right); + /// Converts a to a . + public static implicit operator VectorThresholdKind(string value) => new VectorThresholdKind(value); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override bool Equals(object obj) => obj is VectorThresholdKind other && Equals(other); + /// + public bool Equals(VectorThresholdKind other) => string.Equals(_value, other._value, StringComparison.InvariantCultureIgnoreCase); + + /// + [EditorBrowsable(EditorBrowsableState.Never)] + public override int GetHashCode() => _value != null ? StringComparer.InvariantCultureIgnoreCase.GetHashCode(_value) : 0; + /// + public override string ToString() => _value; + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableImageBinaryQuery.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableImageBinaryQuery.Serialization.cs new file mode 100644 index 000000000000..39305952707b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableImageBinaryQuery.Serialization.cs @@ -0,0 +1,209 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class VectorizableImageBinaryQuery : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorizableImageBinaryQuery)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(Base64Image)) + { + writer.WritePropertyName("base64Image"u8); + writer.WriteStringValue(Base64Image); + } + } + + VectorizableImageBinaryQuery IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorizableImageBinaryQuery)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorizableImageBinaryQuery(document.RootElement, options); + } + + internal static VectorizableImageBinaryQuery DeserializeVectorizableImageBinaryQuery(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string base64Image = default; + int? k = default; + string fields = default; + bool? exhaustive = default; + double? oversampling = default; + float? weight = default; + VectorThreshold threshold = default; + string filterOverride = default; + VectorQueryKind kind = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("base64Image"u8)) + { + base64Image = property.Value.GetString(); + continue; + } + if (property.NameEquals("k"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + k = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("fields"u8)) + { + fields = property.Value.GetString(); + continue; + } + if (property.NameEquals("exhaustive"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + exhaustive = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("oversampling"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + oversampling = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("weight"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + weight = property.Value.GetSingle(); + continue; + } + if (property.NameEquals("threshold"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + threshold = VectorThreshold.DeserializeVectorThreshold(property.Value, options); + continue; + } + if (property.NameEquals("filterOverride"u8)) + { + filterOverride = property.Value.GetString(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorQueryKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new VectorizableImageBinaryQuery( + k, + fields, + exhaustive, + oversampling, + weight, + threshold, + filterOverride, + kind, + serializedAdditionalRawData, + base64Image); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorizableImageBinaryQuery)} does not support writing '{options.Format}' format."); + } + } + + VectorizableImageBinaryQuery IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorizableImageBinaryQuery(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorizableImageBinaryQuery)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new VectorizableImageBinaryQuery FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorizableImageBinaryQuery(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableImageBinaryQuery.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableImageBinaryQuery.cs new file mode 100644 index 000000000000..9df4ffa1979e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableImageBinaryQuery.cs @@ -0,0 +1,78 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// The query parameters to use for vector search when a base 64 encoded binary of + /// an image that needs to be vectorized is provided. + /// + public partial class VectorizableImageBinaryQuery : VectorQuery + { + /// Initializes a new instance of . + public VectorizableImageBinaryQuery() + { + Kind = VectorQueryKind.ImageBinary; + } + + /// Initializes a new instance of . + /// Number of nearest neighbors to return as top hits. + /// + /// Vector Fields of type Collection(Edm.Single) to be included in the vector + /// searched. + /// + /// + /// When true, triggers an exhaustive k-nearest neighbor search across all vectors + /// within the vector index. Useful for scenarios where exact matches are critical, + /// such as determining ground truth values. + /// + /// + /// Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' + /// parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' + /// is true. This parameter is only permitted when a + /// compression method is used on the underlying vector field. + /// + /// + /// Relative weight of the vector query when compared to other vector query and/or + /// the text query within the same search request. This value is used when + /// combining the results of multiple ranking lists produced by the different + /// vector queries and/or the results retrieved through the text query. The higher + /// the weight, the higher the documents that matched that query will be in the + /// final ranking. Default is 1.0 and the value needs to be a positive number + /// larger than zero. + /// + /// + /// The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric. + /// 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 . + /// + /// + /// The OData filter expression to apply to this specific vector query. If no + /// filter expression is defined at the vector level, the expression defined in the + /// top level filter parameter is used instead. + /// + /// Type of query. + /// Keeps track of any properties unknown to the library. + /// + /// The base 64 encoded binary of an image to be vectorized to perform a vector + /// search query. + /// + internal VectorizableImageBinaryQuery(int? k, string fields, bool? exhaustive, double? oversampling, float? weight, VectorThreshold threshold, string filterOverride, VectorQueryKind kind, IDictionary serializedAdditionalRawData, string base64Image) : base(k, fields, exhaustive, oversampling, weight, threshold, filterOverride, kind, serializedAdditionalRawData) + { + Base64Image = base64Image; + } + + /// + /// The base 64 encoded binary of an image to be vectorized to perform a vector + /// search query. + /// + public string Base64Image { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableImageUrlQuery.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableImageUrlQuery.Serialization.cs new file mode 100644 index 000000000000..444c327c92a3 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableImageUrlQuery.Serialization.cs @@ -0,0 +1,209 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class VectorizableImageUrlQuery : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorizableImageUrlQuery)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + if (Optional.IsDefined(Url)) + { + writer.WritePropertyName("url"u8); + writer.WriteStringValue(Url); + } + } + + VectorizableImageUrlQuery IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorizableImageUrlQuery)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorizableImageUrlQuery(document.RootElement, options); + } + + internal static VectorizableImageUrlQuery DeserializeVectorizableImageUrlQuery(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string url = default; + int? k = default; + string fields = default; + bool? exhaustive = default; + double? oversampling = default; + float? weight = default; + VectorThreshold threshold = default; + string filterOverride = default; + VectorQueryKind kind = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("url"u8)) + { + url = property.Value.GetString(); + continue; + } + if (property.NameEquals("k"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + k = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("fields"u8)) + { + fields = property.Value.GetString(); + continue; + } + if (property.NameEquals("exhaustive"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + exhaustive = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("oversampling"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + oversampling = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("weight"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + weight = property.Value.GetSingle(); + continue; + } + if (property.NameEquals("threshold"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + threshold = VectorThreshold.DeserializeVectorThreshold(property.Value, options); + continue; + } + if (property.NameEquals("filterOverride"u8)) + { + filterOverride = property.Value.GetString(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorQueryKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new VectorizableImageUrlQuery( + k, + fields, + exhaustive, + oversampling, + weight, + threshold, + filterOverride, + kind, + serializedAdditionalRawData, + url); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorizableImageUrlQuery)} does not support writing '{options.Format}' format."); + } + } + + VectorizableImageUrlQuery IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorizableImageUrlQuery(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorizableImageUrlQuery)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new VectorizableImageUrlQuery FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorizableImageUrlQuery(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableImageUrlQuery.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableImageUrlQuery.cs new file mode 100644 index 000000000000..828a7e238c0e --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableImageUrlQuery.cs @@ -0,0 +1,72 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// The query parameters to use for vector search when an url that represents an + /// image value that needs to be vectorized is provided. + /// + public partial class VectorizableImageUrlQuery : VectorQuery + { + /// Initializes a new instance of . + public VectorizableImageUrlQuery() + { + Kind = VectorQueryKind.ImageUrl; + } + + /// Initializes a new instance of . + /// Number of nearest neighbors to return as top hits. + /// + /// Vector Fields of type Collection(Edm.Single) to be included in the vector + /// searched. + /// + /// + /// When true, triggers an exhaustive k-nearest neighbor search across all vectors + /// within the vector index. Useful for scenarios where exact matches are critical, + /// such as determining ground truth values. + /// + /// + /// Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' + /// parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' + /// is true. This parameter is only permitted when a + /// compression method is used on the underlying vector field. + /// + /// + /// Relative weight of the vector query when compared to other vector query and/or + /// the text query within the same search request. This value is used when + /// combining the results of multiple ranking lists produced by the different + /// vector queries and/or the results retrieved through the text query. The higher + /// the weight, the higher the documents that matched that query will be in the + /// final ranking. Default is 1.0 and the value needs to be a positive number + /// larger than zero. + /// + /// + /// The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric. + /// 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 . + /// + /// + /// The OData filter expression to apply to this specific vector query. If no + /// filter expression is defined at the vector level, the expression defined in the + /// top level filter parameter is used instead. + /// + /// Type of query. + /// Keeps track of any properties unknown to the library. + /// The URL of an image to be vectorized to perform a vector search query. + internal VectorizableImageUrlQuery(int? k, string fields, bool? exhaustive, double? oversampling, float? weight, VectorThreshold threshold, string filterOverride, VectorQueryKind kind, IDictionary serializedAdditionalRawData, string url) : base(k, fields, exhaustive, oversampling, weight, threshold, filterOverride, kind, serializedAdditionalRawData) + { + Url = url; + } + + /// The URL of an image to be vectorized to perform a vector search query. + public string Url { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableTextQuery.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableTextQuery.Serialization.cs new file mode 100644 index 000000000000..fd64bb7aaa59 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableTextQuery.Serialization.cs @@ -0,0 +1,222 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class VectorizableTextQuery : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorizableTextQuery)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("text"u8); + writer.WriteStringValue(Text); + if (Optional.IsDefined(QueryRewrites)) + { + writer.WritePropertyName("queryRewrites"u8); + writer.WriteStringValue(QueryRewrites.Value.ToString()); + } + } + + VectorizableTextQuery IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorizableTextQuery)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorizableTextQuery(document.RootElement, options); + } + + internal static VectorizableTextQuery DeserializeVectorizableTextQuery(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + string text = default; + QueryRewritesType? queryRewrites = default; + int? k = default; + string fields = default; + bool? exhaustive = default; + double? oversampling = default; + float? weight = default; + VectorThreshold threshold = default; + string filterOverride = default; + VectorQueryKind kind = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("text"u8)) + { + text = property.Value.GetString(); + continue; + } + if (property.NameEquals("queryRewrites"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + queryRewrites = new QueryRewritesType(property.Value.GetString()); + continue; + } + if (property.NameEquals("k"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + k = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("fields"u8)) + { + fields = property.Value.GetString(); + continue; + } + if (property.NameEquals("exhaustive"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + exhaustive = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("oversampling"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + oversampling = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("weight"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + weight = property.Value.GetSingle(); + continue; + } + if (property.NameEquals("threshold"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + threshold = VectorThreshold.DeserializeVectorThreshold(property.Value, options); + continue; + } + if (property.NameEquals("filterOverride"u8)) + { + filterOverride = property.Value.GetString(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorQueryKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new VectorizableTextQuery( + k, + fields, + exhaustive, + oversampling, + weight, + threshold, + filterOverride, + kind, + serializedAdditionalRawData, + text, + queryRewrites); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorizableTextQuery)} does not support writing '{options.Format}' format."); + } + } + + VectorizableTextQuery IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorizableTextQuery(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorizableTextQuery)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new VectorizableTextQuery FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorizableTextQuery(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableTextQuery.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableTextQuery.cs new file mode 100644 index 000000000000..ad0a66ac89b8 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizableTextQuery.cs @@ -0,0 +1,92 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// + /// The query parameters to use for vector search when a text value that needs to + /// be vectorized is provided. + /// + public partial class VectorizableTextQuery : VectorQuery + { + /// Initializes a new instance of . + /// The text to be vectorized to perform a vector search query. + /// is null. + public VectorizableTextQuery(string text) + { + Argument.AssertNotNull(text, nameof(text)); + + Kind = VectorQueryKind.Text; + Text = text; + } + + /// Initializes a new instance of . + /// Number of nearest neighbors to return as top hits. + /// + /// Vector Fields of type Collection(Edm.Single) to be included in the vector + /// searched. + /// + /// + /// When true, triggers an exhaustive k-nearest neighbor search across all vectors + /// within the vector index. Useful for scenarios where exact matches are critical, + /// such as determining ground truth values. + /// + /// + /// Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' + /// parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' + /// is true. This parameter is only permitted when a + /// compression method is used on the underlying vector field. + /// + /// + /// Relative weight of the vector query when compared to other vector query and/or + /// the text query within the same search request. This value is used when + /// combining the results of multiple ranking lists produced by the different + /// vector queries and/or the results retrieved through the text query. The higher + /// the weight, the higher the documents that matched that query will be in the + /// final ranking. Default is 1.0 and the value needs to be a positive number + /// larger than zero. + /// + /// + /// The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric. + /// 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 . + /// + /// + /// The OData filter expression to apply to this specific vector query. If no + /// filter expression is defined at the vector level, the expression defined in the + /// top level filter parameter is used instead. + /// + /// Type of query. + /// Keeps track of any properties unknown to the library. + /// The text to be vectorized to perform a vector search query. + /// + /// Can be configured to let a generative model rewrite the query before sending it + /// to be vectorized. + /// + internal VectorizableTextQuery(int? k, string fields, bool? exhaustive, double? oversampling, float? weight, VectorThreshold threshold, string filterOverride, VectorQueryKind kind, IDictionary serializedAdditionalRawData, string text, QueryRewritesType? queryRewrites) : base(k, fields, exhaustive, oversampling, weight, threshold, filterOverride, kind, serializedAdditionalRawData) + { + Text = text; + QueryRewrites = queryRewrites; + } + + /// Initializes a new instance of for deserialization. + internal VectorizableTextQuery() + { + } + + /// The text to be vectorized to perform a vector search query. + public string Text { get; set; } + /// + /// Can be configured to let a generative model rewrite the query before sending it + /// to be vectorized. + /// + public QueryRewritesType? QueryRewrites { get; set; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizedQuery.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizedQuery.Serialization.cs new file mode 100644 index 000000000000..25172d262d04 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizedQuery.Serialization.cs @@ -0,0 +1,216 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class VectorizedQuery : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected override void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorizedQuery)} does not support writing '{format}' format."); + } + + base.JsonModelWriteCore(writer, options); + writer.WritePropertyName("vector"u8); + writer.WriteStartArray(); + foreach (var item in Vector) + { + writer.WriteNumberValue(item); + } + writer.WriteEndArray(); + } + + VectorizedQuery IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorizedQuery)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorizedQuery(document.RootElement, options); + } + + internal static VectorizedQuery DeserializeVectorizedQuery(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + IList vector = default; + int? k = default; + string fields = default; + bool? exhaustive = default; + double? oversampling = default; + float? weight = default; + VectorThreshold threshold = default; + string filterOverride = default; + VectorQueryKind kind = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("vector"u8)) + { + List array = new List(); + foreach (var item in property.Value.EnumerateArray()) + { + array.Add(item.GetSingle()); + } + vector = array; + continue; + } + if (property.NameEquals("k"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + k = property.Value.GetInt32(); + continue; + } + if (property.NameEquals("fields"u8)) + { + fields = property.Value.GetString(); + continue; + } + if (property.NameEquals("exhaustive"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + exhaustive = property.Value.GetBoolean(); + continue; + } + if (property.NameEquals("oversampling"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + oversampling = property.Value.GetDouble(); + continue; + } + if (property.NameEquals("weight"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + weight = property.Value.GetSingle(); + continue; + } + if (property.NameEquals("threshold"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + threshold = VectorThreshold.DeserializeVectorThreshold(property.Value, options); + continue; + } + if (property.NameEquals("filterOverride"u8)) + { + filterOverride = property.Value.GetString(); + continue; + } + if (property.NameEquals("kind"u8)) + { + kind = new VectorQueryKind(property.Value.GetString()); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new VectorizedQuery( + k, + fields, + exhaustive, + oversampling, + weight, + threshold, + filterOverride, + kind, + serializedAdditionalRawData, + vector); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorizedQuery)} does not support writing '{options.Format}' format."); + } + } + + VectorizedQuery IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorizedQuery(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorizedQuery)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static new VectorizedQuery FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorizedQuery(document.RootElement); + } + + /// Convert into a . + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizedQuery.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizedQuery.cs new file mode 100644 index 000000000000..7e5e3baf51ee --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorizedQuery.cs @@ -0,0 +1,83 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Linq; + +namespace Azure.Search.Documents.Search +{ + /// + /// The query parameters to use for vector search when a raw vector value is + /// provided. + /// + public partial class VectorizedQuery : VectorQuery + { + /// Initializes a new instance of . + /// The vector representation of a search query. + /// is null. + public VectorizedQuery(IEnumerable vector) + { + Argument.AssertNotNull(vector, nameof(vector)); + + Kind = VectorQueryKind.Vector; + Vector = vector.ToList(); + } + + /// Initializes a new instance of . + /// Number of nearest neighbors to return as top hits. + /// + /// Vector Fields of type Collection(Edm.Single) to be included in the vector + /// searched. + /// + /// + /// When true, triggers an exhaustive k-nearest neighbor search across all vectors + /// within the vector index. Useful for scenarios where exact matches are critical, + /// such as determining ground truth values. + /// + /// + /// Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling' + /// parameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors' + /// is true. This parameter is only permitted when a + /// compression method is used on the underlying vector field. + /// + /// + /// Relative weight of the vector query when compared to other vector query and/or + /// the text query within the same search request. This value is used when + /// combining the results of multiple ranking lists produced by the different + /// vector queries and/or the results retrieved through the text query. The higher + /// the weight, the higher the documents that matched that query will be in the + /// final ranking. Default is 1.0 and the value needs to be a positive number + /// larger than zero. + /// + /// + /// The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric. + /// 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 . + /// + /// + /// The OData filter expression to apply to this specific vector query. If no + /// filter expression is defined at the vector level, the expression defined in the + /// top level filter parameter is used instead. + /// + /// Type of query. + /// Keeps track of any properties unknown to the library. + /// The vector representation of a search query. + internal VectorizedQuery(int? k, string fields, bool? exhaustive, double? oversampling, float? weight, VectorThreshold threshold, string filterOverride, VectorQueryKind kind, IDictionary serializedAdditionalRawData, IList vector) : base(k, fields, exhaustive, oversampling, weight, threshold, filterOverride, kind, serializedAdditionalRawData) + { + Vector = vector; + } + + /// Initializes a new instance of for deserialization. + internal VectorizedQuery() + { + } + + /// The vector representation of a search query. + public IList Vector { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorsDebugInfo.Serialization.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorsDebugInfo.Serialization.cs new file mode 100644 index 000000000000..89e2bccd27a4 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorsDebugInfo.Serialization.cs @@ -0,0 +1,149 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.ClientModel.Primitives; +using System.Collections.Generic; +using System.Text.Json; +using Azure.Core; + +namespace Azure.Search.Documents.Search +{ + public partial class VectorsDebugInfo : IUtf8JsonSerializable, IJsonModel + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) => ((IJsonModel)this).Write(writer, ModelSerializationExtensions.WireOptions); + + void IJsonModel.Write(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + writer.WriteStartObject(); + JsonModelWriteCore(writer, options); + writer.WriteEndObject(); + } + + /// The JSON writer. + /// The client options for reading and writing models. + protected virtual void JsonModelWriteCore(Utf8JsonWriter writer, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorsDebugInfo)} does not support writing '{format}' format."); + } + + if (options.Format != "W" && Optional.IsDefined(Subscores)) + { + writer.WritePropertyName("subscores"u8); + writer.WriteObjectValue(Subscores, options); + } + if (options.Format != "W" && _serializedAdditionalRawData != null) + { + foreach (var item in _serializedAdditionalRawData) + { + writer.WritePropertyName(item.Key); +#if NET6_0_OR_GREATER + writer.WriteRawValue(item.Value); +#else + using (JsonDocument document = JsonDocument.Parse(item.Value, ModelSerializationExtensions.JsonDocumentOptions)) + { + JsonSerializer.Serialize(writer, document.RootElement); + } +#endif + } + } + } + + VectorsDebugInfo IJsonModel.Create(ref Utf8JsonReader reader, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + if (format != "J") + { + throw new FormatException($"The model {nameof(VectorsDebugInfo)} does not support reading '{format}' format."); + } + + using JsonDocument document = JsonDocument.ParseValue(ref reader); + return DeserializeVectorsDebugInfo(document.RootElement, options); + } + + internal static VectorsDebugInfo DeserializeVectorsDebugInfo(JsonElement element, ModelReaderWriterOptions options = null) + { + options ??= ModelSerializationExtensions.WireOptions; + + if (element.ValueKind == JsonValueKind.Null) + { + return null; + } + QueryResultDocumentSubscores subscores = default; + IDictionary serializedAdditionalRawData = default; + Dictionary rawDataDictionary = new Dictionary(); + foreach (var property in element.EnumerateObject()) + { + if (property.NameEquals("subscores"u8)) + { + if (property.Value.ValueKind == JsonValueKind.Null) + { + continue; + } + subscores = QueryResultDocumentSubscores.DeserializeQueryResultDocumentSubscores(property.Value, options); + continue; + } + if (options.Format != "W") + { + rawDataDictionary.Add(property.Name, BinaryData.FromString(property.Value.GetRawText())); + } + } + serializedAdditionalRawData = rawDataDictionary; + return new VectorsDebugInfo(subscores, serializedAdditionalRawData); + } + + BinaryData IPersistableModel.Write(ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + return ModelReaderWriter.Write(this, options); + default: + throw new FormatException($"The model {nameof(VectorsDebugInfo)} does not support writing '{options.Format}' format."); + } + } + + VectorsDebugInfo IPersistableModel.Create(BinaryData data, ModelReaderWriterOptions options) + { + var format = options.Format == "W" ? ((IPersistableModel)this).GetFormatFromOptions(options) : options.Format; + + switch (format) + { + case "J": + { + using JsonDocument document = JsonDocument.Parse(data, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorsDebugInfo(document.RootElement, options); + } + default: + throw new FormatException($"The model {nameof(VectorsDebugInfo)} does not support reading '{options.Format}' format."); + } + } + + string IPersistableModel.GetFormatFromOptions(ModelReaderWriterOptions options) => "J"; + + /// Deserializes the model from a raw response. + /// The response to deserialize the model from. + internal static VectorsDebugInfo FromResponse(Response response) + { + using var document = JsonDocument.Parse(response.Content, ModelSerializationExtensions.JsonDocumentOptions); + return DeserializeVectorsDebugInfo(document.RootElement); + } + + /// Convert into a . + internal virtual RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this, ModelSerializationExtensions.WireOptions); + return content; + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorsDebugInfo.cs b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorsDebugInfo.cs new file mode 100644 index 000000000000..0bc4087ff2fc --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Generated/VectorsDebugInfo.cs @@ -0,0 +1,71 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; + +namespace Azure.Search.Documents.Search +{ + /// "Contains debugging information specific to vector and hybrid search."). + public partial class VectorsDebugInfo + { + /// + /// Keeps track of any properties unknown to the library. + /// + /// To assign an object to the value of this property use . + /// + /// + /// To assign an already formatted json string to this property use . + /// + /// + /// Examples: + /// + /// + /// BinaryData.FromObjectAsJson("foo") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromString("\"foo\"") + /// Creates a payload of "foo". + /// + /// + /// BinaryData.FromObjectAsJson(new { key = "value" }) + /// Creates a payload of { "key": "value" }. + /// + /// + /// BinaryData.FromString("{\"key\": \"value\"}") + /// Creates a payload of { "key": "value" }. + /// + /// + /// + /// + private IDictionary _serializedAdditionalRawData; + + /// Initializes a new instance of . + internal VectorsDebugInfo() + { + } + + /// Initializes a new instance of . + /// + /// The breakdown of subscores of the document prior to the chosen result set + /// fusion/combination method such as RRF. + /// + /// Keeps track of any properties unknown to the library. + internal VectorsDebugInfo(QueryResultDocumentSubscores subscores, IDictionary serializedAdditionalRawData) + { + Subscores = subscores; + _serializedAdditionalRawData = serializedAdditionalRawData; + } + + /// + /// The breakdown of subscores of the document prior to the chosen result set + /// fusion/combination method such as RRF. + /// + public QueryResultDocumentSubscores Subscores { get; } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/src/Properties/AssemblyInfo.cs b/sdk/search/Azure.Search.Documents.Search/src/Properties/AssemblyInfo.cs new file mode 100644 index 000000000000..b3a3f3dde80b --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/src/Properties/AssemblyInfo.cs @@ -0,0 +1,11 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +using System.Runtime.CompilerServices; + +[assembly: InternalsVisibleTo("Azure.Search.Documents.Search.Tests, PublicKey = 0024000004800000940000000602000000240000525341310004000001000100d15ddcb29688295338af4b7686603fe614abd555e09efba8fb88ee09e1f7b1ccaeed2e8f823fa9eef3fdd60217fc012ea67d2479751a0b8c087a4185541b851bd8b16f8d91b840e51b1cb0ba6fe647997e57429265e85ef62d565db50a69ae1647d54d7bd855e4db3d8a91510e5bcbd0edfbbecaa20a7bd9ae74593daa7b11b4")] + +// Replace Microsoft.Test with the correct resource provider namepace for your service and uncomment. +// See https://docs.microsoft.com/en-us/azure/azure-resource-manager/management/azure-services-resource-providers +// for the list of possible values. +[assembly: Azure.Core.AzureResourceProviderNamespace("Microsoft.Template")] diff --git a/sdk/search/Azure.Search.Documents.Search/tests/Azure.Search.Documents.Search.Tests.csproj b/sdk/search/Azure.Search.Documents.Search/tests/Azure.Search.Documents.Search.Tests.csproj new file mode 100644 index 000000000000..c2fd109558f1 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/tests/Azure.Search.Documents.Search.Tests.csproj @@ -0,0 +1,20 @@ + + + $(RequiredTargetFrameworks) + + $(NoWarn);CS1591 + + + + + + + + + + + + + + + diff --git a/sdk/search/Azure.Search.Documents.Search/tests/Generated/Samples/Samples_Documents.cs b/sdk/search/Azure.Search.Documents.Search/tests/Generated/Samples/Samples_Documents.cs new file mode 100644 index 000000000000..9a7e84f2ec94 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/tests/Generated/Samples/Samples_Documents.cs @@ -0,0 +1,1784 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Collections.Generic; +using System.Text.Json; +using System.Threading.Tasks; +using Azure.Core; +using Azure.Identity; +using NUnit.Framework; + +namespace Azure.Search.Documents.Search.Samples +{ + public partial class Samples_Documents + { + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_Count_SearchIndexCountDocuments() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = client.Count("preview-test", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_Count_SearchIndexCountDocuments_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = await client.CountAsync("preview-test", null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_Count_SearchIndexCountDocuments_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = client.Count("preview-test"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_Count_SearchIndexCountDocuments_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = await client.CountAsync("preview-test"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_SearchGet_SearchIndexSearchDocumentsGet() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = client.SearchGet("myindex", "nice hotels", true, new string[] { "category,count:10,sort:count" }, "rating gt 10", new string[] { "title" }, "", "", 80, new string[] { "search.score() desc", "rating desc" }, "simple", null, "sp", new string[] { "title", "description" }, "any", "global", "mysessionid", new string[] { "docId", "title", "description" }, 100, 10, null, null, null, null, null, null, null, null, null, null, null, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_SearchGet_SearchIndexSearchDocumentsGet_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = await client.SearchGetAsync("myindex", "nice hotels", true, new string[] { "category,count:10,sort:count" }, "rating gt 10", new string[] { "title" }, "", "", 80, new string[] { "search.score() desc", "rating desc" }, "simple", null, "sp", new string[] { "title", "description" }, "any", "global", "mysessionid", new string[] { "docId", "title", "description" }, 100, 10, null, null, null, null, null, null, null, null, null, null, null, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_SearchGet_SearchIndexSearchDocumentsGet_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = client.SearchGet("myindex"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_SearchGet_SearchIndexSearchDocumentsGet_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = await client.SearchGetAsync("myindex"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_SearchGet_SearchIndexSearchDocumentsSemanticGet() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = client.SearchGet("myindex", "how do clouds form", true, null, null, null, "", "", null, null, "semantic", null, null, null, null, null, null, null, null, null, "my-semantic-config", "partial", 780, "extractive|count-3", "extractive|highlight-true", null, null, null, null, null, null, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_SearchGet_SearchIndexSearchDocumentsSemanticGet_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = await client.SearchGetAsync("myindex", "how do clouds form", true, null, null, null, "", "", null, null, "semantic", null, null, null, null, null, null, null, null, null, "my-semantic-config", "partial", 780, "extractive|count-3", "extractive|highlight-true", null, null, null, null, null, null, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_SearchGet_SearchIndexSearchDocumentsSemanticGet_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = client.SearchGet("myindex"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_SearchGet_SearchIndexSearchDocumentsSemanticGet_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = await client.SearchGetAsync("myindex"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_SearchPost_SearchIndexSearchDocumentsPost() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + using RequestContent content = RequestContent.Create(new + { + count = true, + facets = new object[] + { +"ownerId", +"price,metric:sum,default:10" + }, + filter = "category eq 'purple' or category eq 'pink'", + highlight = "category", + highlightPostTag = "", + highlightPreTag = "", + minimumCoverage = 100, + queryType = "semantic", + scoringStatistics = "global", + sessionId = "mysessionid", + scoringParameters = new object[] + { +"categoryTag:desiredCategoryValue" + }, + scoringProfile = "stringFieldBoost", + search = "purple", + searchFields = "id,name,description,category,ownerId", + searchMode = "any", + queryLanguage = "en-us", + speller = "lexicon", + select = "id,name,description,category,ownerId", + skip = 0, + top = 10, + semanticConfiguration = "testconfig", + semanticErrorHandling = "partial", + semanticMaxWaitInMilliseconds = 5000, + semanticQuery = "find all purple", + answers = "extractive", + captions = "extractive", + queryRewrites = "generative", + vectorQueries = new object[] + { +new +{ +vector = new object[] +{ +0F, +1F, +2F, +3F, +4F, +5F, +6F, +7F, +8F, +9F +}, +kind = "vector", +k = 50, +fields = "vector22, vector1b", +oversampling = 20, +weight = 1F, +threshold = new +{ +value = 0.984, +kind = "vectorSimilarity", +}, +filterOverride = "ownerId eq 'sam'", +} + }, + vectorFilterMode = "preFilter", + hybridSearch = new + { + maxTextRecallSize = 100, + countAndFacetMode = "countAllResults", + }, + }); + Response response = client.SearchPost("preview-test", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_SearchPost_SearchIndexSearchDocumentsPost_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + using RequestContent content = RequestContent.Create(new + { + count = true, + facets = new object[] + { +"ownerId", +"price,metric:sum,default:10" + }, + filter = "category eq 'purple' or category eq 'pink'", + highlight = "category", + highlightPostTag = "", + highlightPreTag = "", + minimumCoverage = 100, + queryType = "semantic", + scoringStatistics = "global", + sessionId = "mysessionid", + scoringParameters = new object[] + { +"categoryTag:desiredCategoryValue" + }, + scoringProfile = "stringFieldBoost", + search = "purple", + searchFields = "id,name,description,category,ownerId", + searchMode = "any", + queryLanguage = "en-us", + speller = "lexicon", + select = "id,name,description,category,ownerId", + skip = 0, + top = 10, + semanticConfiguration = "testconfig", + semanticErrorHandling = "partial", + semanticMaxWaitInMilliseconds = 5000, + semanticQuery = "find all purple", + answers = "extractive", + captions = "extractive", + queryRewrites = "generative", + vectorQueries = new object[] + { +new +{ +vector = new object[] +{ +0F, +1F, +2F, +3F, +4F, +5F, +6F, +7F, +8F, +9F +}, +kind = "vector", +k = 50, +fields = "vector22, vector1b", +oversampling = 20, +weight = 1F, +threshold = new +{ +value = 0.984, +kind = "vectorSimilarity", +}, +filterOverride = "ownerId eq 'sam'", +} + }, + vectorFilterMode = "preFilter", + hybridSearch = new + { + maxTextRecallSize = 100, + countAndFacetMode = "countAllResults", + }, + }); + Response response = await client.SearchPostAsync("preview-test", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_SearchPost_SearchIndexSearchDocumentsPost_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + SearchRequest searchRequest = new SearchRequest + { + Count = true, + Facets = { "ownerId", "price,metric:sum,default:10" }, + Filter = "category eq 'purple' or category eq 'pink'", + Highlight = "category", + HighlightPostTag = "", + HighlightPreTag = "", + MinimumCoverage = 100, + QueryType = QueryType.Semantic, + ScoringStatistics = ScoringStatistics.Global, + SessionId = "mysessionid", + ScoringParameters = { "categoryTag:desiredCategoryValue" }, + ScoringProfile = "stringFieldBoost", + Search = "purple", + SearchFields = "id,name,description,category,ownerId", + SearchMode = SearchMode.Any, + QueryLanguage = QueryLanguage.EnUs, + Speller = QuerySpellerType.Lexicon, + Select = "id,name,description,category,ownerId", + Skip = 0, + Top = 10, + SemanticConfiguration = "testconfig", + SemanticErrorHandling = SemanticErrorMode.Partial, + SemanticMaxWaitInMilliseconds = 5000, + SemanticQuery = "find all purple", + Answers = QueryAnswerType.Extractive, + Captions = QueryCaptionType.Extractive, + QueryRewrites = QueryRewritesType.Generative, + VectorQueries = {new VectorizedQuery(new float[]{0F, 1F, 2F, 3F, 4F, 5F, 6F, 7F, 8F, 9F}) +{ +K = 50, +Fields = "vector22, vector1b", +Oversampling = 20, +Weight = 1F, +Threshold = new VectorSimilarityThreshold(0.984), +FilterOverride = "ownerId eq 'sam'", +}}, + VectorFilterMode = VectorFilterMode.PreFilter, + HybridSearch = new HybridSearch + { + MaxTextRecallSize = 100, + CountAndFacetMode = HybridCountAndFacetMode.CountAllResults, + }, + }; + Response response = client.SearchPost("preview-test", searchRequest); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_SearchPost_SearchIndexSearchDocumentsPost_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + SearchRequest searchRequest = new SearchRequest + { + Count = true, + Facets = { "ownerId", "price,metric:sum,default:10" }, + Filter = "category eq 'purple' or category eq 'pink'", + Highlight = "category", + HighlightPostTag = "", + HighlightPreTag = "", + MinimumCoverage = 100, + QueryType = QueryType.Semantic, + ScoringStatistics = ScoringStatistics.Global, + SessionId = "mysessionid", + ScoringParameters = { "categoryTag:desiredCategoryValue" }, + ScoringProfile = "stringFieldBoost", + Search = "purple", + SearchFields = "id,name,description,category,ownerId", + SearchMode = SearchMode.Any, + QueryLanguage = QueryLanguage.EnUs, + Speller = QuerySpellerType.Lexicon, + Select = "id,name,description,category,ownerId", + Skip = 0, + Top = 10, + SemanticConfiguration = "testconfig", + SemanticErrorHandling = SemanticErrorMode.Partial, + SemanticMaxWaitInMilliseconds = 5000, + SemanticQuery = "find all purple", + Answers = QueryAnswerType.Extractive, + Captions = QueryCaptionType.Extractive, + QueryRewrites = QueryRewritesType.Generative, + VectorQueries = {new VectorizedQuery(new float[]{0F, 1F, 2F, 3F, 4F, 5F, 6F, 7F, 8F, 9F}) +{ +K = 50, +Fields = "vector22, vector1b", +Oversampling = 20, +Weight = 1F, +Threshold = new VectorSimilarityThreshold(0.984), +FilterOverride = "ownerId eq 'sam'", +}}, + VectorFilterMode = VectorFilterMode.PreFilter, + HybridSearch = new HybridSearch + { + MaxTextRecallSize = 100, + CountAndFacetMode = HybridCountAndFacetMode.CountAllResults, + }, + }; + Response response = await client.SearchPostAsync("preview-test", searchRequest); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_SearchPost_SearchIndexSearchDocumentsSemanticPost() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + using RequestContent content = RequestContent.Create(new + { + count = true, + highlightPostTag = "", + highlightPreTag = "", + queryType = "semantic", + search = "how do clouds form", + semanticConfiguration = "my-semantic-config", + answers = "extractive|count-3", + captions = "extractive|highlight-true", + semanticErrorHandling = "partial", + semanticMaxWaitInMilliseconds = 780, + }); + Response response = client.SearchPost("myindex", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_SearchPost_SearchIndexSearchDocumentsSemanticPost_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + using RequestContent content = RequestContent.Create(new + { + count = true, + highlightPostTag = "", + highlightPreTag = "", + queryType = "semantic", + search = "how do clouds form", + semanticConfiguration = "my-semantic-config", + answers = "extractive|count-3", + captions = "extractive|highlight-true", + semanticErrorHandling = "partial", + semanticMaxWaitInMilliseconds = 780, + }); + Response response = await client.SearchPostAsync("myindex", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.score").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_SearchPost_SearchIndexSearchDocumentsSemanticPost_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + SearchRequest searchRequest = new SearchRequest + { + Count = true, + HighlightPostTag = "", + HighlightPreTag = "", + QueryType = QueryType.Semantic, + Search = "how do clouds form", + SemanticConfiguration = "my-semantic-config", + SemanticErrorHandling = SemanticErrorMode.Partial, + SemanticMaxWaitInMilliseconds = 780, + Answers = new QueryAnswerType("extractive|count-3"), + Captions = new QueryCaptionType("extractive|highlight-true"), + }; + Response response = client.SearchPost("myindex", searchRequest); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_SearchPost_SearchIndexSearchDocumentsSemanticPost_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + SearchRequest searchRequest = new SearchRequest + { + Count = true, + HighlightPostTag = "", + HighlightPreTag = "", + QueryType = QueryType.Semantic, + Search = "how do clouds form", + SemanticConfiguration = "my-semantic-config", + SemanticErrorHandling = SemanticErrorMode.Partial, + SemanticMaxWaitInMilliseconds = 780, + Answers = new QueryAnswerType("extractive|count-3"), + Captions = new QueryCaptionType("extractive|highlight-true"), + }; + Response response = await client.SearchPostAsync("myindex", searchRequest); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_GetDocument_SearchIndexGetDocument() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = client.GetDocument("preview-test", "1", new string[] { "id", "description", "name", "category", "ownerId" }, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_GetDocument_SearchIndexGetDocument_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = await client.GetDocumentAsync("preview-test", "1", new string[] { "id", "description", "name", "category", "ownerId" }, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_GetDocument_SearchIndexGetDocument_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = client.GetDocument("preview-test", "1"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_GetDocument_SearchIndexGetDocument_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = await client.GetDocumentAsync("preview-test", "1"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_SuggestGet_SearchIndexSuggestDocumentsGet() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = client.SuggestGet("myindex", "hote", "sg", "rating gt 10", false, "", "", 80, new string[] { "search.score() desc", "rating desc" }, new string[] { "title" }, new string[] { "docId", "title", "description" }, 10, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.text").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_SuggestGet_SearchIndexSuggestDocumentsGet_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = await client.SuggestGetAsync("myindex", "hote", "sg", "rating gt 10", false, "", "", 80, new string[] { "search.score() desc", "rating desc" }, new string[] { "title" }, new string[] { "docId", "title", "description" }, 10, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.text").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_SuggestGet_SearchIndexSuggestDocumentsGet_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = client.SuggestGet("myindex", "hote", "sg"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_SuggestGet_SearchIndexSuggestDocumentsGet_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = await client.SuggestGetAsync("myindex", "hote", "sg"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_SuggestPost_SearchIndexSuggestDocumentsPost() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + using RequestContent content = RequestContent.Create(new + { + filter = "ownerId eq 'sam' and id lt '15'", + fuzzy = true, + highlightPostTag = "", + highlightPreTag = "", + minimumCoverage = 80, + orderby = "id desc", + search = "p", + searchFields = "category", + select = "id,name,category,ownerId", + suggesterName = "sg", + top = 10, + }); + Response response = client.SuggestPost("preview-test", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.text").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_SuggestPost_SearchIndexSuggestDocumentsPost_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + using RequestContent content = RequestContent.Create(new + { + filter = "ownerId eq 'sam' and id lt '15'", + fuzzy = true, + highlightPostTag = "", + highlightPreTag = "", + minimumCoverage = 80, + orderby = "id desc", + search = "p", + searchFields = "category", + select = "id,name,category,ownerId", + suggesterName = "sg", + top = 10, + }); + Response response = await client.SuggestPostAsync("preview-test", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("@search.text").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_SuggestPost_SearchIndexSuggestDocumentsPost_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + SuggestRequest suggestRequest = new SuggestRequest("p", "sg") + { + Filter = "ownerId eq 'sam' and id lt '15'", + Fuzzy = true, + HighlightPostTag = "", + HighlightPreTag = "", + MinimumCoverage = 80, + Orderby = "id desc", + SearchFields = "category", + Select = "id,name,category,ownerId", + Top = 10, + }; + Response response = client.SuggestPost("preview-test", suggestRequest); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_SuggestPost_SearchIndexSuggestDocumentsPost_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + SuggestRequest suggestRequest = new SuggestRequest("p", "sg") + { + Filter = "ownerId eq 'sam' and id lt '15'", + Fuzzy = true, + HighlightPostTag = "", + HighlightPreTag = "", + MinimumCoverage = 80, + Orderby = "id desc", + SearchFields = "category", + Select = "id,name,category,ownerId", + Top = 10, + }; + Response response = await client.SuggestPostAsync("preview-test", suggestRequest); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_Index_SearchIndexIndexDocuments() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + using RequestContent content = RequestContent.Create(new + { + value = new object[] + { +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +} + }, + }); + Response response = client.Index("preview-test", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("key").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("statusCode").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_Index_SearchIndexIndexDocuments_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + using RequestContent content = RequestContent.Create(new + { + value = new object[] + { +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +}, +new Dictionary +{ +["@search.action"] = "mergeOrUpload" +} + }, + }); + Response response = await client.IndexAsync("preview-test", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("key").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("status").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("statusCode").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_Index_SearchIndexIndexDocuments_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + IndexBatch batch = new IndexBatch(new IndexAction[] + { +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +} + }); + Response response = client.Index("preview-test", batch); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_Index_SearchIndexIndexDocuments_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + IndexBatch batch = new IndexBatch(new IndexAction[] + { +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +}, +new IndexAction +{ +ActionType = IndexActionType.MergeOrUpload, +} + }); + Response response = await client.IndexAsync("preview-test", batch); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_AutocompleteGet_SearchIndexAutocompleteDocumentsGet() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = client.AutocompleteGet("myindex", "washington medic", "sg", "oneTerm", null, false, "", "", 80, new string[] { "title", "description" }, null, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("text").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("queryPlusText").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_AutocompleteGet_SearchIndexAutocompleteDocumentsGet_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = await client.AutocompleteGetAsync("myindex", "washington medic", "sg", "oneTerm", null, false, "", "", 80, new string[] { "title", "description" }, null, null); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("text").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("queryPlusText").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_AutocompleteGet_SearchIndexAutocompleteDocumentsGet_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = client.AutocompleteGet("myindex", "washington medic", "sg"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_AutocompleteGet_SearchIndexAutocompleteDocumentsGet_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + Response response = await client.AutocompleteGetAsync("myindex", "washington medic", "sg"); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_AutocompletePost_SearchIndexAutocompleteDocumentsPost() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + using RequestContent content = RequestContent.Create(new + { + search = "p", + autocompleteMode = "oneTerm", + filter = "ownerId ne '1'", + fuzzy = true, + highlightPostTag = "", + highlightPreTag = "", + minimumCoverage = 80, + searchFields = "category, ownerId", + suggesterName = "sg", + top = 10, + }); + Response response = client.AutocompletePost("preview-test", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("text").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("queryPlusText").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_AutocompletePost_SearchIndexAutocompleteDocumentsPost_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + using RequestContent content = RequestContent.Create(new + { + search = "p", + autocompleteMode = "oneTerm", + filter = "ownerId ne '1'", + fuzzy = true, + highlightPostTag = "", + highlightPreTag = "", + minimumCoverage = 80, + searchFields = "category, ownerId", + suggesterName = "sg", + top = 10, + }); + Response response = await client.AutocompletePostAsync("preview-test", content); + + JsonElement result = JsonDocument.Parse(response.ContentStream).RootElement; + Console.WriteLine(result.GetProperty("value")[0].GetProperty("text").ToString()); + Console.WriteLine(result.GetProperty("value")[0].GetProperty("queryPlusText").ToString()); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_Documents_AutocompletePost_SearchIndexAutocompleteDocumentsPost_Convenience() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + AutocompleteRequest autocompleteRequest = new AutocompleteRequest("p", "sg") + { + AutocompleteMode = AutocompleteMode.OneTerm, + Filter = "ownerId ne '1'", + Fuzzy = true, + HighlightPostTag = "", + HighlightPreTag = "", + MinimumCoverage = 80, + SearchFields = "category, ownerId", + Top = 10, + }; + Response response = client.AutocompletePost("preview-test", autocompleteRequest); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_Documents_AutocompletePost_SearchIndexAutocompleteDocumentsPost_Convenience_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + Documents client = new SearchClient(endpoint, credential).GetDocumentsClient(apiVersion: "2025-03-01-preview"); + + AutocompleteRequest autocompleteRequest = new AutocompleteRequest("p", "sg") + { + AutocompleteMode = AutocompleteMode.OneTerm, + Filter = "ownerId ne '1'", + Fuzzy = true, + HighlightPostTag = "", + HighlightPreTag = "", + MinimumCoverage = 80, + SearchFields = "category, ownerId", + Top = 10, + }; + Response response = await client.AutocompletePostAsync("preview-test", autocompleteRequest); + } + } +} diff --git a/sdk/search/Azure.Search.Documents.Search/tsp-location.yaml b/sdk/search/Azure.Search.Documents.Search/tsp-location.yaml new file mode 100644 index 000000000000..b83c22e909d6 --- /dev/null +++ b/sdk/search/Azure.Search.Documents.Search/tsp-location.yaml @@ -0,0 +1,5 @@ +directory: specification/search/Azure.Search.Index +commit: 5b1fbde971f33fb4fbfb01b5390526d7eda053d9 +repo: Azure/azure-rest-api-specs +additionalDirectories: +- specification/search/Azure.Search diff --git a/sdk/search/Azure.Search.Documents/Configuration.json b/sdk/search/Azure.Search.Documents/Configuration.json new file mode 100644 index 000000000000..e1acfd58f3cd --- /dev/null +++ b/sdk/search/Azure.Search.Documents/Configuration.json @@ -0,0 +1,12 @@ +{ + "output-folder": ".", + "namespace": "Azure.Search.Documents", + "library-name": "Azure.Search.Documents", + "flavor": "azure", + "use-model-reader-writer": true, + "shared-source-folders": [ + "../../TempTypeSpecFiles/node_modules/@autorest/csharp/Generator.Shared", + "../../TempTypeSpecFiles/node_modules/@autorest/csharp/Azure.Core.Shared" + ], + "model-namespace": false +} diff --git a/sdk/search/Azure.Search.Documents/src/autorest.md b/sdk/search/Azure.Search.Documents/src/autorest.md deleted file mode 100644 index 689c9034ba14..000000000000 --- a/sdk/search/Azure.Search.Documents/src/autorest.md +++ /dev/null @@ -1,551 +0,0 @@ -# Azure.Search.Documents Code Generation - -Run `dotnet build /t:GenerateCode` in the `src` directory to generate SDK code. - -See the [Contributing guidelines](https://github.com/Azure/azure-sdk-for-net/blob/fe0bf0e7e84a406ec2102c194ea05ccd5011a141/sdk/search/CONTRIBUTING.md) for more details. - -## AutoRest Configuration -> see https://aka.ms/autorest - -## Swagger Source(s) -```yaml -title: SearchServiceClient -input-file: - - https://github.com/Azure/azure-rest-api-specs/blob/8c53aa7023e66a9ec24ede6a9fad0ed730d62515/specification/search/data-plane/Azure.Search/preview/2025-03-01-preview/searchindex.json - - https://github.com/Azure/azure-rest-api-specs/blob/8c53aa7023e66a9ec24ede6a9fad0ed730d62515/specification/search/data-plane/Azure.Search/preview/2025-03-01-preview/searchservice.json -generation1-convenience-client: true -deserialize-null-collection-as-null-value: true -``` - -## Release hacks -We only want certain client methods for our search query client. -``` yaml -directive: -- remove-operation: Documents_AutocompleteGet -- remove-operation: Documents_SearchGet -- remove-operation: Documents_SuggestGet -``` - -### Suppress Abstract Base Class - -``` yaml -suppress-abstract-base-class: -- CharFilter -- CognitiveServicesAccount -- DataChangeDetectionPolicy -- DataDeletionDetectionPolicy -- LexicalAnalyzer -- LexicalNormalizer -- LexicalTokenizer -- ScoringFunction -- SearchIndexerDataIdentity -- SearchIndexerSkill -- Similarity -- TokenFilter -``` - - -## CodeGen hacks -These should eventually be fixed in the code generator. - -## Swagger hacks -These should eventually be fixed in the swagger files. -``` yaml -directive: - from: swagger-document - where: $.definitions.LexicalNormalizer - transform: > - $["discriminator"] = "@odata.type"; -``` - -## Renaming models after the AI Studio rebrand to AI Foundry -These should eventually be fixed in the swagger files. -```yaml -directive: -- from: "searchservice.json" - where: $.definitions.AIStudioModelCatalogName - transform: $["x-ms-enum"].name = "AIFoundryModelCatalogName"; -``` - -### Mark definitions as objects -The modeler warns about models without an explicit type. -``` yaml -directive: -- from: swagger-document - where: $.definitions.* - transform: > - if (typeof $.type === "undefined") { - $.type = "object"; - } -``` - -### Make Lookup Document behave a little friendlier -It's currently an empty object and adding Additional Properties will generate -a more useful model. -``` yaml -directive: -- from: swagger-document - where: $.paths["/docs('{key}')"].get.responses["200"].schema - transform: > - $.additionalProperties = true; -``` - -### Fix `SearchResult["@search.documentDebugInfo"]` -``` yaml -directive: - - from: searchindex.json - where: $.definitions.SearchResult.properties - transform: > - $["@search.documentDebugInfo"]["$ref"] = $["@search.documentDebugInfo"].items["$ref"]; - delete $["@search.documentDebugInfo"].type; - delete $["@search.documentDebugInfo"].items; -``` - -### Archboard feedback for 11.6.0 - -```yaml -directive: -- from: "searchservice.json" - where: $.definitions - transform: > - $.AzureOpenAIParameters["x-ms-client-name"] = "AzureOpenAIVectorizerParameters"; - $.AzureOpenAIParameters.properties.authIdentity["x-ms-client-name"] = "AuthenticationIdentity"; - $.AzureOpenAIParameters.properties.resourceUri["x-ms-client-name"] = "resourceUri"; - - $.VectorSearchVectorizer.properties.name["x-ms-client-name"] = "VectorizerName"; - $.AzureOpenAIVectorizer.properties.azureOpenAIParameters["x-ms-client-name"] = "Parameters"; - - $.ScalarQuantizationVectorSearchCompressionConfiguration["x-ms-client-name"] = "ScalarQuantizationCompression"; - $.BinaryQuantizationVectorSearchCompressionConfiguration["x-ms-client-name"] = "BinaryQuantizationCompression"; - $.VectorSearchCompressionConfiguration["x-ms-client-name"] = "VectorSearchCompression"; - $.VectorSearchCompressionConfiguration.properties.name["x-ms-client-name"] = "CompressionName"; - $.VectorSearchProfile.properties.compression["x-ms-client-name"] = "CompressionName"; - - $.OcrSkillLineEnding["x-ms-client-name"] = "OcrLineEnding"; - $.OcrSkillLineEnding["x-ms-enum"].name = "OcrLineEnding"; - - $.SearchIndexerDataUserAssignedIdentity.properties.userAssignedIdentity["x-ms-format"] = "arm-id"; - $.SearchIndexerIndexProjections["x-ms-client-name"] = "SearchIndexerIndexProjection"; - $.SearchIndexerSkillset.properties.indexProjections["x-ms-client-name"] = "indexProjection"; - - $.VectorSearchCompressionTargetDataType["x-ms-client-name"] = "VectorSearchCompressionTarget"; - $.VectorSearchCompressionTargetDataType["x-ms-enum"].name = "VectorSearchCompressionTarget"; - - $.WebApiVectorizer.properties.customWebApiParameters["x-ms-client-name"] = "Parameters"; - $.WebApiParameters["x-ms-client-name"] = "WebApiVectorizerParameters"; - $.WebApiParameters.properties.uri["x-ms-client-name"] = "uri"; -``` - -### Change VectorizableImageUrlQuery.Url type to Uri - -```yaml -directive: - from: swagger-document - where: $.definitions.VectorizableImageUrlQuery.properties.url - transform: $.format = "url" -``` - -### Set `hybridSearch` property to be type `HybridSearch` in SearchRequest - -``` yaml -directive: - - from: searchindex.json - where: $.definitions.SearchRequest.properties - transform: > - delete $.hybridSearch["type"]; - delete $.hybridSearch.items; - $.hybridSearch["$ref"] = "#/definitions/HybridSearch"; -``` - -### Enable `RawVectorQuery.vector` as embedding field - -```yaml -directive: -- from: searchindex.json - where: $.definitions.RawVectorQuery.properties.vector - transform: $["x-ms-embedding-vector"] = true; -``` - -### Make `VectorSearchAlgorithmKind` internal - -```yaml -directive: -- from: searchservice.json - where: $.definitions.VectorSearchAlgorithmKind - transform: $["x-accessibility"] = "internal" -``` - -### Make `VectorSearchCompressionKind` internal - -```yaml -directive: -- from: searchservice.json - where: $.definitions.VectorSearchCompressionKind - transform: $["x-accessibility"] = "internal" -``` - -### Make `VectorSearchCompressionKind` internal - -```yaml -directive: -- from: searchservice.json - where: $.definitions.VectorSearchCompressionKind - transform: $["x-accessibility"] = "internal" -``` - -### Make `VectorQueryKind` internal - -```yaml -directive: -- from: searchindex.json - where: $.definitions.VectorQueryKind - transform: $["x-accessibility"] = "internal" -``` - -### Make `VectorSearchVectorizerKind` internal - -```yaml -directive: -- from: searchservice.json - where: $.definitions.VectorSearchVectorizerKind - transform: $["x-accessibility"] = "internal" -``` - -### Make `VectorThresholdKind` internal - -```yaml -directive: -- from: searchindex.json - where: $.definitions.VectorThresholdKind - transform: $["x-accessibility"] = "internal" -``` - -### Rename `RawVectorQuery` to `VectorizedQuery` - -```yaml -directive: -- from: searchindex.json - where: $.definitions.RawVectorQuery - transform: $["x-ms-client-name"] = "VectorizedQuery"; -``` - -### Rename `AMLVectorizer` to `AzureMachineLearningVectorizer` - -```yaml -directive: -- from: searchservice.json - where: $.definitions.AMLVectorizer - transform: $["x-ms-client-name"] = "AzureMachineLearningVectorizer"; -``` - -### Rename `AMLParameters` to `AzureMachineLearningParameters` - -```yaml -directive: -- from: searchservice.json - where: $.definitions.AMLParameters - transform: $["x-ms-client-name"] = "AzureMachineLearningParameters"; -``` - -### Rename `ServiceLimits.maxStoragePerIndex` to `ServiceLimits.maxStoragePerIndexInBytes` - -```yaml -directive: -- from: searchservice.json - where: $.definitions.ServiceLimits - transform: $.properties.maxStoragePerIndex["x-ms-client-name"] = "maxStoragePerIndexInBytes"; -``` - -### Rename `PIIDetectionSkill.minimumPrecision` to `PIIDetectionSkill.MinPrecision` - -```yaml -directive: - - from: searchservice.json - where: $.definitions.PIIDetectionSkill - transform: $.properties.minimumPrecision["x-ms-client-name"] = "MinPrecision"; -``` - -### Rename `VectorQuery` property `K` - - Rename `VectorQuery` property `K` to `KNearestNeighborsCount` - -```yaml -directive: -- from: searchindex.json - where: $.definitions.VectorQuery.properties.k - transform: $["x-ms-client-name"] = "KNearestNeighborsCount"; -``` - -### Rename one of SearchMode definitions - -SearchMode is duplicated across swaggers. Rename one of them, even though it will be internalized. -This prevents the serializer from attempting to use undefined values until [Azure/autorest.csharp#583](https://github.com/Azure/autorest.csharp/issues/583) is fixed. - -```yaml -directive: -- from: searchservice.json - where: $.definitions.Suggester.properties.searchMode - transform: $["x-ms-enum"].name = "SuggesterMode"; -``` - -### Add nullable annotations - -``` yaml -directive: - from: swagger-document - where: $.definitions.SynonymMap - transform: > - $.properties.encryptionKey["x-nullable"] = true; -``` - -``` yaml -directive: - from: swagger-document - where: $.definitions.SearchField - transform: > - $.properties.indexAnalyzer["x-nullable"] = true; - $.properties.searchAnalyzer["x-nullable"] = true; - $.properties.analyzer["x-nullable"] = true; -``` - -``` yaml -directive: - from: swagger-document - where: $.definitions.ScoringProfile - transform: > - $.properties.text["x-nullable"] = true; - $.properties.functionAggregation["x-nullable"] = true; -``` - -``` yaml -directive: - from: swagger-document - where: $.definitions.SearchIndex - transform: > - $.properties.encryptionKey["x-nullable"] = true; - $.properties.corsOptions["x-nullable"] = true; -``` - -``` yaml -directive: - from: swagger-document - where: $.definitions.BM25Similarity - transform: > - $.properties.k1["x-nullable"] = true; - $.properties.b["x-nullable"] = true; -``` - -``` yaml -directive: - from: swagger-document - where: $.definitions.SearchIndexerDataSource - transform: > - $.properties.dataChangeDetectionPolicy["x-nullable"] = true; -``` - -``` yaml -directive: - from: swagger-document - where: $.definitions.SearchIndexerDataSource - transform: > - $.properties.dataDeletionDetectionPolicy["x-nullable"] = true; -``` - -``` yaml -directive: - from: swagger-document - where: $.definitions.SearchIndexer - transform: > - $.properties.disabled["x-nullable"] = true; - $.properties.schedule["x-nullable"] = true; - $.properties.parameters["x-nullable"] = true; -``` - -``` yaml -directive: - from: swagger-document - where: $.definitions.SearchIndexerStatus - transform: > - $.properties.lastResult["x-nullable"] = true; -``` - -``` yaml -directive: - from: swagger-document - where: $.definitions.TextTranslationSkill - transform: > - $.properties.suggestedFrom["x-nullable"] = true; -``` - -``` yaml -directive: - from: swagger-document - where: $.definitions.IndexingParameters - transform: > - $.properties.batchSize["x-nullable"] = true; - $.properties.maxFailedItems["x-nullable"] = true; - $.properties.maxFailedItemsPerBatch["x-nullable"] = true; -``` - -``` yaml -directive: - from: swagger-document - where: $.definitions.FieldMapping - transform: > - $.properties.mappingFunction["x-nullable"] = true; -``` - -``` yaml -directive: - from: swagger-document - where: $.definitions.IndexerExecutionResult - transform: > - $.properties.endTime["x-nullable"] = true; - $.properties.statusDetail["x-nullable"] = true; -``` - -``` yaml -directive: - from: swagger-document - where: $.definitions.CorsOptions - transform: > - $.properties.maxAgeInSeconds["x-nullable"] = true; -``` - -#### Skills - -``` yaml -directive: -- from: swagger-document - where: $.definitions.EntityRecognitionSkill - transform: > - $.properties.defaultLanguageCode["x-nullable"] = true; - -- from: swagger-document - where: $.definitions.ImageAnalysisSkill - transform: > - $.properties.defaultLanguageCode["x-nullable"] = true; - -- from: swagger-document - where: $.definitions.KeyPhraseExtractionSkill - transform: > - $.properties.defaultLanguageCode["x-nullable"] = true; - -- from: swagger-document - where: $.definitions.OcrSkill - transform: > - $.properties.defaultLanguageCode["x-nullable"] = true; - $.properties.detectOrientation["x-nullable"] = true; - -- from: swagger-document - where: $.definitions.SentimentSkill - transform: > - $.properties.defaultLanguageCode["x-nullable"] = true; - -- from: swagger-document - where: $.definitions.SplitSkill - transform: > - $.properties.defaultLanguageCode["x-nullable"] = true; - -- from: swagger-document - where: $.definitions.TextTranslationSkill - transform: > - $.properties.defaultFromLanguageCode["x-nullable"] = true; - -- from: swagger-document - where: $.definitions.WebApiSkill - transform: > - $.properties.httpHeaders["x-nullable"] = true; - $.properties.timeout["x-nullable"] = true; -``` - -## C# Customizations -Shape the swagger APIs to produce the best C# API possible. We can consider -fixing these in the swagger files if they would benefit other languages. - -### Property name changes -Change the name of some properties so they are properly CamelCased. -``` yaml -modelerfour: - naming: - override: - "@odata.type": ODataType -``` - -### Disable parameter grouping - -AutoRest C# supports parameter grouping now, temporary disabling to reduce the change size. - -``` yaml -modelerfour: - group-parameters: false -``` - -### Set odata.metadata Accept header in operations - -searchindex.json needs odata.metadata=none and searchservice.json needs odata.metadata=minimal in the Accept header. - -```yaml -directive: -- from: swagger-document - where: $.paths - transform: > - for (var path in $) { - for (var opName in $[path]) { - var accept = "application/json; odata.metadata="; - accept += path.startsWith("/docs") ? "none" : "minimal"; - - var op = $[path][opName]; - op.parameters.push({ - name: "Accept", - "in": "header", - required: true, - type: "string", - enum: [ accept ], - "x-ms-enum": { "modelAsString": false }, - "x-ms-parameter-location": "method" - }); - } - } - - return $; -``` - -### Move service models to Azure.Search.Documents.Indexes.Models - -Models in searchservice.json should be moved to Azure.Search.Documents.Indexes.Models. - -```yaml -directive: - from: searchservice.json - where: $.definitions.* - transform: > - $["x-namespace"] = "Azure.Search.Documents.Indexes.Models" -``` - -### Relocate x-ms-client-request-id parameter - -Remove the `x-ms-client-request-id` parameter from all methods and put it on the client. -This will be later removed when https://github.com/Azure/autorest.csharp/issues/782 is resolved. -Several attempts at just removing the parameter have caused downstream issues, so relocating it for now. - -```yaml -directive: - from: swagger-document - where: $.parameters.ClientRequestIdParameter - transform: $["x-ms-parameter-location"] = "client"; -``` - -## Seal single value enums - -Prevents the creation of single-value extensible enum in generated code. The following single-value enum will be generated as string constant. - -```yaml -directive: - from: swagger-document - where: $.parameters.PreferHeaderParameter - transform: > - $["x-ms-enum"] = { - "modelAsString": false - } -``` diff --git a/sdk/search/Azure.Search.Documents/tsp-location.yaml b/sdk/search/Azure.Search.Documents/tsp-location.yaml new file mode 100644 index 000000000000..e1294d3587f9 --- /dev/null +++ b/sdk/search/Azure.Search.Documents/tsp-location.yaml @@ -0,0 +1,4 @@ +directory: specification/search/Azure.Search +commit: 5b1fbde971f33fb4fbfb01b5390526d7eda053d9 +repo: Azure/azure-rest-api-specs +additionalDirectories: diff --git a/sdk/search/Azure.Search.Documents/tspCodeModel.json b/sdk/search/Azure.Search.Documents/tspCodeModel.json new file mode 100644 index 000000000000..867f536aae65 --- /dev/null +++ b/sdk/search/Azure.Search.Documents/tspCodeModel.json @@ -0,0 +1,97443 @@ +{ + "$id": "1", + "name": "Search", + "apiVersions": [ + "2024-07-01", + "2025-03-01-preview" + ], + "enums": [ + { + "$id": "2", + "kind": "enum", + "name": "QueryType", + "crossLanguageDefinitionId": "Search.QueryType", + "valueType": { + "$id": "3", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "4", + "kind": "enumvalue", + "name": "Simple", + "value": "simple", + "valueType": { + "$id": "5", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2" + }, + "doc": "Uses the simple query syntax for searches. Search text is interpreted using a\nsimple query language that allows for symbols such as +, * and \"\". Queries are\nevaluated across all searchable fields by default, unless the searchFields\nparameter is specified.", + "decorators": [] + }, + { + "$id": "6", + "kind": "enumvalue", + "name": "Full", + "value": "full", + "valueType": { + "$id": "7", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2" + }, + "doc": "Uses the full Lucene query syntax for searches. Search text is interpreted\nusing the Lucene query language which allows field-specific and weighted\nsearches, as well as other advanced features.", + "decorators": [] + }, + { + "$id": "8", + "kind": "enumvalue", + "name": "Semantic", + "value": "semantic", + "valueType": { + "$id": "9", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2" + }, + "doc": "Best suited for queries expressed in natural language as opposed to keywords.\nImproves precision of search results by re-ranking the top search results using\na ranking model trained on the Web corpus.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Specifies the syntax of the search query. The default is 'simple'. Use 'full'\nif your query uses the Lucene query syntax and 'semantic' if query syntax is\nnot needed.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "10", + "kind": "enum", + "name": "SearchMode", + "crossLanguageDefinitionId": "Search.SearchMode", + "valueType": { + "$id": "11", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "12", + "kind": "enumvalue", + "name": "Any", + "value": "any", + "valueType": { + "$id": "13", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "10" + }, + "doc": "Any of the search terms must be matched in order to count the document as a\nmatch.", + "decorators": [] + }, + { + "$id": "14", + "kind": "enumvalue", + "name": "All", + "value": "all", + "valueType": { + "$id": "15", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "10" + }, + "doc": "All of the search terms must be matched in order to count the document as a\nmatch.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Specifies whether any or all of the search terms must be matched in order to\ncount the document as a match.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "16", + "kind": "enum", + "name": "ScoringStatistics", + "crossLanguageDefinitionId": "Search.ScoringStatistics", + "valueType": { + "$id": "17", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "18", + "kind": "enumvalue", + "name": "Local", + "value": "local", + "valueType": { + "$id": "19", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "16" + }, + "doc": "The scoring statistics will be calculated locally for lower latency.", + "decorators": [] + }, + { + "$id": "20", + "kind": "enumvalue", + "name": "Global", + "value": "global", + "valueType": { + "$id": "21", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "16" + }, + "doc": "The scoring statistics will be calculated globally for more consistent scoring.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "A value that specifies whether we want to calculate scoring statistics (such as\ndocument frequency) globally for more consistent scoring, or locally, for lower\nlatency. The default is 'local'. Use 'global' to aggregate scoring statistics\nglobally before scoring. Using global scoring statistics can increase latency\nof search queries.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "22", + "kind": "enum", + "name": "SemanticErrorMode", + "crossLanguageDefinitionId": "Search.SemanticErrorMode", + "valueType": { + "$id": "23", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "24", + "kind": "enumvalue", + "name": "Partial", + "value": "partial", + "valueType": { + "$id": "25", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "22" + }, + "doc": "If the semantic processing fails, partial results still return. The definition\nof partial results depends on what semantic step failed and what was the reason\nfor failure.", + "decorators": [] + }, + { + "$id": "26", + "kind": "enumvalue", + "name": "Fail", + "value": "fail", + "valueType": { + "$id": "27", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "22" + }, + "doc": "If there is an exception during the semantic processing step, the query will\nfail and return the appropriate HTTP code depending on the error.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Allows the user to choose whether a semantic call should fail completely, or to\nreturn partial results.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "28", + "kind": "enum", + "name": "QueryAnswerType", + "crossLanguageDefinitionId": "Search.QueryAnswerType", + "valueType": { + "$id": "29", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "30", + "kind": "enumvalue", + "name": "None", + "value": "none", + "valueType": { + "$id": "31", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "28" + }, + "doc": "Do not return answers for the query.", + "decorators": [] + }, + { + "$id": "32", + "kind": "enumvalue", + "name": "Extractive", + "value": "extractive", + "valueType": { + "$id": "33", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "28" + }, + "doc": "Extracts answer candidates from the contents of the documents returned in\nresponse to a query expressed as a question in natural language.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "This parameter is only valid if the query type is `semantic`. If set, the query\nreturns answers extracted from key passages in the highest ranked documents.\nThe number of answers returned can be configured by appending the pipe\ncharacter `|` followed by the `count-` option after the\nanswers parameter value, such as `extractive|count-3`. Default count is 1. The\nconfidence threshold can be configured by appending the pipe character `|`\nfollowed by the `threshold-` option after the answers\nparameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7.\nThe maximum character length of answers can be configured by appending the pipe\ncharacter '|' followed by the 'count-',\nsuch as 'extractive|maxcharlength-600'.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "34", + "kind": "enum", + "name": "QueryCaptionType", + "crossLanguageDefinitionId": "Search.QueryCaptionType", + "valueType": { + "$id": "35", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "36", + "kind": "enumvalue", + "name": "None", + "value": "none", + "valueType": { + "$id": "37", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "34" + }, + "doc": "Do not return captions for the query.", + "decorators": [] + }, + { + "$id": "38", + "kind": "enumvalue", + "name": "Extractive", + "value": "extractive", + "valueType": { + "$id": "39", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "34" + }, + "doc": "Extracts captions from the matching documents that contain passages relevant to\nthe search query.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "This parameter is only valid if the query type is `semantic`. If set, the query\nreturns captions extracted from key passages in the highest ranked documents.\nWhen Captions is set to `extractive`, highlighting is enabled by default, and\ncan be configured by appending the pipe character `|` followed by the\n`highlight-` option, such as `extractive|highlight-true`. Defaults\nto `None`. The maximum character length of captions can be configured by\nappending the pipe character '|' followed by the 'count-', such as 'extractive|maxcharlength-600'.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "40", + "kind": "enum", + "name": "QueryRewritesType", + "crossLanguageDefinitionId": "Search.QueryRewritesType", + "valueType": { + "$id": "41", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "42", + "kind": "enumvalue", + "name": "None", + "value": "none", + "valueType": { + "$id": "43", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "40" + }, + "doc": "Do not generate additional query rewrites for this query.", + "decorators": [] + }, + { + "$id": "44", + "kind": "enumvalue", + "name": "Generative", + "value": "generative", + "valueType": { + "$id": "45", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "40" + }, + "doc": "Generate alternative query terms to increase the recall of a search request.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "This parameter is only valid if the query type is `semantic`. When\nQueryRewrites is set to `generative`, the query terms are sent to a generate\nmodel which will produce 10 (default) rewrites to help increase the recall of\nthe request. The requested count can be configured by appending the pipe\ncharacter `|` followed by the `count-` option, such as\n`generative|count-3`. Defaults to `None`.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "46", + "kind": "enum", + "name": "QueryDebugMode", + "crossLanguageDefinitionId": "Search.QueryDebugMode", + "valueType": { + "$id": "47", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "48", + "kind": "enumvalue", + "name": "Disabled", + "value": "disabled", + "valueType": { + "$id": "49", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "46" + }, + "doc": "No query debugging information will be returned.", + "decorators": [] + }, + { + "$id": "50", + "kind": "enumvalue", + "name": "Semantic", + "value": "semantic", + "valueType": { + "$id": "51", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "46" + }, + "doc": "Allows the user to further explore their reranked results.", + "decorators": [] + }, + { + "$id": "52", + "kind": "enumvalue", + "name": "Vector", + "value": "vector", + "valueType": { + "$id": "53", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "46" + }, + "doc": "Allows the user to further explore their hybrid and vector query results.", + "decorators": [] + }, + { + "$id": "54", + "kind": "enumvalue", + "name": "QueryRewrites", + "value": "queryRewrites", + "valueType": { + "$id": "55", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "46" + }, + "doc": "Allows the user to explore the list of query rewrites generated for their\nsearch request.", + "decorators": [] + }, + { + "$id": "56", + "kind": "enumvalue", + "name": "All", + "value": "all", + "valueType": { + "$id": "57", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "46" + }, + "doc": "Turn on all debug options.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Enables a debugging tool that can be used to further explore your search\nresults. You can enable multiple debug modes simultaneously by separating them\nwith a | character, for example: semantic|queryRewrites.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "58", + "kind": "enum", + "name": "QueryLanguage", + "crossLanguageDefinitionId": "Search.QueryLanguage", + "valueType": { + "$id": "59", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "60", + "kind": "enumvalue", + "name": "None", + "value": "none", + "valueType": { + "$id": "61", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language not specified.", + "decorators": [] + }, + { + "$id": "62", + "kind": "enumvalue", + "name": "EnUs", + "value": "en-us", + "valueType": { + "$id": "63", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for English (United States).", + "decorators": [] + }, + { + "$id": "64", + "kind": "enumvalue", + "name": "EnGb", + "value": "en-gb", + "valueType": { + "$id": "65", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for English (Great Britain).", + "decorators": [] + }, + { + "$id": "66", + "kind": "enumvalue", + "name": "EnIn", + "value": "en-in", + "valueType": { + "$id": "67", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for English (India).", + "decorators": [] + }, + { + "$id": "68", + "kind": "enumvalue", + "name": "EnCa", + "value": "en-ca", + "valueType": { + "$id": "69", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for English (Canada).", + "decorators": [] + }, + { + "$id": "70", + "kind": "enumvalue", + "name": "EnAu", + "value": "en-au", + "valueType": { + "$id": "71", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for English (Australia).", + "decorators": [] + }, + { + "$id": "72", + "kind": "enumvalue", + "name": "FrFr", + "value": "fr-fr", + "valueType": { + "$id": "73", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for French (France).", + "decorators": [] + }, + { + "$id": "74", + "kind": "enumvalue", + "name": "FrCa", + "value": "fr-ca", + "valueType": { + "$id": "75", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for French (Canada).", + "decorators": [] + }, + { + "$id": "76", + "kind": "enumvalue", + "name": "DeDe", + "value": "de-de", + "valueType": { + "$id": "77", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for German (Germany).", + "decorators": [] + }, + { + "$id": "78", + "kind": "enumvalue", + "name": "EsEs", + "value": "es-es", + "valueType": { + "$id": "79", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Spanish (Spain).", + "decorators": [] + }, + { + "$id": "80", + "kind": "enumvalue", + "name": "EsMx", + "value": "es-mx", + "valueType": { + "$id": "81", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Spanish (Mexico).", + "decorators": [] + }, + { + "$id": "82", + "kind": "enumvalue", + "name": "ZhCn", + "value": "zh-cn", + "valueType": { + "$id": "83", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Chinese (China).", + "decorators": [] + }, + { + "$id": "84", + "kind": "enumvalue", + "name": "ZhTw", + "value": "zh-tw", + "valueType": { + "$id": "85", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Chinese (Taiwan).", + "decorators": [] + }, + { + "$id": "86", + "kind": "enumvalue", + "name": "PtBr", + "value": "pt-br", + "valueType": { + "$id": "87", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Portuguese (Brazil).", + "decorators": [] + }, + { + "$id": "88", + "kind": "enumvalue", + "name": "PtPt", + "value": "pt-pt", + "valueType": { + "$id": "89", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Portuguese (Portugal).", + "decorators": [] + }, + { + "$id": "90", + "kind": "enumvalue", + "name": "ItIt", + "value": "it-it", + "valueType": { + "$id": "91", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Italian (Italy).", + "decorators": [] + }, + { + "$id": "92", + "kind": "enumvalue", + "name": "JaJp", + "value": "ja-jp", + "valueType": { + "$id": "93", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Japanese (Japan).", + "decorators": [] + }, + { + "$id": "94", + "kind": "enumvalue", + "name": "KoKr", + "value": "ko-kr", + "valueType": { + "$id": "95", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Korean (Korea).", + "decorators": [] + }, + { + "$id": "96", + "kind": "enumvalue", + "name": "RuRu", + "value": "ru-ru", + "valueType": { + "$id": "97", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Russian (Russia).", + "decorators": [] + }, + { + "$id": "98", + "kind": "enumvalue", + "name": "CsCz", + "value": "cs-cz", + "valueType": { + "$id": "99", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Czech (Czech Republic).", + "decorators": [] + }, + { + "$id": "100", + "kind": "enumvalue", + "name": "NlBe", + "value": "nl-be", + "valueType": { + "$id": "101", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Dutch (Belgium).", + "decorators": [] + }, + { + "$id": "102", + "kind": "enumvalue", + "name": "NlNl", + "value": "nl-nl", + "valueType": { + "$id": "103", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Dutch (Netherlands).", + "decorators": [] + }, + { + "$id": "104", + "kind": "enumvalue", + "name": "HuHu", + "value": "hu-hu", + "valueType": { + "$id": "105", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Hungarian (Hungary).", + "decorators": [] + }, + { + "$id": "106", + "kind": "enumvalue", + "name": "PlPl", + "value": "pl-pl", + "valueType": { + "$id": "107", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Polish (Poland).", + "decorators": [] + }, + { + "$id": "108", + "kind": "enumvalue", + "name": "SvSe", + "value": "sv-se", + "valueType": { + "$id": "109", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Swedish (Sweden).", + "decorators": [] + }, + { + "$id": "110", + "kind": "enumvalue", + "name": "TrTr", + "value": "tr-tr", + "valueType": { + "$id": "111", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Turkish (Turkey).", + "decorators": [] + }, + { + "$id": "112", + "kind": "enumvalue", + "name": "HiIn", + "value": "hi-in", + "valueType": { + "$id": "113", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Hindi (India).", + "decorators": [] + }, + { + "$id": "114", + "kind": "enumvalue", + "name": "ArSa", + "value": "ar-sa", + "valueType": { + "$id": "115", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Arabic (Saudi Arabia).", + "decorators": [] + }, + { + "$id": "116", + "kind": "enumvalue", + "name": "ArEg", + "value": "ar-eg", + "valueType": { + "$id": "117", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Arabic (Egypt).", + "decorators": [] + }, + { + "$id": "118", + "kind": "enumvalue", + "name": "ArMa", + "value": "ar-ma", + "valueType": { + "$id": "119", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Arabic (Morocco).", + "decorators": [] + }, + { + "$id": "120", + "kind": "enumvalue", + "name": "ArKw", + "value": "ar-kw", + "valueType": { + "$id": "121", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Arabic (Kuwait).", + "decorators": [] + }, + { + "$id": "122", + "kind": "enumvalue", + "name": "ArJo", + "value": "ar-jo", + "valueType": { + "$id": "123", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Arabic (Jordan).", + "decorators": [] + }, + { + "$id": "124", + "kind": "enumvalue", + "name": "DaDk", + "value": "da-dk", + "valueType": { + "$id": "125", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Danish (Denmark).", + "decorators": [] + }, + { + "$id": "126", + "kind": "enumvalue", + "name": "NoNo", + "value": "no-no", + "valueType": { + "$id": "127", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Norwegian (Norway).", + "decorators": [] + }, + { + "$id": "128", + "kind": "enumvalue", + "name": "BgBg", + "value": "bg-bg", + "valueType": { + "$id": "129", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Bulgarian (Bulgaria).", + "decorators": [] + }, + { + "$id": "130", + "kind": "enumvalue", + "name": "HrHr", + "value": "hr-hr", + "valueType": { + "$id": "131", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Croatian (Croatia).", + "decorators": [] + }, + { + "$id": "132", + "kind": "enumvalue", + "name": "HrBa", + "value": "hr-ba", + "valueType": { + "$id": "133", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Croatian (Bosnia and Herzegovina).", + "decorators": [] + }, + { + "$id": "134", + "kind": "enumvalue", + "name": "MsMy", + "value": "ms-my", + "valueType": { + "$id": "135", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Malay (Malaysia).", + "decorators": [] + }, + { + "$id": "136", + "kind": "enumvalue", + "name": "MsBn", + "value": "ms-bn", + "valueType": { + "$id": "137", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Malay (Brunei Darussalam).", + "decorators": [] + }, + { + "$id": "138", + "kind": "enumvalue", + "name": "SlSl", + "value": "sl-sl", + "valueType": { + "$id": "139", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Slovenian (Slovenia).", + "decorators": [] + }, + { + "$id": "140", + "kind": "enumvalue", + "name": "TaIn", + "value": "ta-in", + "valueType": { + "$id": "141", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Tamil (India).", + "decorators": [] + }, + { + "$id": "142", + "kind": "enumvalue", + "name": "ViVn", + "value": "vi-vn", + "valueType": { + "$id": "143", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Vietnamese (Viet Nam).", + "decorators": [] + }, + { + "$id": "144", + "kind": "enumvalue", + "name": "ElGr", + "value": "el-gr", + "valueType": { + "$id": "145", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Greek (Greece).", + "decorators": [] + }, + { + "$id": "146", + "kind": "enumvalue", + "name": "RoRo", + "value": "ro-ro", + "valueType": { + "$id": "147", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Romanian (Romania).", + "decorators": [] + }, + { + "$id": "148", + "kind": "enumvalue", + "name": "IsIs", + "value": "is-is", + "valueType": { + "$id": "149", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Icelandic (Iceland).", + "decorators": [] + }, + { + "$id": "150", + "kind": "enumvalue", + "name": "IdId", + "value": "id-id", + "valueType": { + "$id": "151", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Indonesian (Indonesia).", + "decorators": [] + }, + { + "$id": "152", + "kind": "enumvalue", + "name": "ThTh", + "value": "th-th", + "valueType": { + "$id": "153", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Thai (Thailand).", + "decorators": [] + }, + { + "$id": "154", + "kind": "enumvalue", + "name": "LtLt", + "value": "lt-lt", + "valueType": { + "$id": "155", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Lithuanian (Lithuania).", + "decorators": [] + }, + { + "$id": "156", + "kind": "enumvalue", + "name": "UkUa", + "value": "uk-ua", + "valueType": { + "$id": "157", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Ukrainian (Ukraine).", + "decorators": [] + }, + { + "$id": "158", + "kind": "enumvalue", + "name": "LvLv", + "value": "lv-lv", + "valueType": { + "$id": "159", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Latvian (Latvia).", + "decorators": [] + }, + { + "$id": "160", + "kind": "enumvalue", + "name": "EtEe", + "value": "et-ee", + "valueType": { + "$id": "161", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Estonian (Estonia).", + "decorators": [] + }, + { + "$id": "162", + "kind": "enumvalue", + "name": "CaEs", + "value": "ca-es", + "valueType": { + "$id": "163", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Catalan.", + "decorators": [] + }, + { + "$id": "164", + "kind": "enumvalue", + "name": "FiFi", + "value": "fi-fi", + "valueType": { + "$id": "165", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Finnish (Finland).", + "decorators": [] + }, + { + "$id": "166", + "kind": "enumvalue", + "name": "SrBa", + "value": "sr-ba", + "valueType": { + "$id": "167", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Serbian (Bosnia and Herzegovina).", + "decorators": [] + }, + { + "$id": "168", + "kind": "enumvalue", + "name": "SrMe", + "value": "sr-me", + "valueType": { + "$id": "169", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Serbian (Montenegro).", + "decorators": [] + }, + { + "$id": "170", + "kind": "enumvalue", + "name": "SrRs", + "value": "sr-rs", + "valueType": { + "$id": "171", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Serbian (Serbia).", + "decorators": [] + }, + { + "$id": "172", + "kind": "enumvalue", + "name": "SkSk", + "value": "sk-sk", + "valueType": { + "$id": "173", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Slovak (Slovakia).", + "decorators": [] + }, + { + "$id": "174", + "kind": "enumvalue", + "name": "NbNo", + "value": "nb-no", + "valueType": { + "$id": "175", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Norwegian (Norway).", + "decorators": [] + }, + { + "$id": "176", + "kind": "enumvalue", + "name": "HyAm", + "value": "hy-am", + "valueType": { + "$id": "177", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Armenian (Armenia).", + "decorators": [] + }, + { + "$id": "178", + "kind": "enumvalue", + "name": "BnIn", + "value": "bn-in", + "valueType": { + "$id": "179", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Bengali (India).", + "decorators": [] + }, + { + "$id": "180", + "kind": "enumvalue", + "name": "EuEs", + "value": "eu-es", + "valueType": { + "$id": "181", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Basque.", + "decorators": [] + }, + { + "$id": "182", + "kind": "enumvalue", + "name": "GlEs", + "value": "gl-es", + "valueType": { + "$id": "183", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Galician.", + "decorators": [] + }, + { + "$id": "184", + "kind": "enumvalue", + "name": "GuIn", + "value": "gu-in", + "valueType": { + "$id": "185", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Gujarati (India).", + "decorators": [] + }, + { + "$id": "186", + "kind": "enumvalue", + "name": "HeIl", + "value": "he-il", + "valueType": { + "$id": "187", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Hebrew (Israel).", + "decorators": [] + }, + { + "$id": "188", + "kind": "enumvalue", + "name": "GaIe", + "value": "ga-ie", + "valueType": { + "$id": "189", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Irish (Ireland).", + "decorators": [] + }, + { + "$id": "190", + "kind": "enumvalue", + "name": "KnIn", + "value": "kn-in", + "valueType": { + "$id": "191", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Kannada (India).", + "decorators": [] + }, + { + "$id": "192", + "kind": "enumvalue", + "name": "MlIn", + "value": "ml-in", + "valueType": { + "$id": "193", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Malayalam (India).", + "decorators": [] + }, + { + "$id": "194", + "kind": "enumvalue", + "name": "MrIn", + "value": "mr-in", + "valueType": { + "$id": "195", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Marathi (India).", + "decorators": [] + }, + { + "$id": "196", + "kind": "enumvalue", + "name": "FaAe", + "value": "fa-ae", + "valueType": { + "$id": "197", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Persian (U.A.E.).", + "decorators": [] + }, + { + "$id": "198", + "kind": "enumvalue", + "name": "PaIn", + "value": "pa-in", + "valueType": { + "$id": "199", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Punjabi (India).", + "decorators": [] + }, + { + "$id": "200", + "kind": "enumvalue", + "name": "TeIn", + "value": "te-in", + "valueType": { + "$id": "201", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Telugu (India).", + "decorators": [] + }, + { + "$id": "202", + "kind": "enumvalue", + "name": "UrPk", + "value": "ur-pk", + "valueType": { + "$id": "203", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "58" + }, + "doc": "Query language value for Urdu (Pakistan).", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The language of the query.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "204", + "kind": "enum", + "name": "QuerySpellerType", + "crossLanguageDefinitionId": "Search.QuerySpellerType", + "valueType": { + "$id": "205", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "206", + "kind": "enumvalue", + "name": "None", + "value": "none", + "valueType": { + "$id": "207", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "204" + }, + "doc": "Speller not enabled.", + "decorators": [] + }, + { + "$id": "208", + "kind": "enumvalue", + "name": "Lexicon", + "value": "lexicon", + "valueType": { + "$id": "209", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "204" + }, + "doc": "Speller corrects individual query terms using a static lexicon for the language\nspecified by the queryLanguage parameter.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Improve search recall by spell-correcting individual search query terms.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "210", + "kind": "enum", + "name": "VectorThresholdKind", + "crossLanguageDefinitionId": "Search.VectorThresholdKind", + "valueType": { + "$id": "211", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "212", + "kind": "enumvalue", + "name": "VectorSimilarity", + "value": "vectorSimilarity", + "valueType": { + "$id": "213", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "210" + }, + "doc": "The results of the vector query will be filtered based on the vector similarity\nmetric. Note this is the canonical definition of similarity metric, not the 'distance'\nversion. The threshold direction (larger or smaller) will be chosen\nautomatically according to the metric used by the field.", + "decorators": [] + }, + { + "$id": "214", + "kind": "enumvalue", + "name": "SearchScore", + "value": "searchScore", + "valueType": { + "$id": "215", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "210" + }, + "doc": "The results of the vector query will filter based on the '@search.score' value.\nNote this is the @search.score returned as part of the search response. The\nthreshold direction will be chosen for higher @search.score.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The kind of vector query being performed.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "216", + "kind": "enum", + "name": "VectorQueryKind", + "crossLanguageDefinitionId": "Search.VectorQueryKind", + "valueType": { + "$id": "217", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "218", + "kind": "enumvalue", + "name": "Vector", + "value": "vector", + "valueType": { + "$id": "219", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "216" + }, + "doc": "Vector query where a raw vector value is provided.", + "decorators": [] + }, + { + "$id": "220", + "kind": "enumvalue", + "name": "Text", + "value": "text", + "valueType": { + "$id": "221", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "216" + }, + "doc": "Vector query where a text value that needs to be vectorized is provided.", + "decorators": [] + }, + { + "$id": "222", + "kind": "enumvalue", + "name": "ImageUrl", + "value": "imageUrl", + "valueType": { + "$id": "223", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "216" + }, + "doc": "Vector query where an url that represents an image value that needs to be\nvectorized is provided.", + "decorators": [] + }, + { + "$id": "224", + "kind": "enumvalue", + "name": "ImageBinary", + "value": "imageBinary", + "valueType": { + "$id": "225", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "216" + }, + "doc": "Vector query where a base 64 encoded binary of an image that needs to be\nvectorized is provided.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The kind of vector query being performed.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "226", + "kind": "enum", + "name": "VectorFilterMode", + "crossLanguageDefinitionId": "Search.VectorFilterMode", + "valueType": { + "$id": "227", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "228", + "kind": "enumvalue", + "name": "PostFilter", + "value": "postFilter", + "valueType": { + "$id": "229", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "226" + }, + "doc": "The filter will be applied after the candidate set of vector results is\nreturned. Depending on the filter selectivity, this can result in fewer results\nthan requested by the parameter 'k'.", + "decorators": [] + }, + { + "$id": "230", + "kind": "enumvalue", + "name": "PreFilter", + "value": "preFilter", + "valueType": { + "$id": "231", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "226" + }, + "doc": "The filter will be applied before the search query.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Determines whether or not filters are applied before or after the vector search\nis performed.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "232", + "kind": "enum", + "name": "HybridCountAndFacetMode", + "crossLanguageDefinitionId": "Search.HybridCountAndFacetMode", + "valueType": { + "$id": "233", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "234", + "kind": "enumvalue", + "name": "CountRetrievableResults", + "value": "countRetrievableResults", + "valueType": { + "$id": "235", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "232" + }, + "doc": "Only include documents that were matched within the 'maxTextRecallSize'\nretrieval window when computing 'count' and 'facets'.", + "decorators": [] + }, + { + "$id": "236", + "kind": "enumvalue", + "name": "CountAllResults", + "value": "countAllResults", + "valueType": { + "$id": "237", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "232" + }, + "doc": "Include all documents that were matched by the search query when computing 'count'\nand 'facets', regardless of whether or not those documents are within\nthe 'maxTextRecallSize' retrieval window.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Determines whether the count and facets should includes all documents that\nmatched the search query, or only the documents that are retrieved within the 'maxTextRecallSize'\nwindow. The default value is 'countAllResults'.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "238", + "kind": "enum", + "name": "SemanticFieldState", + "crossLanguageDefinitionId": "Search.SemanticFieldState", + "valueType": { + "$id": "239", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "240", + "kind": "enumvalue", + "name": "Used", + "value": "used", + "valueType": { + "$id": "241", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "238" + }, + "doc": "The field was fully used for semantic enrichment.", + "decorators": [] + }, + { + "$id": "242", + "kind": "enumvalue", + "name": "Unused", + "value": "unused", + "valueType": { + "$id": "243", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "238" + }, + "doc": "The field was not used for semantic enrichment.", + "decorators": [] + }, + { + "$id": "244", + "kind": "enumvalue", + "name": "Partial", + "value": "partial", + "valueType": { + "$id": "245", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "238" + }, + "doc": "The field was partially used for semantic enrichment.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The way the field was used for the semantic enrichment process.", + "isFixed": false, + "isFlags": false, + "usage": "Output,Json", + "decorators": [] + }, + { + "$id": "246", + "kind": "enum", + "name": "SemanticErrorReason", + "crossLanguageDefinitionId": "Search.SemanticErrorReason", + "valueType": { + "$id": "247", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "248", + "kind": "enumvalue", + "name": "MaxWaitExceeded", + "value": "maxWaitExceeded", + "valueType": { + "$id": "249", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "246" + }, + "doc": "If `semanticMaxWaitInMilliseconds` was set and the semantic processing duration\nexceeded that value. Only the base results were returned.", + "decorators": [] + }, + { + "$id": "250", + "kind": "enumvalue", + "name": "CapacityOverloaded", + "value": "capacityOverloaded", + "valueType": { + "$id": "251", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "246" + }, + "doc": "The request was throttled. Only the base results were returned.", + "decorators": [] + }, + { + "$id": "252", + "kind": "enumvalue", + "name": "Transient", + "value": "transient", + "valueType": { + "$id": "253", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "246" + }, + "doc": "At least one step of the semantic process failed.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Reason that a partial response was returned for a semantic ranking request.", + "isFixed": false, + "isFlags": false, + "usage": "Output,Json", + "decorators": [] + }, + { + "$id": "254", + "kind": "enum", + "name": "SemanticSearchResultsType", + "crossLanguageDefinitionId": "Search.SemanticSearchResultsType", + "valueType": { + "$id": "255", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "256", + "kind": "enumvalue", + "name": "BaseResults", + "value": "baseResults", + "valueType": { + "$id": "257", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "254" + }, + "doc": "Results without any semantic enrichment or reranking.", + "decorators": [] + }, + { + "$id": "258", + "kind": "enumvalue", + "name": "RerankedResults", + "value": "rerankedResults", + "valueType": { + "$id": "259", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "254" + }, + "doc": "Results have been reranked with the reranker model and will include semantic\ncaptions. They will not include any answers, answers highlights or caption\nhighlights.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Type of partial response that was returned for a semantic ranking request.", + "isFixed": false, + "isFlags": false, + "usage": "Output,Json", + "decorators": [] + }, + { + "$id": "260", + "kind": "enum", + "name": "SemanticQueryRewritesResultType", + "crossLanguageDefinitionId": "Search.SemanticQueryRewritesResultType", + "valueType": { + "$id": "261", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "262", + "kind": "enumvalue", + "name": "OriginalQueryOnly", + "value": "originalQueryOnly", + "valueType": { + "$id": "263", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "260" + }, + "doc": "Query rewrites were not successfully generated for this request. Only the\noriginal query was used to retrieve the results.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Type of query rewrite that was used for this request.", + "isFixed": false, + "isFlags": false, + "usage": "Output,Json", + "decorators": [] + }, + { + "$id": "264", + "kind": "enum", + "name": "IndexActionType", + "crossLanguageDefinitionId": "Search.IndexActionType", + "valueType": { + "$id": "265", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "266", + "kind": "enumvalue", + "name": "Upload", + "value": "upload", + "valueType": { + "$id": "267", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "264" + }, + "doc": "Inserts the document into the index if it is new and updates it if it exists.\nAll fields are replaced in the update case.", + "decorators": [] + }, + { + "$id": "268", + "kind": "enumvalue", + "name": "Merge", + "value": "merge", + "valueType": { + "$id": "269", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "264" + }, + "doc": "Merges the specified field values with an existing document. If the document\ndoes not exist, the merge will fail. Any field you specify in a merge will\nreplace the existing field in the document. This also applies to collections of\nprimitive and complex types.", + "decorators": [] + }, + { + "$id": "270", + "kind": "enumvalue", + "name": "MergeOrUpload", + "value": "mergeOrUpload", + "valueType": { + "$id": "271", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "264" + }, + "doc": "Behaves like merge if a document with the given key already exists in the\nindex. If the document does not exist, it behaves like upload with a new\ndocument.", + "decorators": [] + }, + { + "$id": "272", + "kind": "enumvalue", + "name": "Delete", + "value": "delete", + "valueType": { + "$id": "273", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "264" + }, + "doc": "Removes the specified document from the index. Any field you specify in a\ndelete operation other than the key field will be ignored. If you want to\nremove an individual field from a document, use merge instead and set the field\nexplicitly to null.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The operation to perform on a document in an indexing batch.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Json", + "decorators": [] + }, + { + "$id": "274", + "kind": "enum", + "name": "AutocompleteMode", + "crossLanguageDefinitionId": "Search.AutocompleteMode", + "valueType": { + "$id": "275", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "276", + "kind": "enumvalue", + "name": "OneTerm", + "value": "oneTerm", + "valueType": { + "$id": "277", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "274" + }, + "doc": "Only one term is suggested. If the query has two terms, only the last term is\ncompleted. For example, if the input is 'washington medic', the suggested terms\ncould include 'medicaid', 'medicare', and 'medicine'.", + "decorators": [] + }, + { + "$id": "278", + "kind": "enumvalue", + "name": "TwoTerms", + "value": "twoTerms", + "valueType": { + "$id": "279", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "274" + }, + "doc": "Matching two-term phrases in the index will be suggested. For example, if the\ninput is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'.", + "decorators": [] + }, + { + "$id": "280", + "kind": "enumvalue", + "name": "OneTermWithContext", + "value": "oneTermWithContext", + "valueType": { + "$id": "281", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "274" + }, + "doc": "Completes the last term in a query with two or more terms, where the last two\nterms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms'\nto get shingles and 'oneTermWithContext' to use the current context in\nproducing autocomplete terms.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Json", + "decorators": [] + }, + { + "$id": "282", + "kind": "enum", + "name": "SearchFieldDataType", + "crossLanguageDefinitionId": "Search.SearchFieldDataType", + "valueType": { + "$id": "283", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "284", + "kind": "enumvalue", + "name": "String", + "value": "Edm.String", + "valueType": { + "$id": "285", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "282" + }, + "doc": "Indicates that a field contains a string.", + "decorators": [] + }, + { + "$id": "286", + "kind": "enumvalue", + "name": "Int32", + "value": "Edm.Int32", + "valueType": { + "$id": "287", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "282" + }, + "doc": "Indicates that a field contains a 32-bit signed integer.", + "decorators": [] + }, + { + "$id": "288", + "kind": "enumvalue", + "name": "Int64", + "value": "Edm.Int64", + "valueType": { + "$id": "289", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "282" + }, + "doc": "Indicates that a field contains a 64-bit signed integer.", + "decorators": [] + }, + { + "$id": "290", + "kind": "enumvalue", + "name": "Double", + "value": "Edm.Double", + "valueType": { + "$id": "291", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "282" + }, + "doc": "Indicates that a field contains an IEEE double-precision floating point number.", + "decorators": [] + }, + { + "$id": "292", + "kind": "enumvalue", + "name": "Boolean", + "value": "Edm.Boolean", + "valueType": { + "$id": "293", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "282" + }, + "doc": "Indicates that a field contains a Boolean value (true or false).", + "decorators": [] + }, + { + "$id": "294", + "kind": "enumvalue", + "name": "DateTimeOffset", + "value": "Edm.DateTimeOffset", + "valueType": { + "$id": "295", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "282" + }, + "doc": "Indicates that a field contains a date/time value, including timezone\ninformation.", + "decorators": [] + }, + { + "$id": "296", + "kind": "enumvalue", + "name": "GeographyPoint", + "value": "Edm.GeographyPoint", + "valueType": { + "$id": "297", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "282" + }, + "doc": "Indicates that a field contains a geo-location in terms of longitude and\nlatitude.", + "decorators": [] + }, + { + "$id": "298", + "kind": "enumvalue", + "name": "Complex", + "value": "Edm.ComplexType", + "valueType": { + "$id": "299", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "282" + }, + "doc": "Indicates that a field contains one or more complex objects that in turn have\nsub-fields of other types.", + "decorators": [] + }, + { + "$id": "300", + "kind": "enumvalue", + "name": "Single", + "value": "Edm.Single", + "valueType": { + "$id": "301", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "282" + }, + "doc": "Indicates that a field contains a single-precision floating point number. This\nis only valid when used with Collection(Edm.Single).", + "decorators": [] + }, + { + "$id": "302", + "kind": "enumvalue", + "name": "Half", + "value": "Edm.Half", + "valueType": { + "$id": "303", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "282" + }, + "doc": "Indicates that a field contains a half-precision floating point number. This is\nonly valid when used with Collection(Edm.Half).", + "decorators": [] + }, + { + "$id": "304", + "kind": "enumvalue", + "name": "Int16", + "value": "Edm.Int16", + "valueType": { + "$id": "305", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "282" + }, + "doc": "Indicates that a field contains a 16-bit signed integer. This is only valid\nwhen used with Collection(Edm.Int16).", + "decorators": [] + }, + { + "$id": "306", + "kind": "enumvalue", + "name": "SByte", + "value": "Edm.SByte", + "valueType": { + "$id": "307", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "282" + }, + "doc": "Indicates that a field contains a 8-bit signed integer. This is only valid when\nused with Collection(Edm.SByte).", + "decorators": [] + }, + { + "$id": "308", + "kind": "enumvalue", + "name": "Byte", + "value": "Edm.Byte", + "valueType": { + "$id": "309", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "282" + }, + "doc": "Indicates that a field contains a 8-bit unsigned integer. This is only valid\nwhen used with Collection(Edm.Byte).", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Defines the data type of a field in a search index.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "310", + "kind": "enum", + "name": "LexicalAnalyzerName", + "crossLanguageDefinitionId": "Search.LexicalAnalyzerName", + "valueType": { + "$id": "311", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "312", + "kind": "enumvalue", + "name": "ArMicrosoft", + "value": "ar.microsoft", + "valueType": { + "$id": "313", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Arabic.", + "decorators": [] + }, + { + "$id": "314", + "kind": "enumvalue", + "name": "ArLucene", + "value": "ar.lucene", + "valueType": { + "$id": "315", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Arabic.", + "decorators": [] + }, + { + "$id": "316", + "kind": "enumvalue", + "name": "HyLucene", + "value": "hy.lucene", + "valueType": { + "$id": "317", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Armenian.", + "decorators": [] + }, + { + "$id": "318", + "kind": "enumvalue", + "name": "BnMicrosoft", + "value": "bn.microsoft", + "valueType": { + "$id": "319", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Bangla.", + "decorators": [] + }, + { + "$id": "320", + "kind": "enumvalue", + "name": "EuLucene", + "value": "eu.lucene", + "valueType": { + "$id": "321", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Basque.", + "decorators": [] + }, + { + "$id": "322", + "kind": "enumvalue", + "name": "BgMicrosoft", + "value": "bg.microsoft", + "valueType": { + "$id": "323", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Bulgarian.", + "decorators": [] + }, + { + "$id": "324", + "kind": "enumvalue", + "name": "BgLucene", + "value": "bg.lucene", + "valueType": { + "$id": "325", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Bulgarian.", + "decorators": [] + }, + { + "$id": "326", + "kind": "enumvalue", + "name": "CaMicrosoft", + "value": "ca.microsoft", + "valueType": { + "$id": "327", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Catalan.", + "decorators": [] + }, + { + "$id": "328", + "kind": "enumvalue", + "name": "CaLucene", + "value": "ca.lucene", + "valueType": { + "$id": "329", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Catalan.", + "decorators": [] + }, + { + "$id": "330", + "kind": "enumvalue", + "name": "ZhHansMicrosoft", + "value": "zh-Hans.microsoft", + "valueType": { + "$id": "331", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Chinese (Simplified).", + "decorators": [] + }, + { + "$id": "332", + "kind": "enumvalue", + "name": "ZhHansLucene", + "value": "zh-Hans.lucene", + "valueType": { + "$id": "333", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Chinese (Simplified).", + "decorators": [] + }, + { + "$id": "334", + "kind": "enumvalue", + "name": "ZhHantMicrosoft", + "value": "zh-Hant.microsoft", + "valueType": { + "$id": "335", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Chinese (Traditional).", + "decorators": [] + }, + { + "$id": "336", + "kind": "enumvalue", + "name": "ZhHantLucene", + "value": "zh-Hant.lucene", + "valueType": { + "$id": "337", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Chinese (Traditional).", + "decorators": [] + }, + { + "$id": "338", + "kind": "enumvalue", + "name": "HrMicrosoft", + "value": "hr.microsoft", + "valueType": { + "$id": "339", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Croatian.", + "decorators": [] + }, + { + "$id": "340", + "kind": "enumvalue", + "name": "CsMicrosoft", + "value": "cs.microsoft", + "valueType": { + "$id": "341", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Czech.", + "decorators": [] + }, + { + "$id": "342", + "kind": "enumvalue", + "name": "CsLucene", + "value": "cs.lucene", + "valueType": { + "$id": "343", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Czech.", + "decorators": [] + }, + { + "$id": "344", + "kind": "enumvalue", + "name": "DaMicrosoft", + "value": "da.microsoft", + "valueType": { + "$id": "345", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Danish.", + "decorators": [] + }, + { + "$id": "346", + "kind": "enumvalue", + "name": "DaLucene", + "value": "da.lucene", + "valueType": { + "$id": "347", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Danish.", + "decorators": [] + }, + { + "$id": "348", + "kind": "enumvalue", + "name": "NlMicrosoft", + "value": "nl.microsoft", + "valueType": { + "$id": "349", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Dutch.", + "decorators": [] + }, + { + "$id": "350", + "kind": "enumvalue", + "name": "NlLucene", + "value": "nl.lucene", + "valueType": { + "$id": "351", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Dutch.", + "decorators": [] + }, + { + "$id": "352", + "kind": "enumvalue", + "name": "EnMicrosoft", + "value": "en.microsoft", + "valueType": { + "$id": "353", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for English.", + "decorators": [] + }, + { + "$id": "354", + "kind": "enumvalue", + "name": "EnLucene", + "value": "en.lucene", + "valueType": { + "$id": "355", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for English.", + "decorators": [] + }, + { + "$id": "356", + "kind": "enumvalue", + "name": "EtMicrosoft", + "value": "et.microsoft", + "valueType": { + "$id": "357", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Estonian.", + "decorators": [] + }, + { + "$id": "358", + "kind": "enumvalue", + "name": "FiMicrosoft", + "value": "fi.microsoft", + "valueType": { + "$id": "359", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Finnish.", + "decorators": [] + }, + { + "$id": "360", + "kind": "enumvalue", + "name": "FiLucene", + "value": "fi.lucene", + "valueType": { + "$id": "361", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Finnish.", + "decorators": [] + }, + { + "$id": "362", + "kind": "enumvalue", + "name": "FrMicrosoft", + "value": "fr.microsoft", + "valueType": { + "$id": "363", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for French.", + "decorators": [] + }, + { + "$id": "364", + "kind": "enumvalue", + "name": "FrLucene", + "value": "fr.lucene", + "valueType": { + "$id": "365", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for French.", + "decorators": [] + }, + { + "$id": "366", + "kind": "enumvalue", + "name": "GlLucene", + "value": "gl.lucene", + "valueType": { + "$id": "367", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Galician.", + "decorators": [] + }, + { + "$id": "368", + "kind": "enumvalue", + "name": "DeMicrosoft", + "value": "de.microsoft", + "valueType": { + "$id": "369", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for German.", + "decorators": [] + }, + { + "$id": "370", + "kind": "enumvalue", + "name": "DeLucene", + "value": "de.lucene", + "valueType": { + "$id": "371", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for German.", + "decorators": [] + }, + { + "$id": "372", + "kind": "enumvalue", + "name": "ElMicrosoft", + "value": "el.microsoft", + "valueType": { + "$id": "373", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Greek.", + "decorators": [] + }, + { + "$id": "374", + "kind": "enumvalue", + "name": "ElLucene", + "value": "el.lucene", + "valueType": { + "$id": "375", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Greek.", + "decorators": [] + }, + { + "$id": "376", + "kind": "enumvalue", + "name": "GuMicrosoft", + "value": "gu.microsoft", + "valueType": { + "$id": "377", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Gujarati.", + "decorators": [] + }, + { + "$id": "378", + "kind": "enumvalue", + "name": "HeMicrosoft", + "value": "he.microsoft", + "valueType": { + "$id": "379", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Hebrew.", + "decorators": [] + }, + { + "$id": "380", + "kind": "enumvalue", + "name": "HiMicrosoft", + "value": "hi.microsoft", + "valueType": { + "$id": "381", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Hindi.", + "decorators": [] + }, + { + "$id": "382", + "kind": "enumvalue", + "name": "HiLucene", + "value": "hi.lucene", + "valueType": { + "$id": "383", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Hindi.", + "decorators": [] + }, + { + "$id": "384", + "kind": "enumvalue", + "name": "HuMicrosoft", + "value": "hu.microsoft", + "valueType": { + "$id": "385", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Hungarian.", + "decorators": [] + }, + { + "$id": "386", + "kind": "enumvalue", + "name": "HuLucene", + "value": "hu.lucene", + "valueType": { + "$id": "387", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Hungarian.", + "decorators": [] + }, + { + "$id": "388", + "kind": "enumvalue", + "name": "IsMicrosoft", + "value": "is.microsoft", + "valueType": { + "$id": "389", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Icelandic.", + "decorators": [] + }, + { + "$id": "390", + "kind": "enumvalue", + "name": "IdMicrosoft", + "value": "id.microsoft", + "valueType": { + "$id": "391", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Indonesian (Bahasa).", + "decorators": [] + }, + { + "$id": "392", + "kind": "enumvalue", + "name": "IdLucene", + "value": "id.lucene", + "valueType": { + "$id": "393", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Indonesian.", + "decorators": [] + }, + { + "$id": "394", + "kind": "enumvalue", + "name": "GaLucene", + "value": "ga.lucene", + "valueType": { + "$id": "395", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Irish.", + "decorators": [] + }, + { + "$id": "396", + "kind": "enumvalue", + "name": "ItMicrosoft", + "value": "it.microsoft", + "valueType": { + "$id": "397", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Italian.", + "decorators": [] + }, + { + "$id": "398", + "kind": "enumvalue", + "name": "ItLucene", + "value": "it.lucene", + "valueType": { + "$id": "399", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Italian.", + "decorators": [] + }, + { + "$id": "400", + "kind": "enumvalue", + "name": "JaMicrosoft", + "value": "ja.microsoft", + "valueType": { + "$id": "401", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Japanese.", + "decorators": [] + }, + { + "$id": "402", + "kind": "enumvalue", + "name": "JaLucene", + "value": "ja.lucene", + "valueType": { + "$id": "403", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Japanese.", + "decorators": [] + }, + { + "$id": "404", + "kind": "enumvalue", + "name": "KnMicrosoft", + "value": "kn.microsoft", + "valueType": { + "$id": "405", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Kannada.", + "decorators": [] + }, + { + "$id": "406", + "kind": "enumvalue", + "name": "KoMicrosoft", + "value": "ko.microsoft", + "valueType": { + "$id": "407", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Korean.", + "decorators": [] + }, + { + "$id": "408", + "kind": "enumvalue", + "name": "KoLucene", + "value": "ko.lucene", + "valueType": { + "$id": "409", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Korean.", + "decorators": [] + }, + { + "$id": "410", + "kind": "enumvalue", + "name": "LvMicrosoft", + "value": "lv.microsoft", + "valueType": { + "$id": "411", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Latvian.", + "decorators": [] + }, + { + "$id": "412", + "kind": "enumvalue", + "name": "LvLucene", + "value": "lv.lucene", + "valueType": { + "$id": "413", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Latvian.", + "decorators": [] + }, + { + "$id": "414", + "kind": "enumvalue", + "name": "LtMicrosoft", + "value": "lt.microsoft", + "valueType": { + "$id": "415", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Lithuanian.", + "decorators": [] + }, + { + "$id": "416", + "kind": "enumvalue", + "name": "MlMicrosoft", + "value": "ml.microsoft", + "valueType": { + "$id": "417", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Malayalam.", + "decorators": [] + }, + { + "$id": "418", + "kind": "enumvalue", + "name": "MsMicrosoft", + "value": "ms.microsoft", + "valueType": { + "$id": "419", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Malay (Latin).", + "decorators": [] + }, + { + "$id": "420", + "kind": "enumvalue", + "name": "MrMicrosoft", + "value": "mr.microsoft", + "valueType": { + "$id": "421", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Marathi.", + "decorators": [] + }, + { + "$id": "422", + "kind": "enumvalue", + "name": "NbMicrosoft", + "value": "nb.microsoft", + "valueType": { + "$id": "423", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Norwegian (Bokmål).", + "decorators": [] + }, + { + "$id": "424", + "kind": "enumvalue", + "name": "NoLucene", + "value": "no.lucene", + "valueType": { + "$id": "425", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Norwegian.", + "decorators": [] + }, + { + "$id": "426", + "kind": "enumvalue", + "name": "FaLucene", + "value": "fa.lucene", + "valueType": { + "$id": "427", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Persian.", + "decorators": [] + }, + { + "$id": "428", + "kind": "enumvalue", + "name": "PlMicrosoft", + "value": "pl.microsoft", + "valueType": { + "$id": "429", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Polish.", + "decorators": [] + }, + { + "$id": "430", + "kind": "enumvalue", + "name": "PlLucene", + "value": "pl.lucene", + "valueType": { + "$id": "431", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Polish.", + "decorators": [] + }, + { + "$id": "432", + "kind": "enumvalue", + "name": "PtBrMicrosoft", + "value": "pt-BR.microsoft", + "valueType": { + "$id": "433", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Portuguese (Brazil).", + "decorators": [] + }, + { + "$id": "434", + "kind": "enumvalue", + "name": "PtBrLucene", + "value": "pt-BR.lucene", + "valueType": { + "$id": "435", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Portuguese (Brazil).", + "decorators": [] + }, + { + "$id": "436", + "kind": "enumvalue", + "name": "PtPtMicrosoft", + "value": "pt-PT.microsoft", + "valueType": { + "$id": "437", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Portuguese (Portugal).", + "decorators": [] + }, + { + "$id": "438", + "kind": "enumvalue", + "name": "PtPtLucene", + "value": "pt-PT.lucene", + "valueType": { + "$id": "439", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Portuguese (Portugal).", + "decorators": [] + }, + { + "$id": "440", + "kind": "enumvalue", + "name": "PaMicrosoft", + "value": "pa.microsoft", + "valueType": { + "$id": "441", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Punjabi.", + "decorators": [] + }, + { + "$id": "442", + "kind": "enumvalue", + "name": "RoMicrosoft", + "value": "ro.microsoft", + "valueType": { + "$id": "443", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Romanian.", + "decorators": [] + }, + { + "$id": "444", + "kind": "enumvalue", + "name": "RoLucene", + "value": "ro.lucene", + "valueType": { + "$id": "445", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Romanian.", + "decorators": [] + }, + { + "$id": "446", + "kind": "enumvalue", + "name": "RuMicrosoft", + "value": "ru.microsoft", + "valueType": { + "$id": "447", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Russian.", + "decorators": [] + }, + { + "$id": "448", + "kind": "enumvalue", + "name": "RuLucene", + "value": "ru.lucene", + "valueType": { + "$id": "449", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Russian.", + "decorators": [] + }, + { + "$id": "450", + "kind": "enumvalue", + "name": "SrCyrillicMicrosoft", + "value": "sr-cyrillic.microsoft", + "valueType": { + "$id": "451", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Serbian (Cyrillic).", + "decorators": [] + }, + { + "$id": "452", + "kind": "enumvalue", + "name": "SrLatinMicrosoft", + "value": "sr-latin.microsoft", + "valueType": { + "$id": "453", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Serbian (Latin).", + "decorators": [] + }, + { + "$id": "454", + "kind": "enumvalue", + "name": "SkMicrosoft", + "value": "sk.microsoft", + "valueType": { + "$id": "455", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Slovak.", + "decorators": [] + }, + { + "$id": "456", + "kind": "enumvalue", + "name": "SlMicrosoft", + "value": "sl.microsoft", + "valueType": { + "$id": "457", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Slovenian.", + "decorators": [] + }, + { + "$id": "458", + "kind": "enumvalue", + "name": "EsMicrosoft", + "value": "es.microsoft", + "valueType": { + "$id": "459", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Spanish.", + "decorators": [] + }, + { + "$id": "460", + "kind": "enumvalue", + "name": "EsLucene", + "value": "es.lucene", + "valueType": { + "$id": "461", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Spanish.", + "decorators": [] + }, + { + "$id": "462", + "kind": "enumvalue", + "name": "SvMicrosoft", + "value": "sv.microsoft", + "valueType": { + "$id": "463", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Swedish.", + "decorators": [] + }, + { + "$id": "464", + "kind": "enumvalue", + "name": "SvLucene", + "value": "sv.lucene", + "valueType": { + "$id": "465", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Swedish.", + "decorators": [] + }, + { + "$id": "466", + "kind": "enumvalue", + "name": "TaMicrosoft", + "value": "ta.microsoft", + "valueType": { + "$id": "467", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Tamil.", + "decorators": [] + }, + { + "$id": "468", + "kind": "enumvalue", + "name": "TeMicrosoft", + "value": "te.microsoft", + "valueType": { + "$id": "469", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Telugu.", + "decorators": [] + }, + { + "$id": "470", + "kind": "enumvalue", + "name": "ThMicrosoft", + "value": "th.microsoft", + "valueType": { + "$id": "471", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Thai.", + "decorators": [] + }, + { + "$id": "472", + "kind": "enumvalue", + "name": "ThLucene", + "value": "th.lucene", + "valueType": { + "$id": "473", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Thai.", + "decorators": [] + }, + { + "$id": "474", + "kind": "enumvalue", + "name": "TrMicrosoft", + "value": "tr.microsoft", + "valueType": { + "$id": "475", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Turkish.", + "decorators": [] + }, + { + "$id": "476", + "kind": "enumvalue", + "name": "TrLucene", + "value": "tr.lucene", + "valueType": { + "$id": "477", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Lucene analyzer for Turkish.", + "decorators": [] + }, + { + "$id": "478", + "kind": "enumvalue", + "name": "UkMicrosoft", + "value": "uk.microsoft", + "valueType": { + "$id": "479", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Ukrainian.", + "decorators": [] + }, + { + "$id": "480", + "kind": "enumvalue", + "name": "UrMicrosoft", + "value": "ur.microsoft", + "valueType": { + "$id": "481", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Urdu.", + "decorators": [] + }, + { + "$id": "482", + "kind": "enumvalue", + "name": "ViMicrosoft", + "value": "vi.microsoft", + "valueType": { + "$id": "483", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Microsoft analyzer for Vietnamese.", + "decorators": [] + }, + { + "$id": "484", + "kind": "enumvalue", + "name": "StandardLucene", + "value": "standard.lucene", + "valueType": { + "$id": "485", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Standard Lucene analyzer.", + "decorators": [] + }, + { + "$id": "486", + "kind": "enumvalue", + "name": "StandardAsciiFoldingLucene", + "value": "standardasciifolding.lucene", + "valueType": { + "$id": "487", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Standard ASCII Folding Lucene analyzer. See\nhttps://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers", + "decorators": [] + }, + { + "$id": "488", + "kind": "enumvalue", + "name": "Keyword", + "value": "keyword", + "valueType": { + "$id": "489", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Treats the entire content of a field as a single token. This is useful for data\nlike zip codes, ids, and some product names. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html", + "decorators": [] + }, + { + "$id": "490", + "kind": "enumvalue", + "name": "Pattern", + "value": "pattern", + "valueType": { + "$id": "491", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Flexibly separates text into terms via a regular expression pattern. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html", + "decorators": [] + }, + { + "$id": "492", + "kind": "enumvalue", + "name": "Simple", + "value": "simple", + "valueType": { + "$id": "493", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Divides text at non-letters and converts them to lower case. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html", + "decorators": [] + }, + { + "$id": "494", + "kind": "enumvalue", + "name": "Stop", + "value": "stop", + "valueType": { + "$id": "495", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "Divides text at non-letters; Applies the lowercase and stopword token filters.\nSee\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html", + "decorators": [] + }, + { + "$id": "496", + "kind": "enumvalue", + "name": "Whitespace", + "value": "whitespace", + "valueType": { + "$id": "497", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "310" + }, + "doc": "An analyzer that uses the whitespace tokenizer. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Defines the names of all text analyzers supported by the search engine.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "498", + "kind": "enum", + "name": "LexicalNormalizerName", + "crossLanguageDefinitionId": "Search.LexicalNormalizerName", + "valueType": { + "$id": "499", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "500", + "kind": "enumvalue", + "name": "AsciiFolding", + "value": "asciifolding", + "valueType": { + "$id": "501", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "498" + }, + "doc": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in\nthe first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their\nASCII equivalents, if such equivalents exist. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html", + "decorators": [] + }, + { + "$id": "502", + "kind": "enumvalue", + "name": "Elision", + "value": "elision", + "valueType": { + "$id": "503", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "498" + }, + "doc": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to\n\"avion\" (plane). See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html", + "decorators": [] + }, + { + "$id": "504", + "kind": "enumvalue", + "name": "Lowercase", + "value": "lowercase", + "valueType": { + "$id": "505", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "498" + }, + "doc": "Normalizes token text to lowercase. See\nhttps://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html", + "decorators": [] + }, + { + "$id": "506", + "kind": "enumvalue", + "name": "Standard", + "value": "standard", + "valueType": { + "$id": "507", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "498" + }, + "doc": "Standard normalizer, which consists of lowercase and asciifolding. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html", + "decorators": [] + }, + { + "$id": "508", + "kind": "enumvalue", + "name": "Uppercase", + "value": "uppercase", + "valueType": { + "$id": "509", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "498" + }, + "doc": "Normalizes token text to uppercase. See\nhttps://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Defines the names of all text normalizers supported by the search engine.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "510", + "kind": "enum", + "name": "VectorEncodingFormat", + "crossLanguageDefinitionId": "Search.VectorEncodingFormat", + "valueType": { + "$id": "511", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "512", + "kind": "enumvalue", + "name": "PackedBit", + "value": "packedBit", + "valueType": { + "$id": "513", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "510" + }, + "doc": "Encoding format representing bits packed into a wider data type.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The encoding format for interpreting vector field contents.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "514", + "kind": "enum", + "name": "ScoringFunctionInterpolation", + "crossLanguageDefinitionId": "Search.ScoringFunctionInterpolation", + "valueType": { + "$id": "515", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "516", + "kind": "enumvalue", + "name": "Linear", + "value": "linear", + "valueType": { + "$id": "517", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "514" + }, + "doc": "Boosts scores by a linearly decreasing amount. This is the default\ninterpolation for scoring functions.", + "decorators": [] + }, + { + "$id": "518", + "kind": "enumvalue", + "name": "Constant", + "value": "constant", + "valueType": { + "$id": "519", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "514" + }, + "doc": "Boosts scores by a constant factor.", + "decorators": [] + }, + { + "$id": "520", + "kind": "enumvalue", + "name": "Quadratic", + "value": "quadratic", + "valueType": { + "$id": "521", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "514" + }, + "doc": "Boosts scores by an amount that decreases quadratically. Boosts decrease slowly\nfor higher scores, and more quickly as the scores decrease. This interpolation\noption is not allowed in tag scoring functions.", + "decorators": [] + }, + { + "$id": "522", + "kind": "enumvalue", + "name": "Logarithmic", + "value": "logarithmic", + "valueType": { + "$id": "523", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "514" + }, + "doc": "Boosts scores by an amount that decreases logarithmically. Boosts decrease\nquickly for higher scores, and more slowly as the scores decrease. This\ninterpolation option is not allowed in tag scoring functions.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Defines the function used to interpolate score boosting across a range of\ndocuments.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "524", + "kind": "enum", + "name": "ScoringFunctionAggregation", + "crossLanguageDefinitionId": "Search.ScoringFunctionAggregation", + "valueType": { + "$id": "525", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "526", + "kind": "enumvalue", + "name": "Sum", + "value": "sum", + "valueType": { + "$id": "527", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "524" + }, + "doc": "Boost scores by the sum of all scoring function results.", + "decorators": [] + }, + { + "$id": "528", + "kind": "enumvalue", + "name": "Average", + "value": "average", + "valueType": { + "$id": "529", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "524" + }, + "doc": "Boost scores by the average of all scoring function results.", + "decorators": [] + }, + { + "$id": "530", + "kind": "enumvalue", + "name": "Minimum", + "value": "minimum", + "valueType": { + "$id": "531", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "524" + }, + "doc": "Boost scores by the minimum of all scoring function results.", + "decorators": [] + }, + { + "$id": "532", + "kind": "enumvalue", + "name": "Maximum", + "value": "maximum", + "valueType": { + "$id": "533", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "524" + }, + "doc": "Boost scores by the maximum of all scoring function results.", + "decorators": [] + }, + { + "$id": "534", + "kind": "enumvalue", + "name": "FirstMatching", + "value": "firstMatching", + "valueType": { + "$id": "535", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "524" + }, + "doc": "Boost scores using the first applicable scoring function in the scoring profile.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Defines the aggregation function used to combine the results of all the scoring\nfunctions in a scoring profile.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "536", + "kind": "enum", + "name": "SearchSuggester_searchMode", + "valueType": { + "$id": "537", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "538", + "kind": "enumvalue", + "name": "analyzingInfixMatching", + "value": "analyzingInfixMatching", + "doc": "analyzingInfixMatching", + "valueType": { + "$ref": "537" + }, + "enumType": { + "$ref": "536" + } + } + ], + "crossLanguageDefinitionId": "", + "namespace": "Azure.Search.Documents", + "doc": "The SearchSuggester_searchMode", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "539", + "kind": "enum", + "name": "LexicalTokenizerName", + "crossLanguageDefinitionId": "Search.LexicalTokenizerName", + "valueType": { + "$id": "540", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "541", + "kind": "enumvalue", + "name": "Classic", + "value": "classic", + "valueType": { + "$id": "542", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "539" + }, + "doc": "Grammar-based tokenizer that is suitable for processing most European-language\ndocuments. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html", + "decorators": [] + }, + { + "$id": "543", + "kind": "enumvalue", + "name": "EdgeNGram", + "value": "edgeNGram", + "valueType": { + "$id": "544", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "539" + }, + "doc": "Tokenizes the input from an edge into n-grams of the given size(s). See\nhttps://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html", + "decorators": [] + }, + { + "$id": "545", + "kind": "enumvalue", + "name": "Keyword", + "value": "keyword_v2", + "valueType": { + "$id": "546", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "539" + }, + "doc": "Emits the entire input as a single token. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html", + "decorators": [] + }, + { + "$id": "547", + "kind": "enumvalue", + "name": "Letter", + "value": "letter", + "valueType": { + "$id": "548", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "539" + }, + "doc": "Divides text at non-letters. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LetterTokenizer.html", + "decorators": [] + }, + { + "$id": "549", + "kind": "enumvalue", + "name": "Lowercase", + "value": "lowercase", + "valueType": { + "$id": "550", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "539" + }, + "doc": "Divides text at non-letters and converts them to lower case. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseTokenizer.html", + "decorators": [] + }, + { + "$id": "551", + "kind": "enumvalue", + "name": "MicrosoftLanguageTokenizer", + "value": "microsoft_language_tokenizer", + "valueType": { + "$id": "552", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "539" + }, + "doc": "Divides text using language-specific rules.", + "decorators": [] + }, + { + "$id": "553", + "kind": "enumvalue", + "name": "MicrosoftLanguageStemmingTokenizer", + "value": "microsoft_language_stemming_tokenizer", + "valueType": { + "$id": "554", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "539" + }, + "doc": "Divides text using language-specific rules and reduces words to their base\nforms.", + "decorators": [] + }, + { + "$id": "555", + "kind": "enumvalue", + "name": "NGram", + "value": "nGram", + "valueType": { + "$id": "556", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "539" + }, + "doc": "Tokenizes the input into n-grams of the given size(s). See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html", + "decorators": [] + }, + { + "$id": "557", + "kind": "enumvalue", + "name": "PathHierarchy", + "value": "path_hierarchy_v2", + "valueType": { + "$id": "558", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "539" + }, + "doc": "Tokenizer for path-like hierarchies. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html", + "decorators": [] + }, + { + "$id": "559", + "kind": "enumvalue", + "name": "Pattern", + "value": "pattern", + "valueType": { + "$id": "560", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "539" + }, + "doc": "Tokenizer that uses regex pattern matching to construct distinct tokens. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html", + "decorators": [] + }, + { + "$id": "561", + "kind": "enumvalue", + "name": "Standard", + "value": "standard_v2", + "valueType": { + "$id": "562", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "539" + }, + "doc": "Standard Lucene analyzer; Composed of the standard tokenizer, lowercase filter\nand stop filter. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html", + "decorators": [] + }, + { + "$id": "563", + "kind": "enumvalue", + "name": "UaxUrlEmail", + "value": "uax_url_email", + "valueType": { + "$id": "564", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "539" + }, + "doc": "Tokenizes urls and emails as one token. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html", + "decorators": [] + }, + { + "$id": "565", + "kind": "enumvalue", + "name": "Whitespace", + "value": "whitespace", + "valueType": { + "$id": "566", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "539" + }, + "doc": "Divides text at whitespace. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceTokenizer.html", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Defines the names of all tokenizers supported by the search engine.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "567", + "kind": "enum", + "name": "TokenFilterName", + "crossLanguageDefinitionId": "Search.TokenFilterName", + "valueType": { + "$id": "568", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "569", + "kind": "enumvalue", + "name": "ArabicNormalization", + "value": "arabic_normalization", + "valueType": { + "$id": "570", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "A token filter that applies the Arabic normalizer to normalize the orthography.\nSee\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html", + "decorators": [] + }, + { + "$id": "571", + "kind": "enumvalue", + "name": "Apostrophe", + "value": "apostrophe", + "valueType": { + "$id": "572", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Strips all characters after an apostrophe (including the apostrophe itself).\nSee\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/tr/ApostropheFilter.html", + "decorators": [] + }, + { + "$id": "573", + "kind": "enumvalue", + "name": "AsciiFolding", + "value": "asciifolding", + "valueType": { + "$id": "574", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in\nthe first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their\nASCII equivalents, if such equivalents exist. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html", + "decorators": [] + }, + { + "$id": "575", + "kind": "enumvalue", + "name": "CjkBigram", + "value": "cjk_bigram", + "valueType": { + "$id": "576", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Forms bigrams of CJK terms that are generated from the standard tokenizer. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html", + "decorators": [] + }, + { + "$id": "577", + "kind": "enumvalue", + "name": "CjkWidth", + "value": "cjk_width", + "valueType": { + "$id": "578", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Normalizes CJK width differences. Folds full-width ASCII variants into the\nequivalent basic Latin, and half-width Katakana variants into the equivalent\nKana. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html", + "decorators": [] + }, + { + "$id": "579", + "kind": "enumvalue", + "name": "Classic", + "value": "classic", + "valueType": { + "$id": "580", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Removes English possessives, and dots from acronyms. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html", + "decorators": [] + }, + { + "$id": "581", + "kind": "enumvalue", + "name": "CommonGram", + "value": "common_grams", + "valueType": { + "$id": "582", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Construct bigrams for frequently occurring terms while indexing. Single terms\nare still indexed too, with bigrams overlaid. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html", + "decorators": [] + }, + { + "$id": "583", + "kind": "enumvalue", + "name": "EdgeNGram", + "value": "edgeNGram_v2", + "valueType": { + "$id": "584", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Generates n-grams of the given size(s) starting from the front or the back of\nan input token. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html", + "decorators": [] + }, + { + "$id": "585", + "kind": "enumvalue", + "name": "Elision", + "value": "elision", + "valueType": { + "$id": "586", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to\n\"avion\" (plane). See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html", + "decorators": [] + }, + { + "$id": "587", + "kind": "enumvalue", + "name": "GermanNormalization", + "value": "german_normalization", + "valueType": { + "$id": "588", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Normalizes German characters according to the heuristics of the German2\nsnowball algorithm. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html", + "decorators": [] + }, + { + "$id": "589", + "kind": "enumvalue", + "name": "HindiNormalization", + "value": "hindi_normalization", + "valueType": { + "$id": "590", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Normalizes text in Hindi to remove some differences in spelling variations. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html", + "decorators": [] + }, + { + "$id": "591", + "kind": "enumvalue", + "name": "IndicNormalization", + "value": "indic_normalization", + "valueType": { + "$id": "592", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Normalizes the Unicode representation of text in Indian languages. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html", + "decorators": [] + }, + { + "$id": "593", + "kind": "enumvalue", + "name": "KeywordRepeat", + "value": "keyword_repeat", + "valueType": { + "$id": "594", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Emits each incoming token twice, once as keyword and once as non-keyword. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html", + "decorators": [] + }, + { + "$id": "595", + "kind": "enumvalue", + "name": "KStem", + "value": "kstem", + "valueType": { + "$id": "596", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "A high-performance kstem filter for English. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html", + "decorators": [] + }, + { + "$id": "597", + "kind": "enumvalue", + "name": "Length", + "value": "length", + "valueType": { + "$id": "598", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Removes words that are too long or too short. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html", + "decorators": [] + }, + { + "$id": "599", + "kind": "enumvalue", + "name": "Limit", + "value": "limit", + "valueType": { + "$id": "600", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Limits the number of tokens while indexing. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html", + "decorators": [] + }, + { + "$id": "601", + "kind": "enumvalue", + "name": "Lowercase", + "value": "lowercase", + "valueType": { + "$id": "602", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Normalizes token text to lower case. See\nhttps://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.html", + "decorators": [] + }, + { + "$id": "603", + "kind": "enumvalue", + "name": "NGram", + "value": "nGram_v2", + "valueType": { + "$id": "604", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Generates n-grams of the given size(s). See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html", + "decorators": [] + }, + { + "$id": "605", + "kind": "enumvalue", + "name": "PersianNormalization", + "value": "persian_normalization", + "valueType": { + "$id": "606", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Applies normalization for Persian. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html", + "decorators": [] + }, + { + "$id": "607", + "kind": "enumvalue", + "name": "Phonetic", + "value": "phonetic", + "valueType": { + "$id": "608", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Create tokens for phonetic matches. See\nhttps://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html", + "decorators": [] + }, + { + "$id": "609", + "kind": "enumvalue", + "name": "PorterStem", + "value": "porter_stem", + "valueType": { + "$id": "610", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Uses the Porter stemming algorithm to transform the token stream. See\nhttp://tartarus.org/~martin/PorterStemmer", + "decorators": [] + }, + { + "$id": "611", + "kind": "enumvalue", + "name": "Reverse", + "value": "reverse", + "valueType": { + "$id": "612", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Reverses the token string. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html", + "decorators": [] + }, + { + "$id": "613", + "kind": "enumvalue", + "name": "ScandinavianNormalization", + "value": "scandinavian_normalization", + "valueType": { + "$id": "614", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Normalizes use of the interchangeable Scandinavian characters. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html", + "decorators": [] + }, + { + "$id": "615", + "kind": "enumvalue", + "name": "ScandinavianFoldingNormalization", + "value": "scandinavian_folding", + "valueType": { + "$id": "616", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Folds Scandinavian characters åÅäæÄÆ->a and öÖøØ->o. It also\ndiscriminates against use of double vowels aa, ae, ao, oe and oo, leaving just\nthe first one. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html", + "decorators": [] + }, + { + "$id": "617", + "kind": "enumvalue", + "name": "Shingle", + "value": "shingle", + "valueType": { + "$id": "618", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Creates combinations of tokens as a single token. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html", + "decorators": [] + }, + { + "$id": "619", + "kind": "enumvalue", + "name": "Snowball", + "value": "snowball", + "valueType": { + "$id": "620", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "A filter that stems words using a Snowball-generated stemmer. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html", + "decorators": [] + }, + { + "$id": "621", + "kind": "enumvalue", + "name": "SoraniNormalization", + "value": "sorani_normalization", + "valueType": { + "$id": "622", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Normalizes the Unicode representation of Sorani text. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html", + "decorators": [] + }, + { + "$id": "623", + "kind": "enumvalue", + "name": "Stemmer", + "value": "stemmer", + "valueType": { + "$id": "624", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Language specific stemming filter. See\nhttps://learn.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters", + "decorators": [] + }, + { + "$id": "625", + "kind": "enumvalue", + "name": "Stopwords", + "value": "stopwords", + "valueType": { + "$id": "626", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Removes stop words from a token stream. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html", + "decorators": [] + }, + { + "$id": "627", + "kind": "enumvalue", + "name": "Trim", + "value": "trim", + "valueType": { + "$id": "628", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Trims leading and trailing whitespace from tokens. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html", + "decorators": [] + }, + { + "$id": "629", + "kind": "enumvalue", + "name": "Truncate", + "value": "truncate", + "valueType": { + "$id": "630", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Truncates the terms to a specific length. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html", + "decorators": [] + }, + { + "$id": "631", + "kind": "enumvalue", + "name": "Unique", + "value": "unique", + "valueType": { + "$id": "632", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Filters out tokens with same text as the previous token. See\nhttp://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html", + "decorators": [] + }, + { + "$id": "633", + "kind": "enumvalue", + "name": "Uppercase", + "value": "uppercase", + "valueType": { + "$id": "634", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Normalizes token text to upper case. See\nhttps://lucene.apache.org/core/6_6_1/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html", + "decorators": [] + }, + { + "$id": "635", + "kind": "enumvalue", + "name": "WordDelimiter", + "value": "word_delimiter", + "valueType": { + "$id": "636", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "567" + }, + "doc": "Splits words into subwords and performs optional transformations on subword\ngroups.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Defines the names of all token filters supported by the search engine.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "637", + "kind": "enum", + "name": "CharFilterName", + "crossLanguageDefinitionId": "Search.CharFilterName", + "valueType": { + "$id": "638", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "639", + "kind": "enumvalue", + "name": "HtmlStrip", + "value": "html_strip", + "valueType": { + "$id": "640", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "637" + }, + "doc": "A character filter that attempts to strip out HTML constructs. See\nhttps://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Defines the names of all character filters supported by the search engine.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "641", + "kind": "enum", + "name": "RegexFlags", + "crossLanguageDefinitionId": "Search.RegexFlags", + "valueType": { + "$id": "642", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "643", + "kind": "enumvalue", + "name": "CanonEq", + "value": "CANON_EQ", + "valueType": { + "$id": "644", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "641" + }, + "doc": "Enables canonical equivalence.", + "decorators": [] + }, + { + "$id": "645", + "kind": "enumvalue", + "name": "CaseInsensitive", + "value": "CASE_INSENSITIVE", + "valueType": { + "$id": "646", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "641" + }, + "doc": "Enables case-insensitive matching.", + "decorators": [] + }, + { + "$id": "647", + "kind": "enumvalue", + "name": "Comments", + "value": "COMMENTS", + "valueType": { + "$id": "648", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "641" + }, + "doc": "Permits whitespace and comments in the pattern.", + "decorators": [] + }, + { + "$id": "649", + "kind": "enumvalue", + "name": "DotAll", + "value": "DOTALL", + "valueType": { + "$id": "650", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "641" + }, + "doc": "Enables dotall mode.", + "decorators": [] + }, + { + "$id": "651", + "kind": "enumvalue", + "name": "Literal", + "value": "LITERAL", + "valueType": { + "$id": "652", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "641" + }, + "doc": "Enables literal parsing of the pattern.", + "decorators": [] + }, + { + "$id": "653", + "kind": "enumvalue", + "name": "Multiline", + "value": "MULTILINE", + "valueType": { + "$id": "654", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "641" + }, + "doc": "Enables multiline mode.", + "decorators": [] + }, + { + "$id": "655", + "kind": "enumvalue", + "name": "UnicodeCase", + "value": "UNICODE_CASE", + "valueType": { + "$id": "656", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "641" + }, + "doc": "Enables Unicode-aware case folding.", + "decorators": [] + }, + { + "$id": "657", + "kind": "enumvalue", + "name": "UnixLines", + "value": "UNIX_LINES", + "valueType": { + "$id": "658", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "641" + }, + "doc": "Enables Unix lines mode.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Defines flags that can be combined to control how regular expressions are used\nin the pattern analyzer and pattern tokenizer.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "659", + "kind": "enum", + "name": "TokenCharacterKind", + "crossLanguageDefinitionId": "Search.TokenCharacterKind", + "valueType": { + "$id": "660", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "661", + "kind": "enumvalue", + "name": "Letter", + "value": "letter", + "valueType": { + "$id": "662", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "659" + }, + "doc": "Keeps letters in tokens.", + "decorators": [] + }, + { + "$id": "663", + "kind": "enumvalue", + "name": "Digit", + "value": "digit", + "valueType": { + "$id": "664", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "659" + }, + "doc": "Keeps digits in tokens.", + "decorators": [] + }, + { + "$id": "665", + "kind": "enumvalue", + "name": "Whitespace", + "value": "whitespace", + "valueType": { + "$id": "666", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "659" + }, + "doc": "Keeps whitespace in tokens.", + "decorators": [] + }, + { + "$id": "667", + "kind": "enumvalue", + "name": "Punctuation", + "value": "punctuation", + "valueType": { + "$id": "668", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "659" + }, + "doc": "Keeps punctuation in tokens.", + "decorators": [] + }, + { + "$id": "669", + "kind": "enumvalue", + "name": "Symbol", + "value": "symbol", + "valueType": { + "$id": "670", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "659" + }, + "doc": "Keeps symbols in tokens.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Represents classes of characters on which a token filter can operate.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "671", + "kind": "enum", + "name": "MicrosoftTokenizerLanguage", + "crossLanguageDefinitionId": "Search.MicrosoftTokenizerLanguage", + "valueType": { + "$id": "672", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "673", + "kind": "enumvalue", + "name": "Bangla", + "value": "bangla", + "valueType": { + "$id": "674", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Bangla.", + "decorators": [] + }, + { + "$id": "675", + "kind": "enumvalue", + "name": "Bulgarian", + "value": "bulgarian", + "valueType": { + "$id": "676", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Bulgarian.", + "decorators": [] + }, + { + "$id": "677", + "kind": "enumvalue", + "name": "Catalan", + "value": "catalan", + "valueType": { + "$id": "678", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Catalan.", + "decorators": [] + }, + { + "$id": "679", + "kind": "enumvalue", + "name": "ChineseSimplified", + "value": "chineseSimplified", + "valueType": { + "$id": "680", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Chinese (Simplified).", + "decorators": [] + }, + { + "$id": "681", + "kind": "enumvalue", + "name": "ChineseTraditional", + "value": "chineseTraditional", + "valueType": { + "$id": "682", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Chinese (Traditional).", + "decorators": [] + }, + { + "$id": "683", + "kind": "enumvalue", + "name": "Croatian", + "value": "croatian", + "valueType": { + "$id": "684", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Croatian.", + "decorators": [] + }, + { + "$id": "685", + "kind": "enumvalue", + "name": "Czech", + "value": "czech", + "valueType": { + "$id": "686", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Czech.", + "decorators": [] + }, + { + "$id": "687", + "kind": "enumvalue", + "name": "Danish", + "value": "danish", + "valueType": { + "$id": "688", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Danish.", + "decorators": [] + }, + { + "$id": "689", + "kind": "enumvalue", + "name": "Dutch", + "value": "dutch", + "valueType": { + "$id": "690", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Dutch.", + "decorators": [] + }, + { + "$id": "691", + "kind": "enumvalue", + "name": "English", + "value": "english", + "valueType": { + "$id": "692", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for English.", + "decorators": [] + }, + { + "$id": "693", + "kind": "enumvalue", + "name": "French", + "value": "french", + "valueType": { + "$id": "694", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for French.", + "decorators": [] + }, + { + "$id": "695", + "kind": "enumvalue", + "name": "German", + "value": "german", + "valueType": { + "$id": "696", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for German.", + "decorators": [] + }, + { + "$id": "697", + "kind": "enumvalue", + "name": "Greek", + "value": "greek", + "valueType": { + "$id": "698", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Greek.", + "decorators": [] + }, + { + "$id": "699", + "kind": "enumvalue", + "name": "Gujarati", + "value": "gujarati", + "valueType": { + "$id": "700", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Gujarati.", + "decorators": [] + }, + { + "$id": "701", + "kind": "enumvalue", + "name": "Hindi", + "value": "hindi", + "valueType": { + "$id": "702", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Hindi.", + "decorators": [] + }, + { + "$id": "703", + "kind": "enumvalue", + "name": "Icelandic", + "value": "icelandic", + "valueType": { + "$id": "704", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Icelandic.", + "decorators": [] + }, + { + "$id": "705", + "kind": "enumvalue", + "name": "Indonesian", + "value": "indonesian", + "valueType": { + "$id": "706", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Indonesian.", + "decorators": [] + }, + { + "$id": "707", + "kind": "enumvalue", + "name": "Italian", + "value": "italian", + "valueType": { + "$id": "708", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Italian.", + "decorators": [] + }, + { + "$id": "709", + "kind": "enumvalue", + "name": "Japanese", + "value": "japanese", + "valueType": { + "$id": "710", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Japanese.", + "decorators": [] + }, + { + "$id": "711", + "kind": "enumvalue", + "name": "Kannada", + "value": "kannada", + "valueType": { + "$id": "712", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Kannada.", + "decorators": [] + }, + { + "$id": "713", + "kind": "enumvalue", + "name": "Korean", + "value": "korean", + "valueType": { + "$id": "714", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Korean.", + "decorators": [] + }, + { + "$id": "715", + "kind": "enumvalue", + "name": "Malay", + "value": "malay", + "valueType": { + "$id": "716", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Malay.", + "decorators": [] + }, + { + "$id": "717", + "kind": "enumvalue", + "name": "Malayalam", + "value": "malayalam", + "valueType": { + "$id": "718", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Malayalam.", + "decorators": [] + }, + { + "$id": "719", + "kind": "enumvalue", + "name": "Marathi", + "value": "marathi", + "valueType": { + "$id": "720", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Marathi.", + "decorators": [] + }, + { + "$id": "721", + "kind": "enumvalue", + "name": "NorwegianBokmaal", + "value": "norwegianBokmaal", + "valueType": { + "$id": "722", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Norwegian (Bokmål).", + "decorators": [] + }, + { + "$id": "723", + "kind": "enumvalue", + "name": "Polish", + "value": "polish", + "valueType": { + "$id": "724", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Polish.", + "decorators": [] + }, + { + "$id": "725", + "kind": "enumvalue", + "name": "Portuguese", + "value": "portuguese", + "valueType": { + "$id": "726", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Portuguese.", + "decorators": [] + }, + { + "$id": "727", + "kind": "enumvalue", + "name": "PortugueseBrazilian", + "value": "portugueseBrazilian", + "valueType": { + "$id": "728", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Portuguese (Brazil).", + "decorators": [] + }, + { + "$id": "729", + "kind": "enumvalue", + "name": "Punjabi", + "value": "punjabi", + "valueType": { + "$id": "730", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Punjabi.", + "decorators": [] + }, + { + "$id": "731", + "kind": "enumvalue", + "name": "Romanian", + "value": "romanian", + "valueType": { + "$id": "732", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Romanian.", + "decorators": [] + }, + { + "$id": "733", + "kind": "enumvalue", + "name": "Russian", + "value": "russian", + "valueType": { + "$id": "734", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Russian.", + "decorators": [] + }, + { + "$id": "735", + "kind": "enumvalue", + "name": "SerbianCyrillic", + "value": "serbianCyrillic", + "valueType": { + "$id": "736", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Serbian (Cyrillic).", + "decorators": [] + }, + { + "$id": "737", + "kind": "enumvalue", + "name": "SerbianLatin", + "value": "serbianLatin", + "valueType": { + "$id": "738", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Serbian (Latin).", + "decorators": [] + }, + { + "$id": "739", + "kind": "enumvalue", + "name": "Slovenian", + "value": "slovenian", + "valueType": { + "$id": "740", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Slovenian.", + "decorators": [] + }, + { + "$id": "741", + "kind": "enumvalue", + "name": "Spanish", + "value": "spanish", + "valueType": { + "$id": "742", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Spanish.", + "decorators": [] + }, + { + "$id": "743", + "kind": "enumvalue", + "name": "Swedish", + "value": "swedish", + "valueType": { + "$id": "744", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Swedish.", + "decorators": [] + }, + { + "$id": "745", + "kind": "enumvalue", + "name": "Tamil", + "value": "tamil", + "valueType": { + "$id": "746", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Tamil.", + "decorators": [] + }, + { + "$id": "747", + "kind": "enumvalue", + "name": "Telugu", + "value": "telugu", + "valueType": { + "$id": "748", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Telugu.", + "decorators": [] + }, + { + "$id": "749", + "kind": "enumvalue", + "name": "Thai", + "value": "thai", + "valueType": { + "$id": "750", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Thai.", + "decorators": [] + }, + { + "$id": "751", + "kind": "enumvalue", + "name": "Ukrainian", + "value": "ukrainian", + "valueType": { + "$id": "752", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Ukrainian.", + "decorators": [] + }, + { + "$id": "753", + "kind": "enumvalue", + "name": "Urdu", + "value": "urdu", + "valueType": { + "$id": "754", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Urdu.", + "decorators": [] + }, + { + "$id": "755", + "kind": "enumvalue", + "name": "Vietnamese", + "value": "vietnamese", + "valueType": { + "$id": "756", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "671" + }, + "doc": "Selects the Microsoft tokenizer for Vietnamese.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Lists the languages supported by the Microsoft language tokenizer.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "757", + "kind": "enum", + "name": "MicrosoftStemmingTokenizerLanguage", + "crossLanguageDefinitionId": "Search.MicrosoftStemmingTokenizerLanguage", + "valueType": { + "$id": "758", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "759", + "kind": "enumvalue", + "name": "Arabic", + "value": "arabic", + "valueType": { + "$id": "760", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Arabic.", + "decorators": [] + }, + { + "$id": "761", + "kind": "enumvalue", + "name": "Bangla", + "value": "bangla", + "valueType": { + "$id": "762", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Bangla.", + "decorators": [] + }, + { + "$id": "763", + "kind": "enumvalue", + "name": "Bulgarian", + "value": "bulgarian", + "valueType": { + "$id": "764", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Bulgarian.", + "decorators": [] + }, + { + "$id": "765", + "kind": "enumvalue", + "name": "Catalan", + "value": "catalan", + "valueType": { + "$id": "766", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Catalan.", + "decorators": [] + }, + { + "$id": "767", + "kind": "enumvalue", + "name": "Croatian", + "value": "croatian", + "valueType": { + "$id": "768", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Croatian.", + "decorators": [] + }, + { + "$id": "769", + "kind": "enumvalue", + "name": "Czech", + "value": "czech", + "valueType": { + "$id": "770", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Czech.", + "decorators": [] + }, + { + "$id": "771", + "kind": "enumvalue", + "name": "Danish", + "value": "danish", + "valueType": { + "$id": "772", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Danish.", + "decorators": [] + }, + { + "$id": "773", + "kind": "enumvalue", + "name": "Dutch", + "value": "dutch", + "valueType": { + "$id": "774", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Dutch.", + "decorators": [] + }, + { + "$id": "775", + "kind": "enumvalue", + "name": "English", + "value": "english", + "valueType": { + "$id": "776", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for English.", + "decorators": [] + }, + { + "$id": "777", + "kind": "enumvalue", + "name": "Estonian", + "value": "estonian", + "valueType": { + "$id": "778", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Estonian.", + "decorators": [] + }, + { + "$id": "779", + "kind": "enumvalue", + "name": "Finnish", + "value": "finnish", + "valueType": { + "$id": "780", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Finnish.", + "decorators": [] + }, + { + "$id": "781", + "kind": "enumvalue", + "name": "French", + "value": "french", + "valueType": { + "$id": "782", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for French.", + "decorators": [] + }, + { + "$id": "783", + "kind": "enumvalue", + "name": "German", + "value": "german", + "valueType": { + "$id": "784", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for German.", + "decorators": [] + }, + { + "$id": "785", + "kind": "enumvalue", + "name": "Greek", + "value": "greek", + "valueType": { + "$id": "786", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Greek.", + "decorators": [] + }, + { + "$id": "787", + "kind": "enumvalue", + "name": "Gujarati", + "value": "gujarati", + "valueType": { + "$id": "788", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Gujarati.", + "decorators": [] + }, + { + "$id": "789", + "kind": "enumvalue", + "name": "Hebrew", + "value": "hebrew", + "valueType": { + "$id": "790", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Hebrew.", + "decorators": [] + }, + { + "$id": "791", + "kind": "enumvalue", + "name": "Hindi", + "value": "hindi", + "valueType": { + "$id": "792", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Hindi.", + "decorators": [] + }, + { + "$id": "793", + "kind": "enumvalue", + "name": "Hungarian", + "value": "hungarian", + "valueType": { + "$id": "794", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Hungarian.", + "decorators": [] + }, + { + "$id": "795", + "kind": "enumvalue", + "name": "Icelandic", + "value": "icelandic", + "valueType": { + "$id": "796", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Icelandic.", + "decorators": [] + }, + { + "$id": "797", + "kind": "enumvalue", + "name": "Indonesian", + "value": "indonesian", + "valueType": { + "$id": "798", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Indonesian.", + "decorators": [] + }, + { + "$id": "799", + "kind": "enumvalue", + "name": "Italian", + "value": "italian", + "valueType": { + "$id": "800", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Italian.", + "decorators": [] + }, + { + "$id": "801", + "kind": "enumvalue", + "name": "Kannada", + "value": "kannada", + "valueType": { + "$id": "802", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Kannada.", + "decorators": [] + }, + { + "$id": "803", + "kind": "enumvalue", + "name": "Latvian", + "value": "latvian", + "valueType": { + "$id": "804", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Latvian.", + "decorators": [] + }, + { + "$id": "805", + "kind": "enumvalue", + "name": "Lithuanian", + "value": "lithuanian", + "valueType": { + "$id": "806", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Lithuanian.", + "decorators": [] + }, + { + "$id": "807", + "kind": "enumvalue", + "name": "Malay", + "value": "malay", + "valueType": { + "$id": "808", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Malay.", + "decorators": [] + }, + { + "$id": "809", + "kind": "enumvalue", + "name": "Malayalam", + "value": "malayalam", + "valueType": { + "$id": "810", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Malayalam.", + "decorators": [] + }, + { + "$id": "811", + "kind": "enumvalue", + "name": "Marathi", + "value": "marathi", + "valueType": { + "$id": "812", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Marathi.", + "decorators": [] + }, + { + "$id": "813", + "kind": "enumvalue", + "name": "NorwegianBokmaal", + "value": "norwegianBokmaal", + "valueType": { + "$id": "814", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Norwegian (Bokmål).", + "decorators": [] + }, + { + "$id": "815", + "kind": "enumvalue", + "name": "Polish", + "value": "polish", + "valueType": { + "$id": "816", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Polish.", + "decorators": [] + }, + { + "$id": "817", + "kind": "enumvalue", + "name": "Portuguese", + "value": "portuguese", + "valueType": { + "$id": "818", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Portuguese.", + "decorators": [] + }, + { + "$id": "819", + "kind": "enumvalue", + "name": "PortugueseBrazilian", + "value": "portugueseBrazilian", + "valueType": { + "$id": "820", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Portuguese (Brazil).", + "decorators": [] + }, + { + "$id": "821", + "kind": "enumvalue", + "name": "Punjabi", + "value": "punjabi", + "valueType": { + "$id": "822", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Punjabi.", + "decorators": [] + }, + { + "$id": "823", + "kind": "enumvalue", + "name": "Romanian", + "value": "romanian", + "valueType": { + "$id": "824", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Romanian.", + "decorators": [] + }, + { + "$id": "825", + "kind": "enumvalue", + "name": "Russian", + "value": "russian", + "valueType": { + "$id": "826", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Russian.", + "decorators": [] + }, + { + "$id": "827", + "kind": "enumvalue", + "name": "SerbianCyrillic", + "value": "serbianCyrillic", + "valueType": { + "$id": "828", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Serbian (Cyrillic).", + "decorators": [] + }, + { + "$id": "829", + "kind": "enumvalue", + "name": "SerbianLatin", + "value": "serbianLatin", + "valueType": { + "$id": "830", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Serbian (Latin).", + "decorators": [] + }, + { + "$id": "831", + "kind": "enumvalue", + "name": "Slovak", + "value": "slovak", + "valueType": { + "$id": "832", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Slovak.", + "decorators": [] + }, + { + "$id": "833", + "kind": "enumvalue", + "name": "Slovenian", + "value": "slovenian", + "valueType": { + "$id": "834", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Slovenian.", + "decorators": [] + }, + { + "$id": "835", + "kind": "enumvalue", + "name": "Spanish", + "value": "spanish", + "valueType": { + "$id": "836", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Spanish.", + "decorators": [] + }, + { + "$id": "837", + "kind": "enumvalue", + "name": "Swedish", + "value": "swedish", + "valueType": { + "$id": "838", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Swedish.", + "decorators": [] + }, + { + "$id": "839", + "kind": "enumvalue", + "name": "Tamil", + "value": "tamil", + "valueType": { + "$id": "840", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Tamil.", + "decorators": [] + }, + { + "$id": "841", + "kind": "enumvalue", + "name": "Telugu", + "value": "telugu", + "valueType": { + "$id": "842", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Telugu.", + "decorators": [] + }, + { + "$id": "843", + "kind": "enumvalue", + "name": "Turkish", + "value": "turkish", + "valueType": { + "$id": "844", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Turkish.", + "decorators": [] + }, + { + "$id": "845", + "kind": "enumvalue", + "name": "Ukrainian", + "value": "ukrainian", + "valueType": { + "$id": "846", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Ukrainian.", + "decorators": [] + }, + { + "$id": "847", + "kind": "enumvalue", + "name": "Urdu", + "value": "urdu", + "valueType": { + "$id": "848", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "757" + }, + "doc": "Selects the Microsoft stemming tokenizer for Urdu.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Lists the languages supported by the Microsoft language stemming tokenizer.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "849", + "kind": "enum", + "name": "CjkBigramTokenFilterScripts", + "crossLanguageDefinitionId": "Search.CjkBigramTokenFilterScripts", + "valueType": { + "$id": "850", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "851", + "kind": "enumvalue", + "name": "Han", + "value": "han", + "valueType": { + "$id": "852", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "849" + }, + "doc": "Ignore Han script when forming bigrams of CJK terms.", + "decorators": [] + }, + { + "$id": "853", + "kind": "enumvalue", + "name": "Hiragana", + "value": "hiragana", + "valueType": { + "$id": "854", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "849" + }, + "doc": "Ignore Hiragana script when forming bigrams of CJK terms.", + "decorators": [] + }, + { + "$id": "855", + "kind": "enumvalue", + "name": "Katakana", + "value": "katakana", + "valueType": { + "$id": "856", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "849" + }, + "doc": "Ignore Katakana script when forming bigrams of CJK terms.", + "decorators": [] + }, + { + "$id": "857", + "kind": "enumvalue", + "name": "Hangul", + "value": "hangul", + "valueType": { + "$id": "858", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "849" + }, + "doc": "Ignore Hangul script when forming bigrams of CJK terms.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Scripts that can be ignored by CjkBigramTokenFilter.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "859", + "kind": "enum", + "name": "EdgeNGramTokenFilterSide", + "crossLanguageDefinitionId": "Search.EdgeNGramTokenFilterSide", + "valueType": { + "$id": "860", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "861", + "kind": "enumvalue", + "name": "Front", + "value": "front", + "valueType": { + "$id": "862", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "859" + }, + "doc": "Specifies that the n-gram should be generated from the front of the input.", + "decorators": [] + }, + { + "$id": "863", + "kind": "enumvalue", + "name": "Back", + "value": "back", + "valueType": { + "$id": "864", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "859" + }, + "doc": "Specifies that the n-gram should be generated from the back of the input.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Specifies which side of the input an n-gram should be generated from.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "865", + "kind": "enum", + "name": "PhoneticEncoder", + "crossLanguageDefinitionId": "Search.PhoneticEncoder", + "valueType": { + "$id": "866", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "867", + "kind": "enumvalue", + "name": "Metaphone", + "value": "metaphone", + "valueType": { + "$id": "868", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "865" + }, + "doc": "Encodes a token into a Metaphone value.", + "decorators": [] + }, + { + "$id": "869", + "kind": "enumvalue", + "name": "DoubleMetaphone", + "value": "doubleMetaphone", + "valueType": { + "$id": "870", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "865" + }, + "doc": "Encodes a token into a double metaphone value.", + "decorators": [] + }, + { + "$id": "871", + "kind": "enumvalue", + "name": "Soundex", + "value": "soundex", + "valueType": { + "$id": "872", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "865" + }, + "doc": "Encodes a token into a Soundex value.", + "decorators": [] + }, + { + "$id": "873", + "kind": "enumvalue", + "name": "RefinedSoundex", + "value": "refinedSoundex", + "valueType": { + "$id": "874", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "865" + }, + "doc": "Encodes a token into a Refined Soundex value.", + "decorators": [] + }, + { + "$id": "875", + "kind": "enumvalue", + "name": "Caverphone1", + "value": "caverphone1", + "valueType": { + "$id": "876", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "865" + }, + "doc": "Encodes a token into a Caverphone 1.0 value.", + "decorators": [] + }, + { + "$id": "877", + "kind": "enumvalue", + "name": "Caverphone2", + "value": "caverphone2", + "valueType": { + "$id": "878", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "865" + }, + "doc": "Encodes a token into a Caverphone 2.0 value.", + "decorators": [] + }, + { + "$id": "879", + "kind": "enumvalue", + "name": "Cologne", + "value": "cologne", + "valueType": { + "$id": "880", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "865" + }, + "doc": "Encodes a token into a Cologne Phonetic value.", + "decorators": [] + }, + { + "$id": "881", + "kind": "enumvalue", + "name": "Nysiis", + "value": "nysiis", + "valueType": { + "$id": "882", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "865" + }, + "doc": "Encodes a token into a NYSIIS value.", + "decorators": [] + }, + { + "$id": "883", + "kind": "enumvalue", + "name": "KoelnerPhonetik", + "value": "koelnerPhonetik", + "valueType": { + "$id": "884", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "865" + }, + "doc": "Encodes a token using the Kölner Phonetik algorithm.", + "decorators": [] + }, + { + "$id": "885", + "kind": "enumvalue", + "name": "HaasePhonetik", + "value": "haasePhonetik", + "valueType": { + "$id": "886", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "865" + }, + "doc": "Encodes a token using the Haase refinement of the Kölner Phonetik algorithm.", + "decorators": [] + }, + { + "$id": "887", + "kind": "enumvalue", + "name": "BeiderMorse", + "value": "beiderMorse", + "valueType": { + "$id": "888", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "865" + }, + "doc": "Encodes a token into a Beider-Morse value.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Identifies the type of phonetic encoder to use with a PhoneticTokenFilter.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "889", + "kind": "enum", + "name": "SnowballTokenFilterLanguage", + "crossLanguageDefinitionId": "Search.SnowballTokenFilterLanguage", + "valueType": { + "$id": "890", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "891", + "kind": "enumvalue", + "name": "Armenian", + "value": "armenian", + "valueType": { + "$id": "892", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Armenian.", + "decorators": [] + }, + { + "$id": "893", + "kind": "enumvalue", + "name": "Basque", + "value": "basque", + "valueType": { + "$id": "894", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Basque.", + "decorators": [] + }, + { + "$id": "895", + "kind": "enumvalue", + "name": "Catalan", + "value": "catalan", + "valueType": { + "$id": "896", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Catalan.", + "decorators": [] + }, + { + "$id": "897", + "kind": "enumvalue", + "name": "Danish", + "value": "danish", + "valueType": { + "$id": "898", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Danish.", + "decorators": [] + }, + { + "$id": "899", + "kind": "enumvalue", + "name": "Dutch", + "value": "dutch", + "valueType": { + "$id": "900", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Dutch.", + "decorators": [] + }, + { + "$id": "901", + "kind": "enumvalue", + "name": "English", + "value": "english", + "valueType": { + "$id": "902", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for English.", + "decorators": [] + }, + { + "$id": "903", + "kind": "enumvalue", + "name": "Finnish", + "value": "finnish", + "valueType": { + "$id": "904", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Finnish.", + "decorators": [] + }, + { + "$id": "905", + "kind": "enumvalue", + "name": "French", + "value": "french", + "valueType": { + "$id": "906", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for French.", + "decorators": [] + }, + { + "$id": "907", + "kind": "enumvalue", + "name": "German", + "value": "german", + "valueType": { + "$id": "908", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for German.", + "decorators": [] + }, + { + "$id": "909", + "kind": "enumvalue", + "name": "German2", + "value": "german2", + "valueType": { + "$id": "910", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer that uses the German variant\nalgorithm.", + "decorators": [] + }, + { + "$id": "911", + "kind": "enumvalue", + "name": "Hungarian", + "value": "hungarian", + "valueType": { + "$id": "912", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Hungarian.", + "decorators": [] + }, + { + "$id": "913", + "kind": "enumvalue", + "name": "Italian", + "value": "italian", + "valueType": { + "$id": "914", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Italian.", + "decorators": [] + }, + { + "$id": "915", + "kind": "enumvalue", + "name": "Kp", + "value": "kp", + "valueType": { + "$id": "916", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Dutch that uses the\nKraaij-Pohlmann stemming algorithm.", + "decorators": [] + }, + { + "$id": "917", + "kind": "enumvalue", + "name": "Lovins", + "value": "lovins", + "valueType": { + "$id": "918", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for English that uses the Lovins\nstemming algorithm.", + "decorators": [] + }, + { + "$id": "919", + "kind": "enumvalue", + "name": "Norwegian", + "value": "norwegian", + "valueType": { + "$id": "920", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Norwegian.", + "decorators": [] + }, + { + "$id": "921", + "kind": "enumvalue", + "name": "Porter", + "value": "porter", + "valueType": { + "$id": "922", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for English that uses the Porter\nstemming algorithm.", + "decorators": [] + }, + { + "$id": "923", + "kind": "enumvalue", + "name": "Portuguese", + "value": "portuguese", + "valueType": { + "$id": "924", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Portuguese.", + "decorators": [] + }, + { + "$id": "925", + "kind": "enumvalue", + "name": "Romanian", + "value": "romanian", + "valueType": { + "$id": "926", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Romanian.", + "decorators": [] + }, + { + "$id": "927", + "kind": "enumvalue", + "name": "Russian", + "value": "russian", + "valueType": { + "$id": "928", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Russian.", + "decorators": [] + }, + { + "$id": "929", + "kind": "enumvalue", + "name": "Spanish", + "value": "spanish", + "valueType": { + "$id": "930", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Spanish.", + "decorators": [] + }, + { + "$id": "931", + "kind": "enumvalue", + "name": "Swedish", + "value": "swedish", + "valueType": { + "$id": "932", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Swedish.", + "decorators": [] + }, + { + "$id": "933", + "kind": "enumvalue", + "name": "Turkish", + "value": "turkish", + "valueType": { + "$id": "934", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "889" + }, + "doc": "Selects the Lucene Snowball stemming tokenizer for Turkish.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The language to use for a Snowball token filter.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "935", + "kind": "enum", + "name": "StemmerTokenFilterLanguage", + "crossLanguageDefinitionId": "Search.StemmerTokenFilterLanguage", + "valueType": { + "$id": "936", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "937", + "kind": "enumvalue", + "name": "Arabic", + "value": "arabic", + "valueType": { + "$id": "938", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Arabic.", + "decorators": [] + }, + { + "$id": "939", + "kind": "enumvalue", + "name": "Armenian", + "value": "armenian", + "valueType": { + "$id": "940", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Armenian.", + "decorators": [] + }, + { + "$id": "941", + "kind": "enumvalue", + "name": "Basque", + "value": "basque", + "valueType": { + "$id": "942", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Basque.", + "decorators": [] + }, + { + "$id": "943", + "kind": "enumvalue", + "name": "Brazilian", + "value": "brazilian", + "valueType": { + "$id": "944", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Portuguese (Brazil).", + "decorators": [] + }, + { + "$id": "945", + "kind": "enumvalue", + "name": "Bulgarian", + "value": "bulgarian", + "valueType": { + "$id": "946", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Bulgarian.", + "decorators": [] + }, + { + "$id": "947", + "kind": "enumvalue", + "name": "Catalan", + "value": "catalan", + "valueType": { + "$id": "948", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Catalan.", + "decorators": [] + }, + { + "$id": "949", + "kind": "enumvalue", + "name": "Czech", + "value": "czech", + "valueType": { + "$id": "950", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Czech.", + "decorators": [] + }, + { + "$id": "951", + "kind": "enumvalue", + "name": "Danish", + "value": "danish", + "valueType": { + "$id": "952", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Danish.", + "decorators": [] + }, + { + "$id": "953", + "kind": "enumvalue", + "name": "Dutch", + "value": "dutch", + "valueType": { + "$id": "954", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Dutch.", + "decorators": [] + }, + { + "$id": "955", + "kind": "enumvalue", + "name": "DutchKp", + "value": "dutchKp", + "valueType": { + "$id": "956", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Dutch that uses the Kraaij-Pohlmann\nstemming algorithm.", + "decorators": [] + }, + { + "$id": "957", + "kind": "enumvalue", + "name": "English", + "value": "english", + "valueType": { + "$id": "958", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for English.", + "decorators": [] + }, + { + "$id": "959", + "kind": "enumvalue", + "name": "LightEnglish", + "value": "lightEnglish", + "valueType": { + "$id": "960", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for English that does light stemming.", + "decorators": [] + }, + { + "$id": "961", + "kind": "enumvalue", + "name": "MinimalEnglish", + "value": "minimalEnglish", + "valueType": { + "$id": "962", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for English that does minimal stemming.", + "decorators": [] + }, + { + "$id": "963", + "kind": "enumvalue", + "name": "PossessiveEnglish", + "value": "possessiveEnglish", + "valueType": { + "$id": "964", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for English that removes trailing\npossessives from words.", + "decorators": [] + }, + { + "$id": "965", + "kind": "enumvalue", + "name": "Porter2", + "value": "porter2", + "valueType": { + "$id": "966", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for English that uses the Porter2\nstemming algorithm.", + "decorators": [] + }, + { + "$id": "967", + "kind": "enumvalue", + "name": "Lovins", + "value": "lovins", + "valueType": { + "$id": "968", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for English that uses the Lovins stemming\nalgorithm.", + "decorators": [] + }, + { + "$id": "969", + "kind": "enumvalue", + "name": "Finnish", + "value": "finnish", + "valueType": { + "$id": "970", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Finnish.", + "decorators": [] + }, + { + "$id": "971", + "kind": "enumvalue", + "name": "LightFinnish", + "value": "lightFinnish", + "valueType": { + "$id": "972", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Finnish that does light stemming.", + "decorators": [] + }, + { + "$id": "973", + "kind": "enumvalue", + "name": "French", + "value": "french", + "valueType": { + "$id": "974", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for French.", + "decorators": [] + }, + { + "$id": "975", + "kind": "enumvalue", + "name": "LightFrench", + "value": "lightFrench", + "valueType": { + "$id": "976", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for French that does light stemming.", + "decorators": [] + }, + { + "$id": "977", + "kind": "enumvalue", + "name": "MinimalFrench", + "value": "minimalFrench", + "valueType": { + "$id": "978", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for French that does minimal stemming.", + "decorators": [] + }, + { + "$id": "979", + "kind": "enumvalue", + "name": "Galician", + "value": "galician", + "valueType": { + "$id": "980", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Galician.", + "decorators": [] + }, + { + "$id": "981", + "kind": "enumvalue", + "name": "MinimalGalician", + "value": "minimalGalician", + "valueType": { + "$id": "982", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Galician that does minimal stemming.", + "decorators": [] + }, + { + "$id": "983", + "kind": "enumvalue", + "name": "German", + "value": "german", + "valueType": { + "$id": "984", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for German.", + "decorators": [] + }, + { + "$id": "985", + "kind": "enumvalue", + "name": "German2", + "value": "german2", + "valueType": { + "$id": "986", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer that uses the German variant algorithm.", + "decorators": [] + }, + { + "$id": "987", + "kind": "enumvalue", + "name": "LightGerman", + "value": "lightGerman", + "valueType": { + "$id": "988", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for German that does light stemming.", + "decorators": [] + }, + { + "$id": "989", + "kind": "enumvalue", + "name": "MinimalGerman", + "value": "minimalGerman", + "valueType": { + "$id": "990", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for German that does minimal stemming.", + "decorators": [] + }, + { + "$id": "991", + "kind": "enumvalue", + "name": "Greek", + "value": "greek", + "valueType": { + "$id": "992", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Greek.", + "decorators": [] + }, + { + "$id": "993", + "kind": "enumvalue", + "name": "Hindi", + "value": "hindi", + "valueType": { + "$id": "994", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Hindi.", + "decorators": [] + }, + { + "$id": "995", + "kind": "enumvalue", + "name": "Hungarian", + "value": "hungarian", + "valueType": { + "$id": "996", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Hungarian.", + "decorators": [] + }, + { + "$id": "997", + "kind": "enumvalue", + "name": "LightHungarian", + "value": "lightHungarian", + "valueType": { + "$id": "998", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Hungarian that does light stemming.", + "decorators": [] + }, + { + "$id": "999", + "kind": "enumvalue", + "name": "Indonesian", + "value": "indonesian", + "valueType": { + "$id": "1000", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Indonesian.", + "decorators": [] + }, + { + "$id": "1001", + "kind": "enumvalue", + "name": "Irish", + "value": "irish", + "valueType": { + "$id": "1002", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Irish.", + "decorators": [] + }, + { + "$id": "1003", + "kind": "enumvalue", + "name": "Italian", + "value": "italian", + "valueType": { + "$id": "1004", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Italian.", + "decorators": [] + }, + { + "$id": "1005", + "kind": "enumvalue", + "name": "LightItalian", + "value": "lightItalian", + "valueType": { + "$id": "1006", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Italian that does light stemming.", + "decorators": [] + }, + { + "$id": "1007", + "kind": "enumvalue", + "name": "Sorani", + "value": "sorani", + "valueType": { + "$id": "1008", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Sorani.", + "decorators": [] + }, + { + "$id": "1009", + "kind": "enumvalue", + "name": "Latvian", + "value": "latvian", + "valueType": { + "$id": "1010", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Latvian.", + "decorators": [] + }, + { + "$id": "1011", + "kind": "enumvalue", + "name": "Norwegian", + "value": "norwegian", + "valueType": { + "$id": "1012", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål).", + "decorators": [] + }, + { + "$id": "1013", + "kind": "enumvalue", + "name": "LightNorwegian", + "value": "lightNorwegian", + "valueType": { + "$id": "1014", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does light\nstemming.", + "decorators": [] + }, + { + "$id": "1015", + "kind": "enumvalue", + "name": "MinimalNorwegian", + "value": "minimalNorwegian", + "valueType": { + "$id": "1016", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does minimal\nstemming.", + "decorators": [] + }, + { + "$id": "1017", + "kind": "enumvalue", + "name": "LightNynorsk", + "value": "lightNynorsk", + "valueType": { + "$id": "1018", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does light\nstemming.", + "decorators": [] + }, + { + "$id": "1019", + "kind": "enumvalue", + "name": "MinimalNynorsk", + "value": "minimalNynorsk", + "valueType": { + "$id": "1020", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does minimal\nstemming.", + "decorators": [] + }, + { + "$id": "1021", + "kind": "enumvalue", + "name": "Portuguese", + "value": "portuguese", + "valueType": { + "$id": "1022", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Portuguese.", + "decorators": [] + }, + { + "$id": "1023", + "kind": "enumvalue", + "name": "LightPortuguese", + "value": "lightPortuguese", + "valueType": { + "$id": "1024", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Portuguese that does light stemming.", + "decorators": [] + }, + { + "$id": "1025", + "kind": "enumvalue", + "name": "MinimalPortuguese", + "value": "minimalPortuguese", + "valueType": { + "$id": "1026", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Portuguese that does minimal stemming.", + "decorators": [] + }, + { + "$id": "1027", + "kind": "enumvalue", + "name": "PortugueseRslp", + "value": "portugueseRslp", + "valueType": { + "$id": "1028", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Portuguese that uses the RSLP\nstemming algorithm.", + "decorators": [] + }, + { + "$id": "1029", + "kind": "enumvalue", + "name": "Romanian", + "value": "romanian", + "valueType": { + "$id": "1030", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Romanian.", + "decorators": [] + }, + { + "$id": "1031", + "kind": "enumvalue", + "name": "Russian", + "value": "russian", + "valueType": { + "$id": "1032", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Russian.", + "decorators": [] + }, + { + "$id": "1033", + "kind": "enumvalue", + "name": "LightRussian", + "value": "lightRussian", + "valueType": { + "$id": "1034", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Russian that does light stemming.", + "decorators": [] + }, + { + "$id": "1035", + "kind": "enumvalue", + "name": "Spanish", + "value": "spanish", + "valueType": { + "$id": "1036", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Spanish.", + "decorators": [] + }, + { + "$id": "1037", + "kind": "enumvalue", + "name": "LightSpanish", + "value": "lightSpanish", + "valueType": { + "$id": "1038", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Spanish that does light stemming.", + "decorators": [] + }, + { + "$id": "1039", + "kind": "enumvalue", + "name": "Swedish", + "value": "swedish", + "valueType": { + "$id": "1040", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Swedish.", + "decorators": [] + }, + { + "$id": "1041", + "kind": "enumvalue", + "name": "LightSwedish", + "value": "lightSwedish", + "valueType": { + "$id": "1042", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Swedish that does light stemming.", + "decorators": [] + }, + { + "$id": "1043", + "kind": "enumvalue", + "name": "Turkish", + "value": "turkish", + "valueType": { + "$id": "1044", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "935" + }, + "doc": "Selects the Lucene stemming tokenizer for Turkish.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The language to use for a stemmer token filter.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1045", + "kind": "enum", + "name": "StopwordsList", + "crossLanguageDefinitionId": "Search.StopwordsList", + "valueType": { + "$id": "1046", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1047", + "kind": "enumvalue", + "name": "Arabic", + "value": "arabic", + "valueType": { + "$id": "1048", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Arabic.", + "decorators": [] + }, + { + "$id": "1049", + "kind": "enumvalue", + "name": "Armenian", + "value": "armenian", + "valueType": { + "$id": "1050", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Armenian.", + "decorators": [] + }, + { + "$id": "1051", + "kind": "enumvalue", + "name": "Basque", + "value": "basque", + "valueType": { + "$id": "1052", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Basque.", + "decorators": [] + }, + { + "$id": "1053", + "kind": "enumvalue", + "name": "Brazilian", + "value": "brazilian", + "valueType": { + "$id": "1054", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Portuguese (Brazil).", + "decorators": [] + }, + { + "$id": "1055", + "kind": "enumvalue", + "name": "Bulgarian", + "value": "bulgarian", + "valueType": { + "$id": "1056", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Bulgarian.", + "decorators": [] + }, + { + "$id": "1057", + "kind": "enumvalue", + "name": "Catalan", + "value": "catalan", + "valueType": { + "$id": "1058", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Catalan.", + "decorators": [] + }, + { + "$id": "1059", + "kind": "enumvalue", + "name": "Czech", + "value": "czech", + "valueType": { + "$id": "1060", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Czech.", + "decorators": [] + }, + { + "$id": "1061", + "kind": "enumvalue", + "name": "Danish", + "value": "danish", + "valueType": { + "$id": "1062", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Danish.", + "decorators": [] + }, + { + "$id": "1063", + "kind": "enumvalue", + "name": "Dutch", + "value": "dutch", + "valueType": { + "$id": "1064", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Dutch.", + "decorators": [] + }, + { + "$id": "1065", + "kind": "enumvalue", + "name": "English", + "value": "english", + "valueType": { + "$id": "1066", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for English.", + "decorators": [] + }, + { + "$id": "1067", + "kind": "enumvalue", + "name": "Finnish", + "value": "finnish", + "valueType": { + "$id": "1068", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Finnish.", + "decorators": [] + }, + { + "$id": "1069", + "kind": "enumvalue", + "name": "French", + "value": "french", + "valueType": { + "$id": "1070", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for French.", + "decorators": [] + }, + { + "$id": "1071", + "kind": "enumvalue", + "name": "Galician", + "value": "galician", + "valueType": { + "$id": "1072", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Galician.", + "decorators": [] + }, + { + "$id": "1073", + "kind": "enumvalue", + "name": "German", + "value": "german", + "valueType": { + "$id": "1074", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for German.", + "decorators": [] + }, + { + "$id": "1075", + "kind": "enumvalue", + "name": "Greek", + "value": "greek", + "valueType": { + "$id": "1076", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Greek.", + "decorators": [] + }, + { + "$id": "1077", + "kind": "enumvalue", + "name": "Hindi", + "value": "hindi", + "valueType": { + "$id": "1078", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Hindi.", + "decorators": [] + }, + { + "$id": "1079", + "kind": "enumvalue", + "name": "Hungarian", + "value": "hungarian", + "valueType": { + "$id": "1080", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Hungarian.", + "decorators": [] + }, + { + "$id": "1081", + "kind": "enumvalue", + "name": "Indonesian", + "value": "indonesian", + "valueType": { + "$id": "1082", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Indonesian.", + "decorators": [] + }, + { + "$id": "1083", + "kind": "enumvalue", + "name": "Irish", + "value": "irish", + "valueType": { + "$id": "1084", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Irish.", + "decorators": [] + }, + { + "$id": "1085", + "kind": "enumvalue", + "name": "Italian", + "value": "italian", + "valueType": { + "$id": "1086", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Italian.", + "decorators": [] + }, + { + "$id": "1087", + "kind": "enumvalue", + "name": "Latvian", + "value": "latvian", + "valueType": { + "$id": "1088", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Latvian.", + "decorators": [] + }, + { + "$id": "1089", + "kind": "enumvalue", + "name": "Norwegian", + "value": "norwegian", + "valueType": { + "$id": "1090", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Norwegian.", + "decorators": [] + }, + { + "$id": "1091", + "kind": "enumvalue", + "name": "Persian", + "value": "persian", + "valueType": { + "$id": "1092", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Persian.", + "decorators": [] + }, + { + "$id": "1093", + "kind": "enumvalue", + "name": "Portuguese", + "value": "portuguese", + "valueType": { + "$id": "1094", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Portuguese.", + "decorators": [] + }, + { + "$id": "1095", + "kind": "enumvalue", + "name": "Romanian", + "value": "romanian", + "valueType": { + "$id": "1096", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Romanian.", + "decorators": [] + }, + { + "$id": "1097", + "kind": "enumvalue", + "name": "Russian", + "value": "russian", + "valueType": { + "$id": "1098", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Russian.", + "decorators": [] + }, + { + "$id": "1099", + "kind": "enumvalue", + "name": "Sorani", + "value": "sorani", + "valueType": { + "$id": "1100", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Sorani.", + "decorators": [] + }, + { + "$id": "1101", + "kind": "enumvalue", + "name": "Spanish", + "value": "spanish", + "valueType": { + "$id": "1102", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Spanish.", + "decorators": [] + }, + { + "$id": "1103", + "kind": "enumvalue", + "name": "Swedish", + "value": "swedish", + "valueType": { + "$id": "1104", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Swedish.", + "decorators": [] + }, + { + "$id": "1105", + "kind": "enumvalue", + "name": "Thai", + "value": "thai", + "valueType": { + "$id": "1106", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Thai.", + "decorators": [] + }, + { + "$id": "1107", + "kind": "enumvalue", + "name": "Turkish", + "value": "turkish", + "valueType": { + "$id": "1108", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1045" + }, + "doc": "Selects the stopword list for Turkish.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Identifies a predefined list of language-specific stopwords.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1109", + "kind": "enum", + "name": "VectorSearchAlgorithmKind", + "crossLanguageDefinitionId": "Search.VectorSearchAlgorithmKind", + "valueType": { + "$id": "1110", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1111", + "kind": "enumvalue", + "name": "Hnsw", + "value": "hnsw", + "valueType": { + "$id": "1112", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1109" + }, + "doc": "HNSW (Hierarchical Navigable Small World), a type of approximate nearest\nneighbors algorithm.", + "decorators": [] + }, + { + "$id": "1113", + "kind": "enumvalue", + "name": "ExhaustiveKnn", + "value": "exhaustiveKnn", + "valueType": { + "$id": "1114", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1109" + }, + "doc": "Exhaustive KNN algorithm which will perform brute-force search.", + "decorators": [] + } + ], + "access": "public", + "namespace": "Azure.Search.Documents", + "doc": "The algorithm used for indexing and querying.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1115", + "kind": "enum", + "name": "VectorSearchAlgorithmMetric", + "crossLanguageDefinitionId": "Search.VectorSearchAlgorithmMetric", + "valueType": { + "$id": "1116", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1117", + "kind": "enumvalue", + "name": "Cosine", + "value": "cosine", + "valueType": { + "$id": "1118", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1115" + }, + "doc": "Measures the angle between vectors to quantify their similarity, disregarding\nmagnitude. The smaller the angle, the closer the similarity.", + "decorators": [] + }, + { + "$id": "1119", + "kind": "enumvalue", + "name": "Euclidean", + "value": "euclidean", + "valueType": { + "$id": "1120", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1115" + }, + "doc": "Computes the straight-line distance between vectors in a multi-dimensional\nspace. The smaller the distance, the closer the similarity.", + "decorators": [] + }, + { + "$id": "1121", + "kind": "enumvalue", + "name": "DotProduct", + "value": "dotProduct", + "valueType": { + "$id": "1122", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1115" + }, + "doc": "Calculates the sum of element-wise products to gauge alignment and magnitude\nsimilarity. The larger and more positive, the closer the similarity.", + "decorators": [] + }, + { + "$id": "1123", + "kind": "enumvalue", + "name": "Hamming", + "value": "hamming", + "valueType": { + "$id": "1124", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1115" + }, + "doc": "Only applicable to bit-packed binary data types. Determines dissimilarity by\ncounting differing positions in binary vectors. The fewer differences, the\ncloser the similarity.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The similarity metric to use for vector comparisons. It is recommended to\nchoose the same similarity metric as the embedding model was trained on.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1125", + "kind": "enum", + "name": "VectorSearchVectorizerKind", + "crossLanguageDefinitionId": "Search.VectorSearchVectorizerKind", + "valueType": { + "$id": "1126", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1127", + "kind": "enumvalue", + "name": "AzureOpenAI", + "value": "azureOpenAI", + "valueType": { + "$id": "1128", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1125" + }, + "doc": "Generate embeddings using an Azure OpenAI resource at query time.", + "decorators": [] + }, + { + "$id": "1129", + "kind": "enumvalue", + "name": "CustomWebApi", + "value": "customWebApi", + "valueType": { + "$id": "1130", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1125" + }, + "doc": "Generate embeddings using a custom web endpoint at query time.", + "decorators": [] + }, + { + "$id": "1131", + "kind": "enumvalue", + "name": "AIServicesVision", + "value": "aiServicesVision", + "valueType": { + "$id": "1132", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1125" + }, + "doc": "Generate embeddings for an image or text input at query time using the Azure AI\nServices Vision Vectorize API.", + "decorators": [] + }, + { + "$id": "1133", + "kind": "enumvalue", + "name": "AML", + "value": "aml", + "valueType": { + "$id": "1134", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1125" + }, + "doc": "Generate embeddings using an Azure Machine Learning endpoint deployed via the\nAzure AI Foundry Model Catalog at query time.", + "decorators": [] + } + ], + "access": "public", + "namespace": "Azure.Search.Documents", + "doc": "The vectorization method to be used during query time.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1135", + "kind": "enum", + "name": "AzureOpenAIModelName", + "crossLanguageDefinitionId": "Search.AzureOpenAIModelName", + "valueType": { + "$id": "1136", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1137", + "kind": "enumvalue", + "name": "TextEmbeddingAda002", + "value": "text-embedding-ada-002", + "valueType": { + "$id": "1138", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1135" + }, + "doc": "TextEmbeddingAda002 model.", + "decorators": [] + }, + { + "$id": "1139", + "kind": "enumvalue", + "name": "TextEmbedding3Large", + "value": "text-embedding-3-large", + "valueType": { + "$id": "1140", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1135" + }, + "doc": "TextEmbedding3Large model.", + "decorators": [] + }, + { + "$id": "1141", + "kind": "enumvalue", + "name": "TextEmbedding3Small", + "value": "text-embedding-3-small", + "valueType": { + "$id": "1142", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1135" + }, + "doc": "TextEmbedding3Small model.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The Azure Open AI model name that will be called.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1143", + "kind": "enum", + "name": "AIFoundryModelCatalogName", + "crossLanguageDefinitionId": "Search.AIFoundryModelCatalogName", + "valueType": { + "$id": "1144", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1145", + "kind": "enumvalue", + "name": "OpenAICLIPImageTextEmbeddingsVitBasePatch32", + "value": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32", + "valueType": { + "$id": "1146", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1143" + }, + "doc": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32", + "decorators": [] + }, + { + "$id": "1147", + "kind": "enumvalue", + "name": "OpenAICLIPImageTextEmbeddingsViTLargePatch14336", + "value": "OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336", + "valueType": { + "$id": "1148", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1143" + }, + "doc": "OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336", + "decorators": [] + }, + { + "$id": "1149", + "kind": "enumvalue", + "name": "FacebookDinoV2ImageEmbeddingsViTBase", + "value": "Facebook-DinoV2-Image-Embeddings-ViT-Base", + "valueType": { + "$id": "1150", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1143" + }, + "doc": "Facebook-DinoV2-Image-Embeddings-ViT-Base", + "decorators": [] + }, + { + "$id": "1151", + "kind": "enumvalue", + "name": "FacebookDinoV2ImageEmbeddingsViTGiant", + "value": "Facebook-DinoV2-Image-Embeddings-ViT-Giant", + "valueType": { + "$id": "1152", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1143" + }, + "doc": "Facebook-DinoV2-Image-Embeddings-ViT-Giant", + "decorators": [] + }, + { + "$id": "1153", + "kind": "enumvalue", + "name": "CohereEmbedV3English", + "value": "Cohere-embed-v3-english", + "valueType": { + "$id": "1154", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1143" + }, + "doc": "Cohere-embed-v3-english", + "decorators": [] + }, + { + "$id": "1155", + "kind": "enumvalue", + "name": "CohereEmbedV3Multilingual", + "value": "Cohere-embed-v3-multilingual", + "valueType": { + "$id": "1156", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1143" + }, + "doc": "Cohere-embed-v3-multilingual", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The name of the embedding model from the Azure AI Foundry Catalog that will be\ncalled.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1157", + "kind": "enum", + "name": "VectorSearchCompressionRescoreStorageMethod", + "crossLanguageDefinitionId": "Search.VectorSearchCompressionRescoreStorageMethod", + "valueType": { + "$id": "1158", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1159", + "kind": "enumvalue", + "name": "PreserveOriginals", + "value": "preserveOriginals", + "valueType": { + "$id": "1160", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1157" + }, + "doc": "This option preserves the original full-precision vectors. Choose this option\nfor maximum flexibility and highest quality of compressed search results. This\nconsumes more storage but allows for rescoring and oversampling.", + "decorators": [] + }, + { + "$id": "1161", + "kind": "enumvalue", + "name": "DiscardOriginals", + "value": "discardOriginals", + "valueType": { + "$id": "1162", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1157" + }, + "doc": "This option discards the original full-precision vectors. Choose this option\nfor maximum storage savings. Since this option does not allow for rescoring and\noversampling, it will often cause slight to moderate reductions in quality.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The storage method for the original full-precision vectors used for rescoring\nand internal index operations.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1163", + "kind": "enum", + "name": "VectorSearchCompressionKind", + "crossLanguageDefinitionId": "Search.VectorSearchCompressionKind", + "valueType": { + "$id": "1164", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1165", + "kind": "enumvalue", + "name": "ScalarQuantization", + "value": "scalarQuantization", + "valueType": { + "$id": "1166", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1163" + }, + "doc": "Scalar Quantization, a type of compression method. In scalar quantization, the\noriginal vectors values are compressed to a narrower type by discretizing and\nrepresenting each component of a vector using a reduced set of quantized\nvalues, thereby reducing the overall data size.", + "decorators": [] + }, + { + "$id": "1167", + "kind": "enumvalue", + "name": "BinaryQuantization", + "value": "binaryQuantization", + "valueType": { + "$id": "1168", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1163" + }, + "doc": "Binary Quantization, a type of compression method. In binary quantization, the\noriginal vectors values are compressed to the narrower binary type by discretizing\nand representing each component of a vector using binary values,\nthereby reducing the overall data size.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The compression method used for indexing and querying.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1169", + "kind": "enum", + "name": "VectorSearchCompressionTarget", + "crossLanguageDefinitionId": "Search.VectorSearchCompressionTarget", + "valueType": { + "$id": "1170", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1171", + "kind": "enumvalue", + "name": "Int8", + "value": "int8", + "valueType": { + "$id": "1172", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1169" + }, + "doc": "8-bit signed integer.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The quantized data type of compressed vector values.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1173", + "kind": "enum", + "name": "SynonymMap_format", + "valueType": { + "$id": "1174", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1175", + "kind": "enumvalue", + "name": "solr", + "value": "solr", + "doc": "solr", + "valueType": { + "$ref": "1174" + }, + "enumType": { + "$ref": "1173" + } + } + ], + "crossLanguageDefinitionId": "", + "namespace": "Azure.Search.Documents", + "doc": "The SynonymMap_format", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1176", + "kind": "enum", + "name": "KeyPhraseExtractionSkillLanguage", + "crossLanguageDefinitionId": "Search.KeyPhraseExtractionSkillLanguage", + "valueType": { + "$id": "1177", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1178", + "kind": "enumvalue", + "name": "da", + "value": "da", + "valueType": { + "$id": "1179", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "Danish", + "decorators": [] + }, + { + "$id": "1180", + "kind": "enumvalue", + "name": "nl", + "value": "nl", + "valueType": { + "$id": "1181", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "Dutch", + "decorators": [] + }, + { + "$id": "1182", + "kind": "enumvalue", + "name": "en", + "value": "en", + "valueType": { + "$id": "1183", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "English", + "decorators": [] + }, + { + "$id": "1184", + "kind": "enumvalue", + "name": "fi", + "value": "fi", + "valueType": { + "$id": "1185", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "Finnish", + "decorators": [] + }, + { + "$id": "1186", + "kind": "enumvalue", + "name": "fr", + "value": "fr", + "valueType": { + "$id": "1187", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "French", + "decorators": [] + }, + { + "$id": "1188", + "kind": "enumvalue", + "name": "de", + "value": "de", + "valueType": { + "$id": "1189", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "German", + "decorators": [] + }, + { + "$id": "1190", + "kind": "enumvalue", + "name": "it", + "value": "it", + "valueType": { + "$id": "1191", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "Italian", + "decorators": [] + }, + { + "$id": "1192", + "kind": "enumvalue", + "name": "ja", + "value": "ja", + "valueType": { + "$id": "1193", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "Japanese", + "decorators": [] + }, + { + "$id": "1194", + "kind": "enumvalue", + "name": "ko", + "value": "ko", + "valueType": { + "$id": "1195", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "Korean", + "decorators": [] + }, + { + "$id": "1196", + "kind": "enumvalue", + "name": "no", + "value": "no", + "valueType": { + "$id": "1197", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "Norwegian (Bokmaal)", + "decorators": [] + }, + { + "$id": "1198", + "kind": "enumvalue", + "name": "pl", + "value": "pl", + "valueType": { + "$id": "1199", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "Polish", + "decorators": [] + }, + { + "$id": "1200", + "kind": "enumvalue", + "name": "pt-PT", + "value": "pt-PT", + "valueType": { + "$id": "1201", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "Portuguese (Portugal)", + "decorators": [] + }, + { + "$id": "1202", + "kind": "enumvalue", + "name": "pt-BR", + "value": "pt-BR", + "valueType": { + "$id": "1203", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "Portuguese (Brazil)", + "decorators": [] + }, + { + "$id": "1204", + "kind": "enumvalue", + "name": "ru", + "value": "ru", + "valueType": { + "$id": "1205", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "Russian", + "decorators": [] + }, + { + "$id": "1206", + "kind": "enumvalue", + "name": "es", + "value": "es", + "valueType": { + "$id": "1207", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "Spanish", + "decorators": [] + }, + { + "$id": "1208", + "kind": "enumvalue", + "name": "sv", + "value": "sv", + "valueType": { + "$id": "1209", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1176" + }, + "doc": "Swedish", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The language codes supported for input text by KeyPhraseExtractionSkill.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1210", + "kind": "enum", + "name": "OcrSkillLanguage", + "crossLanguageDefinitionId": "Search.OcrSkillLanguage", + "valueType": { + "$id": "1211", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1212", + "kind": "enumvalue", + "name": "af", + "value": "af", + "valueType": { + "$id": "1213", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Afrikaans", + "decorators": [] + }, + { + "$id": "1214", + "kind": "enumvalue", + "name": "sq", + "value": "sq", + "valueType": { + "$id": "1215", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Albanian", + "decorators": [] + }, + { + "$id": "1216", + "kind": "enumvalue", + "name": "anp", + "value": "anp", + "valueType": { + "$id": "1217", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Angika (Devanagiri)", + "decorators": [] + }, + { + "$id": "1218", + "kind": "enumvalue", + "name": "ar", + "value": "ar", + "valueType": { + "$id": "1219", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Arabic", + "decorators": [] + }, + { + "$id": "1220", + "kind": "enumvalue", + "name": "ast", + "value": "ast", + "valueType": { + "$id": "1221", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Asturian", + "decorators": [] + }, + { + "$id": "1222", + "kind": "enumvalue", + "name": "awa", + "value": "awa", + "valueType": { + "$id": "1223", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Awadhi-Hindi (Devanagiri)", + "decorators": [] + }, + { + "$id": "1224", + "kind": "enumvalue", + "name": "az", + "value": "az", + "valueType": { + "$id": "1225", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Azerbaijani (Latin)", + "decorators": [] + }, + { + "$id": "1226", + "kind": "enumvalue", + "name": "bfy", + "value": "bfy", + "valueType": { + "$id": "1227", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Bagheli", + "decorators": [] + }, + { + "$id": "1228", + "kind": "enumvalue", + "name": "eu", + "value": "eu", + "valueType": { + "$id": "1229", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Basque", + "decorators": [] + }, + { + "$id": "1230", + "kind": "enumvalue", + "name": "be", + "value": "be", + "valueType": { + "$id": "1231", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Belarusian (Cyrillic and Latin)", + "decorators": [] + }, + { + "$id": "1232", + "kind": "enumvalue", + "name": "be-cyrl", + "value": "be-cyrl", + "valueType": { + "$id": "1233", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Belarusian (Cyrillic)", + "decorators": [] + }, + { + "$id": "1234", + "kind": "enumvalue", + "name": "be-latn", + "value": "be-latn", + "valueType": { + "$id": "1235", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Belarusian (Latin)", + "decorators": [] + }, + { + "$id": "1236", + "kind": "enumvalue", + "name": "bho", + "value": "bho", + "valueType": { + "$id": "1237", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Bhojpuri-Hindi (Devanagiri)", + "decorators": [] + }, + { + "$id": "1238", + "kind": "enumvalue", + "name": "bi", + "value": "bi", + "valueType": { + "$id": "1239", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Bislama", + "decorators": [] + }, + { + "$id": "1240", + "kind": "enumvalue", + "name": "brx", + "value": "brx", + "valueType": { + "$id": "1241", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Bodo (Devanagiri)", + "decorators": [] + }, + { + "$id": "1242", + "kind": "enumvalue", + "name": "bs", + "value": "bs", + "valueType": { + "$id": "1243", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Bosnian Latin", + "decorators": [] + }, + { + "$id": "1244", + "kind": "enumvalue", + "name": "bra", + "value": "bra", + "valueType": { + "$id": "1245", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Brajbha", + "decorators": [] + }, + { + "$id": "1246", + "kind": "enumvalue", + "name": "br", + "value": "br", + "valueType": { + "$id": "1247", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Breton", + "decorators": [] + }, + { + "$id": "1248", + "kind": "enumvalue", + "name": "bg", + "value": "bg", + "valueType": { + "$id": "1249", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Bulgarian", + "decorators": [] + }, + { + "$id": "1250", + "kind": "enumvalue", + "name": "bns", + "value": "bns", + "valueType": { + "$id": "1251", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Bundeli", + "decorators": [] + }, + { + "$id": "1252", + "kind": "enumvalue", + "name": "bua", + "value": "bua", + "valueType": { + "$id": "1253", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Buryat (Cyrillic)", + "decorators": [] + }, + { + "$id": "1254", + "kind": "enumvalue", + "name": "ca", + "value": "ca", + "valueType": { + "$id": "1255", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Catalan", + "decorators": [] + }, + { + "$id": "1256", + "kind": "enumvalue", + "name": "ceb", + "value": "ceb", + "valueType": { + "$id": "1257", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Cebuano", + "decorators": [] + }, + { + "$id": "1258", + "kind": "enumvalue", + "name": "rab", + "value": "rab", + "valueType": { + "$id": "1259", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Chamling", + "decorators": [] + }, + { + "$id": "1260", + "kind": "enumvalue", + "name": "ch", + "value": "ch", + "valueType": { + "$id": "1261", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Chamorro", + "decorators": [] + }, + { + "$id": "1262", + "kind": "enumvalue", + "name": "hne", + "value": "hne", + "valueType": { + "$id": "1263", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Chhattisgarhi (Devanagiri)", + "decorators": [] + }, + { + "$id": "1264", + "kind": "enumvalue", + "name": "zh-Hans", + "value": "zh-Hans", + "valueType": { + "$id": "1265", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Chinese Simplified", + "decorators": [] + }, + { + "$id": "1266", + "kind": "enumvalue", + "name": "zh-Hant", + "value": "zh-Hant", + "valueType": { + "$id": "1267", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Chinese Traditional", + "decorators": [] + }, + { + "$id": "1268", + "kind": "enumvalue", + "name": "kw", + "value": "kw", + "valueType": { + "$id": "1269", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Cornish", + "decorators": [] + }, + { + "$id": "1270", + "kind": "enumvalue", + "name": "co", + "value": "co", + "valueType": { + "$id": "1271", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Corsican", + "decorators": [] + }, + { + "$id": "1272", + "kind": "enumvalue", + "name": "crh", + "value": "crh", + "valueType": { + "$id": "1273", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Crimean Tatar (Latin)", + "decorators": [] + }, + { + "$id": "1274", + "kind": "enumvalue", + "name": "hr", + "value": "hr", + "valueType": { + "$id": "1275", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Croatian", + "decorators": [] + }, + { + "$id": "1276", + "kind": "enumvalue", + "name": "cs", + "value": "cs", + "valueType": { + "$id": "1277", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Czech", + "decorators": [] + }, + { + "$id": "1278", + "kind": "enumvalue", + "name": "da", + "value": "da", + "valueType": { + "$id": "1279", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Danish", + "decorators": [] + }, + { + "$id": "1280", + "kind": "enumvalue", + "name": "prs", + "value": "prs", + "valueType": { + "$id": "1281", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Dari", + "decorators": [] + }, + { + "$id": "1282", + "kind": "enumvalue", + "name": "dhi", + "value": "dhi", + "valueType": { + "$id": "1283", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Dhimal (Devanagiri)", + "decorators": [] + }, + { + "$id": "1284", + "kind": "enumvalue", + "name": "doi", + "value": "doi", + "valueType": { + "$id": "1285", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Dogri (Devanagiri)", + "decorators": [] + }, + { + "$id": "1286", + "kind": "enumvalue", + "name": "nl", + "value": "nl", + "valueType": { + "$id": "1287", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Dutch", + "decorators": [] + }, + { + "$id": "1288", + "kind": "enumvalue", + "name": "en", + "value": "en", + "valueType": { + "$id": "1289", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "English", + "decorators": [] + }, + { + "$id": "1290", + "kind": "enumvalue", + "name": "myv", + "value": "myv", + "valueType": { + "$id": "1291", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Erzya (Cyrillic)", + "decorators": [] + }, + { + "$id": "1292", + "kind": "enumvalue", + "name": "et", + "value": "et", + "valueType": { + "$id": "1293", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Estonian", + "decorators": [] + }, + { + "$id": "1294", + "kind": "enumvalue", + "name": "fo", + "value": "fo", + "valueType": { + "$id": "1295", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Faroese", + "decorators": [] + }, + { + "$id": "1296", + "kind": "enumvalue", + "name": "fj", + "value": "fj", + "valueType": { + "$id": "1297", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Fijian", + "decorators": [] + }, + { + "$id": "1298", + "kind": "enumvalue", + "name": "fil", + "value": "fil", + "valueType": { + "$id": "1299", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Filipino", + "decorators": [] + }, + { + "$id": "1300", + "kind": "enumvalue", + "name": "fi", + "value": "fi", + "valueType": { + "$id": "1301", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Finnish", + "decorators": [] + }, + { + "$id": "1302", + "kind": "enumvalue", + "name": "fr", + "value": "fr", + "valueType": { + "$id": "1303", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "French", + "decorators": [] + }, + { + "$id": "1304", + "kind": "enumvalue", + "name": "fur", + "value": "fur", + "valueType": { + "$id": "1305", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Frulian", + "decorators": [] + }, + { + "$id": "1306", + "kind": "enumvalue", + "name": "gag", + "value": "gag", + "valueType": { + "$id": "1307", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Gagauz (Latin)", + "decorators": [] + }, + { + "$id": "1308", + "kind": "enumvalue", + "name": "gl", + "value": "gl", + "valueType": { + "$id": "1309", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Galician", + "decorators": [] + }, + { + "$id": "1310", + "kind": "enumvalue", + "name": "de", + "value": "de", + "valueType": { + "$id": "1311", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "German", + "decorators": [] + }, + { + "$id": "1312", + "kind": "enumvalue", + "name": "gil", + "value": "gil", + "valueType": { + "$id": "1313", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Gilbertese", + "decorators": [] + }, + { + "$id": "1314", + "kind": "enumvalue", + "name": "gon", + "value": "gon", + "valueType": { + "$id": "1315", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Gondi (Devanagiri)", + "decorators": [] + }, + { + "$id": "1316", + "kind": "enumvalue", + "name": "el", + "value": "el", + "valueType": { + "$id": "1317", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Greek", + "decorators": [] + }, + { + "$id": "1318", + "kind": "enumvalue", + "name": "kl", + "value": "kl", + "valueType": { + "$id": "1319", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Greenlandic", + "decorators": [] + }, + { + "$id": "1320", + "kind": "enumvalue", + "name": "gvr", + "value": "gvr", + "valueType": { + "$id": "1321", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Gurung (Devanagiri)", + "decorators": [] + }, + { + "$id": "1322", + "kind": "enumvalue", + "name": "ht", + "value": "ht", + "valueType": { + "$id": "1323", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Haitian Creole", + "decorators": [] + }, + { + "$id": "1324", + "kind": "enumvalue", + "name": "hlb", + "value": "hlb", + "valueType": { + "$id": "1325", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Halbi (Devanagiri)", + "decorators": [] + }, + { + "$id": "1326", + "kind": "enumvalue", + "name": "hni", + "value": "hni", + "valueType": { + "$id": "1327", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Hani", + "decorators": [] + }, + { + "$id": "1328", + "kind": "enumvalue", + "name": "bgc", + "value": "bgc", + "valueType": { + "$id": "1329", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Haryanvi", + "decorators": [] + }, + { + "$id": "1330", + "kind": "enumvalue", + "name": "haw", + "value": "haw", + "valueType": { + "$id": "1331", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Hawaiian", + "decorators": [] + }, + { + "$id": "1332", + "kind": "enumvalue", + "name": "hi", + "value": "hi", + "valueType": { + "$id": "1333", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Hindi", + "decorators": [] + }, + { + "$id": "1334", + "kind": "enumvalue", + "name": "mww", + "value": "mww", + "valueType": { + "$id": "1335", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Hmong Daw (Latin)", + "decorators": [] + }, + { + "$id": "1336", + "kind": "enumvalue", + "name": "hoc", + "value": "hoc", + "valueType": { + "$id": "1337", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Ho (Devanagiri)", + "decorators": [] + }, + { + "$id": "1338", + "kind": "enumvalue", + "name": "hu", + "value": "hu", + "valueType": { + "$id": "1339", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Hungarian", + "decorators": [] + }, + { + "$id": "1340", + "kind": "enumvalue", + "name": "is", + "value": "is", + "valueType": { + "$id": "1341", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Icelandic", + "decorators": [] + }, + { + "$id": "1342", + "kind": "enumvalue", + "name": "smn", + "value": "smn", + "valueType": { + "$id": "1343", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Inari Sami", + "decorators": [] + }, + { + "$id": "1344", + "kind": "enumvalue", + "name": "id", + "value": "id", + "valueType": { + "$id": "1345", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Indonesian", + "decorators": [] + }, + { + "$id": "1346", + "kind": "enumvalue", + "name": "ia", + "value": "ia", + "valueType": { + "$id": "1347", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Interlingua", + "decorators": [] + }, + { + "$id": "1348", + "kind": "enumvalue", + "name": "iu", + "value": "iu", + "valueType": { + "$id": "1349", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Inuktitut (Latin)", + "decorators": [] + }, + { + "$id": "1350", + "kind": "enumvalue", + "name": "ga", + "value": "ga", + "valueType": { + "$id": "1351", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Irish", + "decorators": [] + }, + { + "$id": "1352", + "kind": "enumvalue", + "name": "it", + "value": "it", + "valueType": { + "$id": "1353", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Italian", + "decorators": [] + }, + { + "$id": "1354", + "kind": "enumvalue", + "name": "ja", + "value": "ja", + "valueType": { + "$id": "1355", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Japanese", + "decorators": [] + }, + { + "$id": "1356", + "kind": "enumvalue", + "name": "Jns", + "value": "Jns", + "valueType": { + "$id": "1357", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Jaunsari (Devanagiri)", + "decorators": [] + }, + { + "$id": "1358", + "kind": "enumvalue", + "name": "jv", + "value": "jv", + "valueType": { + "$id": "1359", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Javanese", + "decorators": [] + }, + { + "$id": "1360", + "kind": "enumvalue", + "name": "kea", + "value": "kea", + "valueType": { + "$id": "1361", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Kabuverdianu", + "decorators": [] + }, + { + "$id": "1362", + "kind": "enumvalue", + "name": "kac", + "value": "kac", + "valueType": { + "$id": "1363", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Kachin (Latin)", + "decorators": [] + }, + { + "$id": "1364", + "kind": "enumvalue", + "name": "xnr", + "value": "xnr", + "valueType": { + "$id": "1365", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Kangri (Devanagiri)", + "decorators": [] + }, + { + "$id": "1366", + "kind": "enumvalue", + "name": "krc", + "value": "krc", + "valueType": { + "$id": "1367", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Karachay-Balkar", + "decorators": [] + }, + { + "$id": "1368", + "kind": "enumvalue", + "name": "kaa-cyrl", + "value": "kaa-cyrl", + "valueType": { + "$id": "1369", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Kara-Kalpak (Cyrillic)", + "decorators": [] + }, + { + "$id": "1370", + "kind": "enumvalue", + "name": "kaa", + "value": "kaa", + "valueType": { + "$id": "1371", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Kara-Kalpak (Latin)", + "decorators": [] + }, + { + "$id": "1372", + "kind": "enumvalue", + "name": "csb", + "value": "csb", + "valueType": { + "$id": "1373", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Kashubian", + "decorators": [] + }, + { + "$id": "1374", + "kind": "enumvalue", + "name": "kk-cyrl", + "value": "kk-cyrl", + "valueType": { + "$id": "1375", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Kazakh (Cyrillic)", + "decorators": [] + }, + { + "$id": "1376", + "kind": "enumvalue", + "name": "kk-latn", + "value": "kk-latn", + "valueType": { + "$id": "1377", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Kazakh (Latin)", + "decorators": [] + }, + { + "$id": "1378", + "kind": "enumvalue", + "name": "klr", + "value": "klr", + "valueType": { + "$id": "1379", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Khaling", + "decorators": [] + }, + { + "$id": "1380", + "kind": "enumvalue", + "name": "kha", + "value": "kha", + "valueType": { + "$id": "1381", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Khasi", + "decorators": [] + }, + { + "$id": "1382", + "kind": "enumvalue", + "name": "quc", + "value": "quc", + "valueType": { + "$id": "1383", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "K'iche'", + "decorators": [] + }, + { + "$id": "1384", + "kind": "enumvalue", + "name": "ko", + "value": "ko", + "valueType": { + "$id": "1385", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Korean", + "decorators": [] + }, + { + "$id": "1386", + "kind": "enumvalue", + "name": "kfq", + "value": "kfq", + "valueType": { + "$id": "1387", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Korku", + "decorators": [] + }, + { + "$id": "1388", + "kind": "enumvalue", + "name": "kpy", + "value": "kpy", + "valueType": { + "$id": "1389", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Koryak", + "decorators": [] + }, + { + "$id": "1390", + "kind": "enumvalue", + "name": "kos", + "value": "kos", + "valueType": { + "$id": "1391", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Kosraean", + "decorators": [] + }, + { + "$id": "1392", + "kind": "enumvalue", + "name": "kum", + "value": "kum", + "valueType": { + "$id": "1393", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Kumyk (Cyrillic)", + "decorators": [] + }, + { + "$id": "1394", + "kind": "enumvalue", + "name": "ku-arab", + "value": "ku-arab", + "valueType": { + "$id": "1395", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Kurdish (Arabic)", + "decorators": [] + }, + { + "$id": "1396", + "kind": "enumvalue", + "name": "ku-latn", + "value": "ku-latn", + "valueType": { + "$id": "1397", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Kurdish (Latin)", + "decorators": [] + }, + { + "$id": "1398", + "kind": "enumvalue", + "name": "kru", + "value": "kru", + "valueType": { + "$id": "1399", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Kurukh (Devanagiri)", + "decorators": [] + }, + { + "$id": "1400", + "kind": "enumvalue", + "name": "ky", + "value": "ky", + "valueType": { + "$id": "1401", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Kyrgyz (Cyrillic)", + "decorators": [] + }, + { + "$id": "1402", + "kind": "enumvalue", + "name": "lkt", + "value": "lkt", + "valueType": { + "$id": "1403", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Lakota", + "decorators": [] + }, + { + "$id": "1404", + "kind": "enumvalue", + "name": "la", + "value": "la", + "valueType": { + "$id": "1405", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Latin", + "decorators": [] + }, + { + "$id": "1406", + "kind": "enumvalue", + "name": "lt", + "value": "lt", + "valueType": { + "$id": "1407", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Lithuanian", + "decorators": [] + }, + { + "$id": "1408", + "kind": "enumvalue", + "name": "dsb", + "value": "dsb", + "valueType": { + "$id": "1409", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Lower Sorbian", + "decorators": [] + }, + { + "$id": "1410", + "kind": "enumvalue", + "name": "smj", + "value": "smj", + "valueType": { + "$id": "1411", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Lule Sami", + "decorators": [] + }, + { + "$id": "1412", + "kind": "enumvalue", + "name": "lb", + "value": "lb", + "valueType": { + "$id": "1413", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Luxembourgish", + "decorators": [] + }, + { + "$id": "1414", + "kind": "enumvalue", + "name": "bfz", + "value": "bfz", + "valueType": { + "$id": "1415", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Mahasu Pahari (Devanagiri)", + "decorators": [] + }, + { + "$id": "1416", + "kind": "enumvalue", + "name": "ms", + "value": "ms", + "valueType": { + "$id": "1417", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Malay (Latin)", + "decorators": [] + }, + { + "$id": "1418", + "kind": "enumvalue", + "name": "mt", + "value": "mt", + "valueType": { + "$id": "1419", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Maltese", + "decorators": [] + }, + { + "$id": "1420", + "kind": "enumvalue", + "name": "kmj", + "value": "kmj", + "valueType": { + "$id": "1421", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Malto (Devanagiri)", + "decorators": [] + }, + { + "$id": "1422", + "kind": "enumvalue", + "name": "gv", + "value": "gv", + "valueType": { + "$id": "1423", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Manx", + "decorators": [] + }, + { + "$id": "1424", + "kind": "enumvalue", + "name": "mi", + "value": "mi", + "valueType": { + "$id": "1425", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Maori", + "decorators": [] + }, + { + "$id": "1426", + "kind": "enumvalue", + "name": "mr", + "value": "mr", + "valueType": { + "$id": "1427", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Marathi", + "decorators": [] + }, + { + "$id": "1428", + "kind": "enumvalue", + "name": "mn", + "value": "mn", + "valueType": { + "$id": "1429", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Mongolian (Cyrillic)", + "decorators": [] + }, + { + "$id": "1430", + "kind": "enumvalue", + "name": "cnr-cyrl", + "value": "cnr-cyrl", + "valueType": { + "$id": "1431", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Montenegrin (Cyrillic)", + "decorators": [] + }, + { + "$id": "1432", + "kind": "enumvalue", + "name": "cnr-latn", + "value": "cnr-latn", + "valueType": { + "$id": "1433", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Montenegrin (Latin)", + "decorators": [] + }, + { + "$id": "1434", + "kind": "enumvalue", + "name": "nap", + "value": "nap", + "valueType": { + "$id": "1435", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Neapolitan", + "decorators": [] + }, + { + "$id": "1436", + "kind": "enumvalue", + "name": "ne", + "value": "ne", + "valueType": { + "$id": "1437", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Nepali", + "decorators": [] + }, + { + "$id": "1438", + "kind": "enumvalue", + "name": "niu", + "value": "niu", + "valueType": { + "$id": "1439", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Niuean", + "decorators": [] + }, + { + "$id": "1440", + "kind": "enumvalue", + "name": "nog", + "value": "nog", + "valueType": { + "$id": "1441", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Nogay", + "decorators": [] + }, + { + "$id": "1442", + "kind": "enumvalue", + "name": "sme", + "value": "sme", + "valueType": { + "$id": "1443", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Northern Sami (Latin)", + "decorators": [] + }, + { + "$id": "1444", + "kind": "enumvalue", + "name": "nb", + "value": "nb", + "valueType": { + "$id": "1445", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Norwegian", + "decorators": [] + }, + { + "$id": "1446", + "kind": "enumvalue", + "name": "no", + "value": "no", + "valueType": { + "$id": "1447", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Norwegian", + "decorators": [] + }, + { + "$id": "1448", + "kind": "enumvalue", + "name": "oc", + "value": "oc", + "valueType": { + "$id": "1449", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Occitan", + "decorators": [] + }, + { + "$id": "1450", + "kind": "enumvalue", + "name": "os", + "value": "os", + "valueType": { + "$id": "1451", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Ossetic", + "decorators": [] + }, + { + "$id": "1452", + "kind": "enumvalue", + "name": "ps", + "value": "ps", + "valueType": { + "$id": "1453", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Pashto", + "decorators": [] + }, + { + "$id": "1454", + "kind": "enumvalue", + "name": "fa", + "value": "fa", + "valueType": { + "$id": "1455", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Persian", + "decorators": [] + }, + { + "$id": "1456", + "kind": "enumvalue", + "name": "pl", + "value": "pl", + "valueType": { + "$id": "1457", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Polish", + "decorators": [] + }, + { + "$id": "1458", + "kind": "enumvalue", + "name": "pt", + "value": "pt", + "valueType": { + "$id": "1459", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Portuguese", + "decorators": [] + }, + { + "$id": "1460", + "kind": "enumvalue", + "name": "pa", + "value": "pa", + "valueType": { + "$id": "1461", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Punjabi (Arabic)", + "decorators": [] + }, + { + "$id": "1462", + "kind": "enumvalue", + "name": "ksh", + "value": "ksh", + "valueType": { + "$id": "1463", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Ripuarian", + "decorators": [] + }, + { + "$id": "1464", + "kind": "enumvalue", + "name": "ro", + "value": "ro", + "valueType": { + "$id": "1465", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Romanian", + "decorators": [] + }, + { + "$id": "1466", + "kind": "enumvalue", + "name": "rm", + "value": "rm", + "valueType": { + "$id": "1467", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Romansh", + "decorators": [] + }, + { + "$id": "1468", + "kind": "enumvalue", + "name": "ru", + "value": "ru", + "valueType": { + "$id": "1469", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Russian", + "decorators": [] + }, + { + "$id": "1470", + "kind": "enumvalue", + "name": "sck", + "value": "sck", + "valueType": { + "$id": "1471", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Sadri (Devanagiri)", + "decorators": [] + }, + { + "$id": "1472", + "kind": "enumvalue", + "name": "sm", + "value": "sm", + "valueType": { + "$id": "1473", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Samoan (Latin)", + "decorators": [] + }, + { + "$id": "1474", + "kind": "enumvalue", + "name": "sa", + "value": "sa", + "valueType": { + "$id": "1475", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Sanskrit (Devanagiri)", + "decorators": [] + }, + { + "$id": "1476", + "kind": "enumvalue", + "name": "sat", + "value": "sat", + "valueType": { + "$id": "1477", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Santali (Devanagiri)", + "decorators": [] + }, + { + "$id": "1478", + "kind": "enumvalue", + "name": "sco", + "value": "sco", + "valueType": { + "$id": "1479", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Scots", + "decorators": [] + }, + { + "$id": "1480", + "kind": "enumvalue", + "name": "gd", + "value": "gd", + "valueType": { + "$id": "1481", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Scottish Gaelic", + "decorators": [] + }, + { + "$id": "1482", + "kind": "enumvalue", + "name": "sr", + "value": "sr", + "valueType": { + "$id": "1483", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Serbian (Latin)", + "decorators": [] + }, + { + "$id": "1484", + "kind": "enumvalue", + "name": "sr-Cyrl", + "value": "sr-Cyrl", + "valueType": { + "$id": "1485", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Serbian (Cyrillic)", + "decorators": [] + }, + { + "$id": "1486", + "kind": "enumvalue", + "name": "sr-Latn", + "value": "sr-Latn", + "valueType": { + "$id": "1487", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Serbian (Latin)", + "decorators": [] + }, + { + "$id": "1488", + "kind": "enumvalue", + "name": "xsr", + "value": "xsr", + "valueType": { + "$id": "1489", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Sherpa (Devanagiri)", + "decorators": [] + }, + { + "$id": "1490", + "kind": "enumvalue", + "name": "srx", + "value": "srx", + "valueType": { + "$id": "1491", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Sirmauri (Devanagiri)", + "decorators": [] + }, + { + "$id": "1492", + "kind": "enumvalue", + "name": "sms", + "value": "sms", + "valueType": { + "$id": "1493", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Skolt Sami", + "decorators": [] + }, + { + "$id": "1494", + "kind": "enumvalue", + "name": "sk", + "value": "sk", + "valueType": { + "$id": "1495", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Slovak", + "decorators": [] + }, + { + "$id": "1496", + "kind": "enumvalue", + "name": "sl", + "value": "sl", + "valueType": { + "$id": "1497", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Slovenian", + "decorators": [] + }, + { + "$id": "1498", + "kind": "enumvalue", + "name": "so", + "value": "so", + "valueType": { + "$id": "1499", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Somali (Arabic)", + "decorators": [] + }, + { + "$id": "1500", + "kind": "enumvalue", + "name": "sma", + "value": "sma", + "valueType": { + "$id": "1501", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Southern Sami", + "decorators": [] + }, + { + "$id": "1502", + "kind": "enumvalue", + "name": "es", + "value": "es", + "valueType": { + "$id": "1503", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Spanish", + "decorators": [] + }, + { + "$id": "1504", + "kind": "enumvalue", + "name": "sw", + "value": "sw", + "valueType": { + "$id": "1505", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Swahili (Latin)", + "decorators": [] + }, + { + "$id": "1506", + "kind": "enumvalue", + "name": "sv", + "value": "sv", + "valueType": { + "$id": "1507", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Swedish", + "decorators": [] + }, + { + "$id": "1508", + "kind": "enumvalue", + "name": "tg", + "value": "tg", + "valueType": { + "$id": "1509", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Tajik (Cyrillic)", + "decorators": [] + }, + { + "$id": "1510", + "kind": "enumvalue", + "name": "tt", + "value": "tt", + "valueType": { + "$id": "1511", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Tatar (Latin)", + "decorators": [] + }, + { + "$id": "1512", + "kind": "enumvalue", + "name": "tet", + "value": "tet", + "valueType": { + "$id": "1513", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Tetum", + "decorators": [] + }, + { + "$id": "1514", + "kind": "enumvalue", + "name": "thf", + "value": "thf", + "valueType": { + "$id": "1515", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Thangmi", + "decorators": [] + }, + { + "$id": "1516", + "kind": "enumvalue", + "name": "to", + "value": "to", + "valueType": { + "$id": "1517", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Tongan", + "decorators": [] + }, + { + "$id": "1518", + "kind": "enumvalue", + "name": "tr", + "value": "tr", + "valueType": { + "$id": "1519", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Turkish", + "decorators": [] + }, + { + "$id": "1520", + "kind": "enumvalue", + "name": "tk", + "value": "tk", + "valueType": { + "$id": "1521", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Turkmen (Latin)", + "decorators": [] + }, + { + "$id": "1522", + "kind": "enumvalue", + "name": "tyv", + "value": "tyv", + "valueType": { + "$id": "1523", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Tuvan", + "decorators": [] + }, + { + "$id": "1524", + "kind": "enumvalue", + "name": "hsb", + "value": "hsb", + "valueType": { + "$id": "1525", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Upper Sorbian", + "decorators": [] + }, + { + "$id": "1526", + "kind": "enumvalue", + "name": "ur", + "value": "ur", + "valueType": { + "$id": "1527", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Urdu", + "decorators": [] + }, + { + "$id": "1528", + "kind": "enumvalue", + "name": "ug", + "value": "ug", + "valueType": { + "$id": "1529", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Uyghur (Arabic)", + "decorators": [] + }, + { + "$id": "1530", + "kind": "enumvalue", + "name": "uz-arab", + "value": "uz-arab", + "valueType": { + "$id": "1531", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Uzbek (Arabic)", + "decorators": [] + }, + { + "$id": "1532", + "kind": "enumvalue", + "name": "uz-cyrl", + "value": "uz-cyrl", + "valueType": { + "$id": "1533", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Uzbek (Cyrillic)", + "decorators": [] + }, + { + "$id": "1534", + "kind": "enumvalue", + "name": "uz", + "value": "uz", + "valueType": { + "$id": "1535", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Uzbek (Latin)", + "decorators": [] + }, + { + "$id": "1536", + "kind": "enumvalue", + "name": "vo", + "value": "vo", + "valueType": { + "$id": "1537", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Volapük", + "decorators": [] + }, + { + "$id": "1538", + "kind": "enumvalue", + "name": "wae", + "value": "wae", + "valueType": { + "$id": "1539", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Walser", + "decorators": [] + }, + { + "$id": "1540", + "kind": "enumvalue", + "name": "cy", + "value": "cy", + "valueType": { + "$id": "1541", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Welsh", + "decorators": [] + }, + { + "$id": "1542", + "kind": "enumvalue", + "name": "fy", + "value": "fy", + "valueType": { + "$id": "1543", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Western Frisian", + "decorators": [] + }, + { + "$id": "1544", + "kind": "enumvalue", + "name": "yua", + "value": "yua", + "valueType": { + "$id": "1545", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Yucatec Maya", + "decorators": [] + }, + { + "$id": "1546", + "kind": "enumvalue", + "name": "za", + "value": "za", + "valueType": { + "$id": "1547", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Zhuang", + "decorators": [] + }, + { + "$id": "1548", + "kind": "enumvalue", + "name": "zu", + "value": "zu", + "valueType": { + "$id": "1549", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Zulu", + "decorators": [] + }, + { + "$id": "1550", + "kind": "enumvalue", + "name": "unk", + "value": "unk", + "valueType": { + "$id": "1551", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1210" + }, + "doc": "Unknown (All)", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The language codes supported for input by OcrSkill.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1552", + "kind": "enum", + "name": "OcrLineEnding", + "crossLanguageDefinitionId": "Search.OcrLineEnding", + "valueType": { + "$id": "1553", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1554", + "kind": "enumvalue", + "name": "Space", + "value": "space", + "valueType": { + "$id": "1555", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1552" + }, + "doc": "Lines are separated by a single space character.", + "decorators": [] + }, + { + "$id": "1556", + "kind": "enumvalue", + "name": "CarriageReturn", + "value": "carriageReturn", + "valueType": { + "$id": "1557", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1552" + }, + "doc": "Lines are separated by a carriage return ('\\r') character.", + "decorators": [] + }, + { + "$id": "1558", + "kind": "enumvalue", + "name": "LineFeed", + "value": "lineFeed", + "valueType": { + "$id": "1559", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1552" + }, + "doc": "Lines are separated by a single line feed ('\\n') character.", + "decorators": [] + }, + { + "$id": "1560", + "kind": "enumvalue", + "name": "CarriageReturnLineFeed", + "value": "carriageReturnLineFeed", + "valueType": { + "$id": "1561", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1552" + }, + "doc": "Lines are separated by a carriage return and a line feed ('\\r\\n') character.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Defines the sequence of characters to use between the lines of text recognized\nby the OCR skill. The default value is \"space\".", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1562", + "kind": "enum", + "name": "ImageAnalysisSkillLanguage", + "crossLanguageDefinitionId": "Search.ImageAnalysisSkillLanguage", + "valueType": { + "$id": "1563", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1564", + "kind": "enumvalue", + "name": "ar", + "value": "ar", + "valueType": { + "$id": "1565", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Arabic", + "decorators": [] + }, + { + "$id": "1566", + "kind": "enumvalue", + "name": "az", + "value": "az", + "valueType": { + "$id": "1567", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Azerbaijani", + "decorators": [] + }, + { + "$id": "1568", + "kind": "enumvalue", + "name": "bg", + "value": "bg", + "valueType": { + "$id": "1569", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Bulgarian", + "decorators": [] + }, + { + "$id": "1570", + "kind": "enumvalue", + "name": "bs", + "value": "bs", + "valueType": { + "$id": "1571", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Bosnian Latin", + "decorators": [] + }, + { + "$id": "1572", + "kind": "enumvalue", + "name": "ca", + "value": "ca", + "valueType": { + "$id": "1573", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Catalan", + "decorators": [] + }, + { + "$id": "1574", + "kind": "enumvalue", + "name": "cs", + "value": "cs", + "valueType": { + "$id": "1575", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Czech", + "decorators": [] + }, + { + "$id": "1576", + "kind": "enumvalue", + "name": "cy", + "value": "cy", + "valueType": { + "$id": "1577", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Welsh", + "decorators": [] + }, + { + "$id": "1578", + "kind": "enumvalue", + "name": "da", + "value": "da", + "valueType": { + "$id": "1579", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Danish", + "decorators": [] + }, + { + "$id": "1580", + "kind": "enumvalue", + "name": "de", + "value": "de", + "valueType": { + "$id": "1581", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "German", + "decorators": [] + }, + { + "$id": "1582", + "kind": "enumvalue", + "name": "el", + "value": "el", + "valueType": { + "$id": "1583", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Greek", + "decorators": [] + }, + { + "$id": "1584", + "kind": "enumvalue", + "name": "en", + "value": "en", + "valueType": { + "$id": "1585", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "English", + "decorators": [] + }, + { + "$id": "1586", + "kind": "enumvalue", + "name": "es", + "value": "es", + "valueType": { + "$id": "1587", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Spanish", + "decorators": [] + }, + { + "$id": "1588", + "kind": "enumvalue", + "name": "et", + "value": "et", + "valueType": { + "$id": "1589", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Estonian", + "decorators": [] + }, + { + "$id": "1590", + "kind": "enumvalue", + "name": "eu", + "value": "eu", + "valueType": { + "$id": "1591", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Basque", + "decorators": [] + }, + { + "$id": "1592", + "kind": "enumvalue", + "name": "fi", + "value": "fi", + "valueType": { + "$id": "1593", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Finnish", + "decorators": [] + }, + { + "$id": "1594", + "kind": "enumvalue", + "name": "fr", + "value": "fr", + "valueType": { + "$id": "1595", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "French", + "decorators": [] + }, + { + "$id": "1596", + "kind": "enumvalue", + "name": "ga", + "value": "ga", + "valueType": { + "$id": "1597", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Irish", + "decorators": [] + }, + { + "$id": "1598", + "kind": "enumvalue", + "name": "gl", + "value": "gl", + "valueType": { + "$id": "1599", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Galician", + "decorators": [] + }, + { + "$id": "1600", + "kind": "enumvalue", + "name": "he", + "value": "he", + "valueType": { + "$id": "1601", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Hebrew", + "decorators": [] + }, + { + "$id": "1602", + "kind": "enumvalue", + "name": "hi", + "value": "hi", + "valueType": { + "$id": "1603", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Hindi", + "decorators": [] + }, + { + "$id": "1604", + "kind": "enumvalue", + "name": "hr", + "value": "hr", + "valueType": { + "$id": "1605", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Croatian", + "decorators": [] + }, + { + "$id": "1606", + "kind": "enumvalue", + "name": "hu", + "value": "hu", + "valueType": { + "$id": "1607", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Hungarian", + "decorators": [] + }, + { + "$id": "1608", + "kind": "enumvalue", + "name": "id", + "value": "id", + "valueType": { + "$id": "1609", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Indonesian", + "decorators": [] + }, + { + "$id": "1610", + "kind": "enumvalue", + "name": "it", + "value": "it", + "valueType": { + "$id": "1611", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Italian", + "decorators": [] + }, + { + "$id": "1612", + "kind": "enumvalue", + "name": "ja", + "value": "ja", + "valueType": { + "$id": "1613", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Japanese", + "decorators": [] + }, + { + "$id": "1614", + "kind": "enumvalue", + "name": "kk", + "value": "kk", + "valueType": { + "$id": "1615", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Kazakh", + "decorators": [] + }, + { + "$id": "1616", + "kind": "enumvalue", + "name": "ko", + "value": "ko", + "valueType": { + "$id": "1617", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Korean", + "decorators": [] + }, + { + "$id": "1618", + "kind": "enumvalue", + "name": "lt", + "value": "lt", + "valueType": { + "$id": "1619", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Lithuanian", + "decorators": [] + }, + { + "$id": "1620", + "kind": "enumvalue", + "name": "lv", + "value": "lv", + "valueType": { + "$id": "1621", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Latvian", + "decorators": [] + }, + { + "$id": "1622", + "kind": "enumvalue", + "name": "mk", + "value": "mk", + "valueType": { + "$id": "1623", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Macedonian", + "decorators": [] + }, + { + "$id": "1624", + "kind": "enumvalue", + "name": "ms", + "value": "ms", + "valueType": { + "$id": "1625", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Malay Malaysia", + "decorators": [] + }, + { + "$id": "1626", + "kind": "enumvalue", + "name": "nb", + "value": "nb", + "valueType": { + "$id": "1627", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Norwegian (Bokmal)", + "decorators": [] + }, + { + "$id": "1628", + "kind": "enumvalue", + "name": "nl", + "value": "nl", + "valueType": { + "$id": "1629", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Dutch", + "decorators": [] + }, + { + "$id": "1630", + "kind": "enumvalue", + "name": "pl", + "value": "pl", + "valueType": { + "$id": "1631", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Polish", + "decorators": [] + }, + { + "$id": "1632", + "kind": "enumvalue", + "name": "prs", + "value": "prs", + "valueType": { + "$id": "1633", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Dari", + "decorators": [] + }, + { + "$id": "1634", + "kind": "enumvalue", + "name": "pt-BR", + "value": "pt-BR", + "valueType": { + "$id": "1635", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Portuguese-Brazil", + "decorators": [] + }, + { + "$id": "1636", + "kind": "enumvalue", + "name": "pt", + "value": "pt", + "valueType": { + "$id": "1637", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Portuguese-Portugal", + "decorators": [] + }, + { + "$id": "1638", + "kind": "enumvalue", + "name": "pt-PT", + "value": "pt-PT", + "valueType": { + "$id": "1639", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Portuguese-Portugal", + "decorators": [] + }, + { + "$id": "1640", + "kind": "enumvalue", + "name": "ro", + "value": "ro", + "valueType": { + "$id": "1641", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Romanian", + "decorators": [] + }, + { + "$id": "1642", + "kind": "enumvalue", + "name": "ru", + "value": "ru", + "valueType": { + "$id": "1643", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Russian", + "decorators": [] + }, + { + "$id": "1644", + "kind": "enumvalue", + "name": "sk", + "value": "sk", + "valueType": { + "$id": "1645", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Slovak", + "decorators": [] + }, + { + "$id": "1646", + "kind": "enumvalue", + "name": "sl", + "value": "sl", + "valueType": { + "$id": "1647", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Slovenian", + "decorators": [] + }, + { + "$id": "1648", + "kind": "enumvalue", + "name": "sr-Cyrl", + "value": "sr-Cyrl", + "valueType": { + "$id": "1649", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Serbian - Cyrillic RS", + "decorators": [] + }, + { + "$id": "1650", + "kind": "enumvalue", + "name": "sr-Latn", + "value": "sr-Latn", + "valueType": { + "$id": "1651", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Serbian - Latin RS", + "decorators": [] + }, + { + "$id": "1652", + "kind": "enumvalue", + "name": "sv", + "value": "sv", + "valueType": { + "$id": "1653", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Swedish", + "decorators": [] + }, + { + "$id": "1654", + "kind": "enumvalue", + "name": "th", + "value": "th", + "valueType": { + "$id": "1655", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Thai", + "decorators": [] + }, + { + "$id": "1656", + "kind": "enumvalue", + "name": "tr", + "value": "tr", + "valueType": { + "$id": "1657", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Turkish", + "decorators": [] + }, + { + "$id": "1658", + "kind": "enumvalue", + "name": "uk", + "value": "uk", + "valueType": { + "$id": "1659", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Ukrainian", + "decorators": [] + }, + { + "$id": "1660", + "kind": "enumvalue", + "name": "vi", + "value": "vi", + "valueType": { + "$id": "1661", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Vietnamese", + "decorators": [] + }, + { + "$id": "1662", + "kind": "enumvalue", + "name": "zh", + "value": "zh", + "valueType": { + "$id": "1663", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Chinese Simplified", + "decorators": [] + }, + { + "$id": "1664", + "kind": "enumvalue", + "name": "zh-Hans", + "value": "zh-Hans", + "valueType": { + "$id": "1665", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Chinese Simplified", + "decorators": [] + }, + { + "$id": "1666", + "kind": "enumvalue", + "name": "zh-Hant", + "value": "zh-Hant", + "valueType": { + "$id": "1667", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1562" + }, + "doc": "Chinese Traditional", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The language codes supported for input by ImageAnalysisSkill.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1668", + "kind": "enum", + "name": "VisualFeature", + "crossLanguageDefinitionId": "Search.VisualFeature", + "valueType": { + "$id": "1669", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1670", + "kind": "enumvalue", + "name": "Adult", + "value": "adult", + "valueType": { + "$id": "1671", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1668" + }, + "doc": "Visual features recognized as adult persons.", + "decorators": [] + }, + { + "$id": "1672", + "kind": "enumvalue", + "name": "Brands", + "value": "brands", + "valueType": { + "$id": "1673", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1668" + }, + "doc": "Visual features recognized as commercial brands.", + "decorators": [] + }, + { + "$id": "1674", + "kind": "enumvalue", + "name": "Categories", + "value": "categories", + "valueType": { + "$id": "1675", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1668" + }, + "doc": "Categories.", + "decorators": [] + }, + { + "$id": "1676", + "kind": "enumvalue", + "name": "Description", + "value": "description", + "valueType": { + "$id": "1677", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1668" + }, + "doc": "Description.", + "decorators": [] + }, + { + "$id": "1678", + "kind": "enumvalue", + "name": "Faces", + "value": "faces", + "valueType": { + "$id": "1679", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1668" + }, + "doc": "Visual features recognized as people faces.", + "decorators": [] + }, + { + "$id": "1680", + "kind": "enumvalue", + "name": "Objects", + "value": "objects", + "valueType": { + "$id": "1681", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1668" + }, + "doc": "Visual features recognized as objects.", + "decorators": [] + }, + { + "$id": "1682", + "kind": "enumvalue", + "name": "Tags", + "value": "tags", + "valueType": { + "$id": "1683", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1668" + }, + "doc": "Tags.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The strings indicating what visual feature types to return.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1684", + "kind": "enum", + "name": "ImageDetail", + "crossLanguageDefinitionId": "Search.ImageDetail", + "valueType": { + "$id": "1685", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1686", + "kind": "enumvalue", + "name": "Celebrities", + "value": "celebrities", + "valueType": { + "$id": "1687", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1684" + }, + "doc": "Details recognized as celebrities.", + "decorators": [] + }, + { + "$id": "1688", + "kind": "enumvalue", + "name": "Landmarks", + "value": "landmarks", + "valueType": { + "$id": "1689", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1684" + }, + "doc": "Details recognized as landmarks.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "A string indicating which domain-specific details to return.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1690", + "kind": "enum", + "name": "EntityCategory", + "crossLanguageDefinitionId": "Search.EntityCategory", + "valueType": { + "$id": "1691", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1692", + "kind": "enumvalue", + "name": "Location", + "value": "location", + "valueType": { + "$id": "1693", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1690" + }, + "doc": "Entities describing a physical location.", + "decorators": [] + }, + { + "$id": "1694", + "kind": "enumvalue", + "name": "Organization", + "value": "organization", + "valueType": { + "$id": "1695", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1690" + }, + "doc": "Entities describing an organization.", + "decorators": [] + }, + { + "$id": "1696", + "kind": "enumvalue", + "name": "Person", + "value": "person", + "valueType": { + "$id": "1697", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1690" + }, + "doc": "Entities describing a person.", + "decorators": [] + }, + { + "$id": "1698", + "kind": "enumvalue", + "name": "Quantity", + "value": "quantity", + "valueType": { + "$id": "1699", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1690" + }, + "doc": "Entities describing a quantity.", + "decorators": [] + }, + { + "$id": "1700", + "kind": "enumvalue", + "name": "Datetime", + "value": "datetime", + "valueType": { + "$id": "1701", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1690" + }, + "doc": "Entities describing a date and time.", + "decorators": [] + }, + { + "$id": "1702", + "kind": "enumvalue", + "name": "Url", + "value": "url", + "valueType": { + "$id": "1703", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1690" + }, + "doc": "Entities describing a URL.", + "decorators": [] + }, + { + "$id": "1704", + "kind": "enumvalue", + "name": "Email", + "value": "email", + "valueType": { + "$id": "1705", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1690" + }, + "doc": "Entities describing an email address.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "A string indicating what entity categories to return.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1706", + "kind": "enum", + "name": "EntityRecognitionSkillLanguage", + "crossLanguageDefinitionId": "Search.EntityRecognitionSkillLanguage", + "valueType": { + "$id": "1707", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1708", + "kind": "enumvalue", + "name": "ar", + "value": "ar", + "valueType": { + "$id": "1709", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Arabic", + "decorators": [] + }, + { + "$id": "1710", + "kind": "enumvalue", + "name": "cs", + "value": "cs", + "valueType": { + "$id": "1711", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Czech", + "decorators": [] + }, + { + "$id": "1712", + "kind": "enumvalue", + "name": "zh-Hans", + "value": "zh-Hans", + "valueType": { + "$id": "1713", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Chinese-Simplified", + "decorators": [] + }, + { + "$id": "1714", + "kind": "enumvalue", + "name": "zh-Hant", + "value": "zh-Hant", + "valueType": { + "$id": "1715", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Chinese-Traditional", + "decorators": [] + }, + { + "$id": "1716", + "kind": "enumvalue", + "name": "da", + "value": "da", + "valueType": { + "$id": "1717", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Danish", + "decorators": [] + }, + { + "$id": "1718", + "kind": "enumvalue", + "name": "nl", + "value": "nl", + "valueType": { + "$id": "1719", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Dutch", + "decorators": [] + }, + { + "$id": "1720", + "kind": "enumvalue", + "name": "en", + "value": "en", + "valueType": { + "$id": "1721", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "English", + "decorators": [] + }, + { + "$id": "1722", + "kind": "enumvalue", + "name": "fi", + "value": "fi", + "valueType": { + "$id": "1723", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Finnish", + "decorators": [] + }, + { + "$id": "1724", + "kind": "enumvalue", + "name": "fr", + "value": "fr", + "valueType": { + "$id": "1725", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "French", + "decorators": [] + }, + { + "$id": "1726", + "kind": "enumvalue", + "name": "de", + "value": "de", + "valueType": { + "$id": "1727", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "German", + "decorators": [] + }, + { + "$id": "1728", + "kind": "enumvalue", + "name": "el", + "value": "el", + "valueType": { + "$id": "1729", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Greek", + "decorators": [] + }, + { + "$id": "1730", + "kind": "enumvalue", + "name": "hu", + "value": "hu", + "valueType": { + "$id": "1731", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Hungarian", + "decorators": [] + }, + { + "$id": "1732", + "kind": "enumvalue", + "name": "it", + "value": "it", + "valueType": { + "$id": "1733", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Italian", + "decorators": [] + }, + { + "$id": "1734", + "kind": "enumvalue", + "name": "ja", + "value": "ja", + "valueType": { + "$id": "1735", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Japanese", + "decorators": [] + }, + { + "$id": "1736", + "kind": "enumvalue", + "name": "ko", + "value": "ko", + "valueType": { + "$id": "1737", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Korean", + "decorators": [] + }, + { + "$id": "1738", + "kind": "enumvalue", + "name": "no", + "value": "no", + "valueType": { + "$id": "1739", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Norwegian (Bokmaal)", + "decorators": [] + }, + { + "$id": "1740", + "kind": "enumvalue", + "name": "pl", + "value": "pl", + "valueType": { + "$id": "1741", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Polish", + "decorators": [] + }, + { + "$id": "1742", + "kind": "enumvalue", + "name": "pt-PT", + "value": "pt-PT", + "valueType": { + "$id": "1743", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Portuguese (Portugal)", + "decorators": [] + }, + { + "$id": "1744", + "kind": "enumvalue", + "name": "pt-BR", + "value": "pt-BR", + "valueType": { + "$id": "1745", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Portuguese (Brazil)", + "decorators": [] + }, + { + "$id": "1746", + "kind": "enumvalue", + "name": "ru", + "value": "ru", + "valueType": { + "$id": "1747", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Russian", + "decorators": [] + }, + { + "$id": "1748", + "kind": "enumvalue", + "name": "es", + "value": "es", + "valueType": { + "$id": "1749", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Spanish", + "decorators": [] + }, + { + "$id": "1750", + "kind": "enumvalue", + "name": "sv", + "value": "sv", + "valueType": { + "$id": "1751", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Swedish", + "decorators": [] + }, + { + "$id": "1752", + "kind": "enumvalue", + "name": "tr", + "value": "tr", + "valueType": { + "$id": "1753", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1706" + }, + "doc": "Turkish", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Deprecated. The language codes supported for input text by\nEntityRecognitionSkill.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1754", + "kind": "enum", + "name": "SentimentSkillLanguage", + "crossLanguageDefinitionId": "Search.SentimentSkillLanguage", + "valueType": { + "$id": "1755", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1756", + "kind": "enumvalue", + "name": "da", + "value": "da", + "valueType": { + "$id": "1757", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1754" + }, + "doc": "Danish", + "decorators": [] + }, + { + "$id": "1758", + "kind": "enumvalue", + "name": "nl", + "value": "nl", + "valueType": { + "$id": "1759", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1754" + }, + "doc": "Dutch", + "decorators": [] + }, + { + "$id": "1760", + "kind": "enumvalue", + "name": "en", + "value": "en", + "valueType": { + "$id": "1761", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1754" + }, + "doc": "English", + "decorators": [] + }, + { + "$id": "1762", + "kind": "enumvalue", + "name": "fi", + "value": "fi", + "valueType": { + "$id": "1763", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1754" + }, + "doc": "Finnish", + "decorators": [] + }, + { + "$id": "1764", + "kind": "enumvalue", + "name": "fr", + "value": "fr", + "valueType": { + "$id": "1765", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1754" + }, + "doc": "French", + "decorators": [] + }, + { + "$id": "1766", + "kind": "enumvalue", + "name": "de", + "value": "de", + "valueType": { + "$id": "1767", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1754" + }, + "doc": "German", + "decorators": [] + }, + { + "$id": "1768", + "kind": "enumvalue", + "name": "el", + "value": "el", + "valueType": { + "$id": "1769", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1754" + }, + "doc": "Greek", + "decorators": [] + }, + { + "$id": "1770", + "kind": "enumvalue", + "name": "it", + "value": "it", + "valueType": { + "$id": "1771", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1754" + }, + "doc": "Italian", + "decorators": [] + }, + { + "$id": "1772", + "kind": "enumvalue", + "name": "no", + "value": "no", + "valueType": { + "$id": "1773", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1754" + }, + "doc": "Norwegian (Bokmaal)", + "decorators": [] + }, + { + "$id": "1774", + "kind": "enumvalue", + "name": "pl", + "value": "pl", + "valueType": { + "$id": "1775", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1754" + }, + "doc": "Polish", + "decorators": [] + }, + { + "$id": "1776", + "kind": "enumvalue", + "name": "pt-PT", + "value": "pt-PT", + "valueType": { + "$id": "1777", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1754" + }, + "doc": "Portuguese (Portugal)", + "decorators": [] + }, + { + "$id": "1778", + "kind": "enumvalue", + "name": "ru", + "value": "ru", + "valueType": { + "$id": "1779", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1754" + }, + "doc": "Russian", + "decorators": [] + }, + { + "$id": "1780", + "kind": "enumvalue", + "name": "es", + "value": "es", + "valueType": { + "$id": "1781", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1754" + }, + "doc": "Spanish", + "decorators": [] + }, + { + "$id": "1782", + "kind": "enumvalue", + "name": "sv", + "value": "sv", + "valueType": { + "$id": "1783", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1754" + }, + "doc": "Swedish", + "decorators": [] + }, + { + "$id": "1784", + "kind": "enumvalue", + "name": "tr", + "value": "tr", + "valueType": { + "$id": "1785", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1754" + }, + "doc": "Turkish", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Deprecated. The language codes supported for input text by SentimentSkill.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1786", + "kind": "enum", + "name": "PIIDetectionSkillMaskingMode", + "crossLanguageDefinitionId": "Search.PIIDetectionSkillMaskingMode", + "valueType": { + "$id": "1787", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1788", + "kind": "enumvalue", + "name": "None", + "value": "none", + "valueType": { + "$id": "1789", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1786" + }, + "doc": "No masking occurs and the maskedText output will not be returned.", + "decorators": [] + }, + { + "$id": "1790", + "kind": "enumvalue", + "name": "Replace", + "value": "replace", + "valueType": { + "$id": "1791", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1786" + }, + "doc": "Replaces the detected entities with the character given in the maskingCharacter\nparameter. The character will be repeated to the length of the detected entity\nso that the offsets will correctly correspond to both the input text as well as\nthe output maskedText.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "A string indicating what maskingMode to use to mask the personal information\ndetected in the input text.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1792", + "kind": "enum", + "name": "SplitSkillLanguage", + "crossLanguageDefinitionId": "Search.SplitSkillLanguage", + "valueType": { + "$id": "1793", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1794", + "kind": "enumvalue", + "name": "am", + "value": "am", + "valueType": { + "$id": "1795", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Amharic", + "decorators": [] + }, + { + "$id": "1796", + "kind": "enumvalue", + "name": "bs", + "value": "bs", + "valueType": { + "$id": "1797", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Bosnian", + "decorators": [] + }, + { + "$id": "1798", + "kind": "enumvalue", + "name": "cs", + "value": "cs", + "valueType": { + "$id": "1799", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Czech", + "decorators": [] + }, + { + "$id": "1800", + "kind": "enumvalue", + "name": "da", + "value": "da", + "valueType": { + "$id": "1801", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Danish", + "decorators": [] + }, + { + "$id": "1802", + "kind": "enumvalue", + "name": "de", + "value": "de", + "valueType": { + "$id": "1803", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "German", + "decorators": [] + }, + { + "$id": "1804", + "kind": "enumvalue", + "name": "en", + "value": "en", + "valueType": { + "$id": "1805", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "English", + "decorators": [] + }, + { + "$id": "1806", + "kind": "enumvalue", + "name": "es", + "value": "es", + "valueType": { + "$id": "1807", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Spanish", + "decorators": [] + }, + { + "$id": "1808", + "kind": "enumvalue", + "name": "et", + "value": "et", + "valueType": { + "$id": "1809", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Estonian", + "decorators": [] + }, + { + "$id": "1810", + "kind": "enumvalue", + "name": "fi", + "value": "fi", + "valueType": { + "$id": "1811", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Finnish", + "decorators": [] + }, + { + "$id": "1812", + "kind": "enumvalue", + "name": "fr", + "value": "fr", + "valueType": { + "$id": "1813", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "French", + "decorators": [] + }, + { + "$id": "1814", + "kind": "enumvalue", + "name": "he", + "value": "he", + "valueType": { + "$id": "1815", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Hebrew", + "decorators": [] + }, + { + "$id": "1816", + "kind": "enumvalue", + "name": "hi", + "value": "hi", + "valueType": { + "$id": "1817", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Hindi", + "decorators": [] + }, + { + "$id": "1818", + "kind": "enumvalue", + "name": "hr", + "value": "hr", + "valueType": { + "$id": "1819", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Croatian", + "decorators": [] + }, + { + "$id": "1820", + "kind": "enumvalue", + "name": "hu", + "value": "hu", + "valueType": { + "$id": "1821", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Hungarian", + "decorators": [] + }, + { + "$id": "1822", + "kind": "enumvalue", + "name": "id", + "value": "id", + "valueType": { + "$id": "1823", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Indonesian", + "decorators": [] + }, + { + "$id": "1824", + "kind": "enumvalue", + "name": "is", + "value": "is", + "valueType": { + "$id": "1825", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Icelandic", + "decorators": [] + }, + { + "$id": "1826", + "kind": "enumvalue", + "name": "it", + "value": "it", + "valueType": { + "$id": "1827", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Italian", + "decorators": [] + }, + { + "$id": "1828", + "kind": "enumvalue", + "name": "ja", + "value": "ja", + "valueType": { + "$id": "1829", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Japanese", + "decorators": [] + }, + { + "$id": "1830", + "kind": "enumvalue", + "name": "ko", + "value": "ko", + "valueType": { + "$id": "1831", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Korean", + "decorators": [] + }, + { + "$id": "1832", + "kind": "enumvalue", + "name": "lv", + "value": "lv", + "valueType": { + "$id": "1833", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Latvian", + "decorators": [] + }, + { + "$id": "1834", + "kind": "enumvalue", + "name": "nb", + "value": "nb", + "valueType": { + "$id": "1835", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Norwegian", + "decorators": [] + }, + { + "$id": "1836", + "kind": "enumvalue", + "name": "nl", + "value": "nl", + "valueType": { + "$id": "1837", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Dutch", + "decorators": [] + }, + { + "$id": "1838", + "kind": "enumvalue", + "name": "pl", + "value": "pl", + "valueType": { + "$id": "1839", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Polish", + "decorators": [] + }, + { + "$id": "1840", + "kind": "enumvalue", + "name": "pt", + "value": "pt", + "valueType": { + "$id": "1841", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Portuguese (Portugal)", + "decorators": [] + }, + { + "$id": "1842", + "kind": "enumvalue", + "name": "pt-br", + "value": "pt-br", + "valueType": { + "$id": "1843", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Portuguese (Brazil)", + "decorators": [] + }, + { + "$id": "1844", + "kind": "enumvalue", + "name": "ru", + "value": "ru", + "valueType": { + "$id": "1845", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Russian", + "decorators": [] + }, + { + "$id": "1846", + "kind": "enumvalue", + "name": "sk", + "value": "sk", + "valueType": { + "$id": "1847", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Slovak", + "decorators": [] + }, + { + "$id": "1848", + "kind": "enumvalue", + "name": "sl", + "value": "sl", + "valueType": { + "$id": "1849", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Slovenian", + "decorators": [] + }, + { + "$id": "1850", + "kind": "enumvalue", + "name": "sr", + "value": "sr", + "valueType": { + "$id": "1851", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Serbian", + "decorators": [] + }, + { + "$id": "1852", + "kind": "enumvalue", + "name": "sv", + "value": "sv", + "valueType": { + "$id": "1853", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Swedish", + "decorators": [] + }, + { + "$id": "1854", + "kind": "enumvalue", + "name": "tr", + "value": "tr", + "valueType": { + "$id": "1855", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Turkish", + "decorators": [] + }, + { + "$id": "1856", + "kind": "enumvalue", + "name": "ur", + "value": "ur", + "valueType": { + "$id": "1857", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Urdu", + "decorators": [] + }, + { + "$id": "1858", + "kind": "enumvalue", + "name": "zh", + "value": "zh", + "valueType": { + "$id": "1859", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1792" + }, + "doc": "Chinese (Simplified)", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The language codes supported for input text by SplitSkill.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1860", + "kind": "enum", + "name": "TextSplitMode", + "crossLanguageDefinitionId": "Search.TextSplitMode", + "valueType": { + "$id": "1861", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1862", + "kind": "enumvalue", + "name": "Pages", + "value": "pages", + "valueType": { + "$id": "1863", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1860" + }, + "doc": "Split the text into individual pages.", + "decorators": [] + }, + { + "$id": "1864", + "kind": "enumvalue", + "name": "Sentences", + "value": "sentences", + "valueType": { + "$id": "1865", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1860" + }, + "doc": "Split the text into individual sentences.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "A value indicating which split mode to perform.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1866", + "kind": "enum", + "name": "SplitSkillUnit", + "crossLanguageDefinitionId": "Search.SplitSkillUnit", + "valueType": { + "$id": "1867", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1868", + "kind": "enumvalue", + "name": "Characters", + "value": "characters", + "valueType": { + "$id": "1869", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1866" + }, + "doc": "The length will be measured by character.", + "decorators": [] + }, + { + "$id": "1870", + "kind": "enumvalue", + "name": "AzureOpenAITokens", + "value": "azureOpenAITokens", + "valueType": { + "$id": "1871", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1866" + }, + "doc": "The length will be measured by an AzureOpenAI tokenizer from the tiktoken\nlibrary.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "A value indicating which unit to use.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1872", + "kind": "enum", + "name": "SplitSkillEncoderModelName", + "crossLanguageDefinitionId": "Search.SplitSkillEncoderModelName", + "valueType": { + "$id": "1873", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1874", + "kind": "enumvalue", + "name": "R50kBase", + "value": "r50k_base", + "valueType": { + "$id": "1875", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1872" + }, + "doc": "Refers to a base model trained with a 50,000 token vocabulary, often used in\ngeneral natural language processing tasks.", + "decorators": [] + }, + { + "$id": "1876", + "kind": "enumvalue", + "name": "P50kBase", + "value": "p50k_base", + "valueType": { + "$id": "1877", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1872" + }, + "doc": "A base model with a 50,000 token vocabulary, optimized for prompt-based tasks.", + "decorators": [] + }, + { + "$id": "1878", + "kind": "enumvalue", + "name": "P50kEdit", + "value": "p50k_edit", + "valueType": { + "$id": "1879", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1872" + }, + "doc": "Similar to p50k_base but fine-tuned for editing or rephrasing tasks with a\n50,000 token vocabulary.", + "decorators": [] + }, + { + "$id": "1880", + "kind": "enumvalue", + "name": "CL100kBase", + "value": "cl100k_base", + "valueType": { + "$id": "1881", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1872" + }, + "doc": "A base model with a 100,000 token vocabulary.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "A value indicating which tokenizer to use.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1882", + "kind": "enum", + "name": "CustomEntityLookupSkillLanguage", + "crossLanguageDefinitionId": "Search.CustomEntityLookupSkillLanguage", + "valueType": { + "$id": "1883", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1884", + "kind": "enumvalue", + "name": "da", + "value": "da", + "valueType": { + "$id": "1885", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1882" + }, + "doc": "Danish", + "decorators": [] + }, + { + "$id": "1886", + "kind": "enumvalue", + "name": "de", + "value": "de", + "valueType": { + "$id": "1887", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1882" + }, + "doc": "German", + "decorators": [] + }, + { + "$id": "1888", + "kind": "enumvalue", + "name": "en", + "value": "en", + "valueType": { + "$id": "1889", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1882" + }, + "doc": "English", + "decorators": [] + }, + { + "$id": "1890", + "kind": "enumvalue", + "name": "es", + "value": "es", + "valueType": { + "$id": "1891", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1882" + }, + "doc": "Spanish", + "decorators": [] + }, + { + "$id": "1892", + "kind": "enumvalue", + "name": "fi", + "value": "fi", + "valueType": { + "$id": "1893", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1882" + }, + "doc": "Finnish", + "decorators": [] + }, + { + "$id": "1894", + "kind": "enumvalue", + "name": "fr", + "value": "fr", + "valueType": { + "$id": "1895", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1882" + }, + "doc": "French", + "decorators": [] + }, + { + "$id": "1896", + "kind": "enumvalue", + "name": "it", + "value": "it", + "valueType": { + "$id": "1897", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1882" + }, + "doc": "Italian", + "decorators": [] + }, + { + "$id": "1898", + "kind": "enumvalue", + "name": "ko", + "value": "ko", + "valueType": { + "$id": "1899", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1882" + }, + "doc": "Korean", + "decorators": [] + }, + { + "$id": "1900", + "kind": "enumvalue", + "name": "pt", + "value": "pt", + "valueType": { + "$id": "1901", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1882" + }, + "doc": "Portuguese", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The language codes supported for input text by CustomEntityLookupSkill.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "1902", + "kind": "enum", + "name": "TextTranslationSkillLanguage", + "crossLanguageDefinitionId": "Search.TextTranslationSkillLanguage", + "valueType": { + "$id": "1903", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "1904", + "kind": "enumvalue", + "name": "af", + "value": "af", + "valueType": { + "$id": "1905", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Afrikaans", + "decorators": [] + }, + { + "$id": "1906", + "kind": "enumvalue", + "name": "ar", + "value": "ar", + "valueType": { + "$id": "1907", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Arabic", + "decorators": [] + }, + { + "$id": "1908", + "kind": "enumvalue", + "name": "bn", + "value": "bn", + "valueType": { + "$id": "1909", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Bangla", + "decorators": [] + }, + { + "$id": "1910", + "kind": "enumvalue", + "name": "bs", + "value": "bs", + "valueType": { + "$id": "1911", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Bosnian (Latin)", + "decorators": [] + }, + { + "$id": "1912", + "kind": "enumvalue", + "name": "bg", + "value": "bg", + "valueType": { + "$id": "1913", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Bulgarian", + "decorators": [] + }, + { + "$id": "1914", + "kind": "enumvalue", + "name": "yue", + "value": "yue", + "valueType": { + "$id": "1915", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Cantonese (Traditional)", + "decorators": [] + }, + { + "$id": "1916", + "kind": "enumvalue", + "name": "ca", + "value": "ca", + "valueType": { + "$id": "1917", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Catalan", + "decorators": [] + }, + { + "$id": "1918", + "kind": "enumvalue", + "name": "zh-Hans", + "value": "zh-Hans", + "valueType": { + "$id": "1919", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Chinese Simplified", + "decorators": [] + }, + { + "$id": "1920", + "kind": "enumvalue", + "name": "zh-Hant", + "value": "zh-Hant", + "valueType": { + "$id": "1921", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Chinese Traditional", + "decorators": [] + }, + { + "$id": "1922", + "kind": "enumvalue", + "name": "hr", + "value": "hr", + "valueType": { + "$id": "1923", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Croatian", + "decorators": [] + }, + { + "$id": "1924", + "kind": "enumvalue", + "name": "cs", + "value": "cs", + "valueType": { + "$id": "1925", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Czech", + "decorators": [] + }, + { + "$id": "1926", + "kind": "enumvalue", + "name": "da", + "value": "da", + "valueType": { + "$id": "1927", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Danish", + "decorators": [] + }, + { + "$id": "1928", + "kind": "enumvalue", + "name": "nl", + "value": "nl", + "valueType": { + "$id": "1929", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Dutch", + "decorators": [] + }, + { + "$id": "1930", + "kind": "enumvalue", + "name": "en", + "value": "en", + "valueType": { + "$id": "1931", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "English", + "decorators": [] + }, + { + "$id": "1932", + "kind": "enumvalue", + "name": "et", + "value": "et", + "valueType": { + "$id": "1933", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Estonian", + "decorators": [] + }, + { + "$id": "1934", + "kind": "enumvalue", + "name": "fj", + "value": "fj", + "valueType": { + "$id": "1935", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Fijian", + "decorators": [] + }, + { + "$id": "1936", + "kind": "enumvalue", + "name": "fil", + "value": "fil", + "valueType": { + "$id": "1937", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Filipino", + "decorators": [] + }, + { + "$id": "1938", + "kind": "enumvalue", + "name": "fi", + "value": "fi", + "valueType": { + "$id": "1939", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Finnish", + "decorators": [] + }, + { + "$id": "1940", + "kind": "enumvalue", + "name": "fr", + "value": "fr", + "valueType": { + "$id": "1941", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "French", + "decorators": [] + }, + { + "$id": "1942", + "kind": "enumvalue", + "name": "de", + "value": "de", + "valueType": { + "$id": "1943", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "German", + "decorators": [] + }, + { + "$id": "1944", + "kind": "enumvalue", + "name": "el", + "value": "el", + "valueType": { + "$id": "1945", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Greek", + "decorators": [] + }, + { + "$id": "1946", + "kind": "enumvalue", + "name": "ht", + "value": "ht", + "valueType": { + "$id": "1947", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Haitian Creole", + "decorators": [] + }, + { + "$id": "1948", + "kind": "enumvalue", + "name": "he", + "value": "he", + "valueType": { + "$id": "1949", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Hebrew", + "decorators": [] + }, + { + "$id": "1950", + "kind": "enumvalue", + "name": "hi", + "value": "hi", + "valueType": { + "$id": "1951", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Hindi", + "decorators": [] + }, + { + "$id": "1952", + "kind": "enumvalue", + "name": "mww", + "value": "mww", + "valueType": { + "$id": "1953", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Hmong Daw", + "decorators": [] + }, + { + "$id": "1954", + "kind": "enumvalue", + "name": "hu", + "value": "hu", + "valueType": { + "$id": "1955", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Hungarian", + "decorators": [] + }, + { + "$id": "1956", + "kind": "enumvalue", + "name": "is", + "value": "is", + "valueType": { + "$id": "1957", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Icelandic", + "decorators": [] + }, + { + "$id": "1958", + "kind": "enumvalue", + "name": "id", + "value": "id", + "valueType": { + "$id": "1959", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Indonesian", + "decorators": [] + }, + { + "$id": "1960", + "kind": "enumvalue", + "name": "it", + "value": "it", + "valueType": { + "$id": "1961", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Italian", + "decorators": [] + }, + { + "$id": "1962", + "kind": "enumvalue", + "name": "ja", + "value": "ja", + "valueType": { + "$id": "1963", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Japanese", + "decorators": [] + }, + { + "$id": "1964", + "kind": "enumvalue", + "name": "sw", + "value": "sw", + "valueType": { + "$id": "1965", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Kiswahili", + "decorators": [] + }, + { + "$id": "1966", + "kind": "enumvalue", + "name": "tlh", + "value": "tlh", + "valueType": { + "$id": "1967", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Klingon", + "decorators": [] + }, + { + "$id": "1968", + "kind": "enumvalue", + "name": "tlh-Latn", + "value": "tlh-Latn", + "valueType": { + "$id": "1969", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Klingon (Latin script)", + "decorators": [] + }, + { + "$id": "1970", + "kind": "enumvalue", + "name": "tlh-Piqd", + "value": "tlh-Piqd", + "valueType": { + "$id": "1971", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Klingon (Klingon script)", + "decorators": [] + }, + { + "$id": "1972", + "kind": "enumvalue", + "name": "ko", + "value": "ko", + "valueType": { + "$id": "1973", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Korean", + "decorators": [] + }, + { + "$id": "1974", + "kind": "enumvalue", + "name": "lv", + "value": "lv", + "valueType": { + "$id": "1975", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Latvian", + "decorators": [] + }, + { + "$id": "1976", + "kind": "enumvalue", + "name": "lt", + "value": "lt", + "valueType": { + "$id": "1977", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Lithuanian", + "decorators": [] + }, + { + "$id": "1978", + "kind": "enumvalue", + "name": "mg", + "value": "mg", + "valueType": { + "$id": "1979", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Malagasy", + "decorators": [] + }, + { + "$id": "1980", + "kind": "enumvalue", + "name": "ms", + "value": "ms", + "valueType": { + "$id": "1981", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Malay", + "decorators": [] + }, + { + "$id": "1982", + "kind": "enumvalue", + "name": "mt", + "value": "mt", + "valueType": { + "$id": "1983", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Maltese", + "decorators": [] + }, + { + "$id": "1984", + "kind": "enumvalue", + "name": "nb", + "value": "nb", + "valueType": { + "$id": "1985", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Norwegian", + "decorators": [] + }, + { + "$id": "1986", + "kind": "enumvalue", + "name": "fa", + "value": "fa", + "valueType": { + "$id": "1987", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Persian", + "decorators": [] + }, + { + "$id": "1988", + "kind": "enumvalue", + "name": "pl", + "value": "pl", + "valueType": { + "$id": "1989", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Polish", + "decorators": [] + }, + { + "$id": "1990", + "kind": "enumvalue", + "name": "pt", + "value": "pt", + "valueType": { + "$id": "1991", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Portuguese", + "decorators": [] + }, + { + "$id": "1992", + "kind": "enumvalue", + "name": "pt-br", + "value": "pt-br", + "valueType": { + "$id": "1993", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Portuguese (Brazil)", + "decorators": [] + }, + { + "$id": "1994", + "kind": "enumvalue", + "name": "pt-PT", + "value": "pt-PT", + "valueType": { + "$id": "1995", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Portuguese (Portugal)", + "decorators": [] + }, + { + "$id": "1996", + "kind": "enumvalue", + "name": "otq", + "value": "otq", + "valueType": { + "$id": "1997", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Queretaro Otomi", + "decorators": [] + }, + { + "$id": "1998", + "kind": "enumvalue", + "name": "ro", + "value": "ro", + "valueType": { + "$id": "1999", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Romanian", + "decorators": [] + }, + { + "$id": "2000", + "kind": "enumvalue", + "name": "ru", + "value": "ru", + "valueType": { + "$id": "2001", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Russian", + "decorators": [] + }, + { + "$id": "2002", + "kind": "enumvalue", + "name": "sm", + "value": "sm", + "valueType": { + "$id": "2003", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Samoan", + "decorators": [] + }, + { + "$id": "2004", + "kind": "enumvalue", + "name": "sr-Cyrl", + "value": "sr-Cyrl", + "valueType": { + "$id": "2005", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Serbian (Cyrillic)", + "decorators": [] + }, + { + "$id": "2006", + "kind": "enumvalue", + "name": "sr-Latn", + "value": "sr-Latn", + "valueType": { + "$id": "2007", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Serbian (Latin)", + "decorators": [] + }, + { + "$id": "2008", + "kind": "enumvalue", + "name": "sk", + "value": "sk", + "valueType": { + "$id": "2009", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Slovak", + "decorators": [] + }, + { + "$id": "2010", + "kind": "enumvalue", + "name": "sl", + "value": "sl", + "valueType": { + "$id": "2011", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Slovenian", + "decorators": [] + }, + { + "$id": "2012", + "kind": "enumvalue", + "name": "es", + "value": "es", + "valueType": { + "$id": "2013", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Spanish", + "decorators": [] + }, + { + "$id": "2014", + "kind": "enumvalue", + "name": "sv", + "value": "sv", + "valueType": { + "$id": "2015", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Swedish", + "decorators": [] + }, + { + "$id": "2016", + "kind": "enumvalue", + "name": "ty", + "value": "ty", + "valueType": { + "$id": "2017", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Tahitian", + "decorators": [] + }, + { + "$id": "2018", + "kind": "enumvalue", + "name": "ta", + "value": "ta", + "valueType": { + "$id": "2019", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Tamil", + "decorators": [] + }, + { + "$id": "2020", + "kind": "enumvalue", + "name": "te", + "value": "te", + "valueType": { + "$id": "2021", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Telugu", + "decorators": [] + }, + { + "$id": "2022", + "kind": "enumvalue", + "name": "th", + "value": "th", + "valueType": { + "$id": "2023", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Thai", + "decorators": [] + }, + { + "$id": "2024", + "kind": "enumvalue", + "name": "to", + "value": "to", + "valueType": { + "$id": "2025", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Tongan", + "decorators": [] + }, + { + "$id": "2026", + "kind": "enumvalue", + "name": "tr", + "value": "tr", + "valueType": { + "$id": "2027", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Turkish", + "decorators": [] + }, + { + "$id": "2028", + "kind": "enumvalue", + "name": "uk", + "value": "uk", + "valueType": { + "$id": "2029", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Ukrainian", + "decorators": [] + }, + { + "$id": "2030", + "kind": "enumvalue", + "name": "ur", + "value": "ur", + "valueType": { + "$id": "2031", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Urdu", + "decorators": [] + }, + { + "$id": "2032", + "kind": "enumvalue", + "name": "vi", + "value": "vi", + "valueType": { + "$id": "2033", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Vietnamese", + "decorators": [] + }, + { + "$id": "2034", + "kind": "enumvalue", + "name": "cy", + "value": "cy", + "valueType": { + "$id": "2035", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Welsh", + "decorators": [] + }, + { + "$id": "2036", + "kind": "enumvalue", + "name": "yua", + "value": "yua", + "valueType": { + "$id": "2037", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Yucatec Maya", + "decorators": [] + }, + { + "$id": "2038", + "kind": "enumvalue", + "name": "ga", + "value": "ga", + "valueType": { + "$id": "2039", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Irish", + "decorators": [] + }, + { + "$id": "2040", + "kind": "enumvalue", + "name": "kn", + "value": "kn", + "valueType": { + "$id": "2041", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Kannada", + "decorators": [] + }, + { + "$id": "2042", + "kind": "enumvalue", + "name": "mi", + "value": "mi", + "valueType": { + "$id": "2043", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Maori", + "decorators": [] + }, + { + "$id": "2044", + "kind": "enumvalue", + "name": "ml", + "value": "ml", + "valueType": { + "$id": "2045", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Malayalam", + "decorators": [] + }, + { + "$id": "2046", + "kind": "enumvalue", + "name": "pa", + "value": "pa", + "valueType": { + "$id": "2047", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "1902" + }, + "doc": "Punjabi", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The language codes supported for input text by TextTranslationSkill.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "2048", + "kind": "enum", + "name": "DocumentIntelligenceLayoutSkillOutputMode", + "crossLanguageDefinitionId": "Search.DocumentIntelligenceLayoutSkillOutputMode", + "valueType": { + "$id": "2049", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2050", + "kind": "enumvalue", + "name": "OneToMany", + "value": "oneToMany", + "valueType": { + "$id": "2051", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2048" + }, + "doc": "Specify the deepest markdown header section to parse.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Controls the cardinality of the output produced by the skill. Default is 'oneToMany'", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "2052", + "kind": "enum", + "name": "DocumentIntelligenceLayoutSkillMarkdownHeaderDepth", + "crossLanguageDefinitionId": "Search.DocumentIntelligenceLayoutSkillMarkdownHeaderDepth", + "valueType": { + "$id": "2053", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2054", + "kind": "enumvalue", + "name": "H1", + "value": "h1", + "valueType": { + "$id": "2055", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2052" + }, + "doc": "Header level 1.", + "decorators": [] + }, + { + "$id": "2056", + "kind": "enumvalue", + "name": "H2", + "value": "h2", + "valueType": { + "$id": "2057", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2052" + }, + "doc": "Header level 2.", + "decorators": [] + }, + { + "$id": "2058", + "kind": "enumvalue", + "name": "H3", + "value": "h3", + "valueType": { + "$id": "2059", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2052" + }, + "doc": "Header level 3.", + "decorators": [] + }, + { + "$id": "2060", + "kind": "enumvalue", + "name": "H4", + "value": "h4", + "valueType": { + "$id": "2061", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2052" + }, + "doc": "Header level 4.", + "decorators": [] + }, + { + "$id": "2062", + "kind": "enumvalue", + "name": "H5", + "value": "h5", + "valueType": { + "$id": "2063", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2052" + }, + "doc": "Header level 5.", + "decorators": [] + }, + { + "$id": "2064", + "kind": "enumvalue", + "name": "H6", + "value": "h6", + "valueType": { + "$id": "2065", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2052" + }, + "doc": "Header level 6.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The depth of headers in the markdown output. Default is h6.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "2066", + "kind": "enum", + "name": "IndexProjectionMode", + "crossLanguageDefinitionId": "Search.IndexProjectionMode", + "valueType": { + "$id": "2067", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2068", + "kind": "enumvalue", + "name": "SkipIndexingParentDocuments", + "value": "skipIndexingParentDocuments", + "valueType": { + "$id": "2069", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2066" + }, + "doc": "The source document will be skipped from writing into the indexer's target\nindex.", + "decorators": [] + }, + { + "$id": "2070", + "kind": "enumvalue", + "name": "IncludeIndexingParentDocuments", + "value": "includeIndexingParentDocuments", + "valueType": { + "$id": "2071", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2066" + }, + "doc": "The source document will be written into the indexer's target index. This is\nthe default pattern.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Defines behavior of the index projections in relation to the rest of the\nindexer.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "2072", + "kind": "enum", + "name": "BlobIndexerParsingMode", + "crossLanguageDefinitionId": "Search.BlobIndexerParsingMode", + "valueType": { + "$id": "2073", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2074", + "kind": "enumvalue", + "name": "Default", + "value": "default", + "valueType": { + "$id": "2075", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2072" + }, + "doc": "Set to default for normal file processing.", + "decorators": [] + }, + { + "$id": "2076", + "kind": "enumvalue", + "name": "Text", + "value": "text", + "valueType": { + "$id": "2077", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2072" + }, + "doc": "Set to text to improve indexing performance on plain text files in blob storage.", + "decorators": [] + }, + { + "$id": "2078", + "kind": "enumvalue", + "name": "DelimitedText", + "value": "delimitedText", + "valueType": { + "$id": "2079", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2072" + }, + "doc": "Set to delimitedText when blobs are plain CSV files.", + "decorators": [] + }, + { + "$id": "2080", + "kind": "enumvalue", + "name": "Json", + "value": "json", + "valueType": { + "$id": "2081", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2072" + }, + "doc": "Set to json to extract structured content from JSON files.", + "decorators": [] + }, + { + "$id": "2082", + "kind": "enumvalue", + "name": "JsonArray", + "value": "jsonArray", + "valueType": { + "$id": "2083", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2072" + }, + "doc": "Set to jsonArray to extract individual elements of a JSON array as separate\ndocuments.", + "decorators": [] + }, + { + "$id": "2084", + "kind": "enumvalue", + "name": "JsonLines", + "value": "jsonLines", + "valueType": { + "$id": "2085", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2072" + }, + "doc": "Set to jsonLines to extract individual JSON entities, separated by a new line,\nas separate documents.", + "decorators": [] + }, + { + "$id": "2086", + "kind": "enumvalue", + "name": "Markdown", + "value": "markdown", + "valueType": { + "$id": "2087", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2072" + }, + "doc": "Set to markdown to extract content from markdown files.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Represents the parsing mode for indexing from an Azure blob data source.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "2088", + "kind": "enum", + "name": "MarkdownParsingSubmode", + "crossLanguageDefinitionId": "Search.MarkdownParsingSubmode", + "valueType": { + "$id": "2089", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2090", + "kind": "enumvalue", + "name": "OneToMany", + "value": "oneToMany", + "valueType": { + "$id": "2091", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2088" + }, + "doc": "Indicates that each section of the markdown file (up to a specified depth) will\nbe parsed into individual search documents. This can result in a single\nmarkdown file producing multiple search documents. This is the default\nsub-mode.", + "decorators": [] + }, + { + "$id": "2092", + "kind": "enumvalue", + "name": "OneToOne", + "value": "oneToOne", + "valueType": { + "$id": "2093", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2088" + }, + "doc": "Indicates that each markdown file will be parsed into a single search document.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Specifies the submode that will determine whether a markdown file will be\nparsed into exactly one search document or multiple search documents. Default\nis `oneToMany`.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "2094", + "kind": "enum", + "name": "MarkdownHeaderDepth", + "crossLanguageDefinitionId": "Search.MarkdownHeaderDepth", + "valueType": { + "$id": "2095", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2096", + "kind": "enumvalue", + "name": "h1", + "value": "h1", + "valueType": { + "$id": "2097", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2094" + }, + "doc": "Indicates that headers up to a level of h1 will be considered while grouping\nmarkdown content.", + "decorators": [] + }, + { + "$id": "2098", + "kind": "enumvalue", + "name": "h2", + "value": "h2", + "valueType": { + "$id": "2099", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2094" + }, + "doc": "Indicates that headers up to a level of h2 will be considered while grouping\nmarkdown content.", + "decorators": [] + }, + { + "$id": "2100", + "kind": "enumvalue", + "name": "h3", + "value": "h3", + "valueType": { + "$id": "2101", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2094" + }, + "doc": "Indicates that headers up to a level of h3 will be considered while grouping\nmarkdown content.", + "decorators": [] + }, + { + "$id": "2102", + "kind": "enumvalue", + "name": "h4", + "value": "h4", + "valueType": { + "$id": "2103", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2094" + }, + "doc": "Indicates that headers up to a level of h4 will be considered while grouping\nmarkdown content.", + "decorators": [] + }, + { + "$id": "2104", + "kind": "enumvalue", + "name": "h5", + "value": "h5", + "valueType": { + "$id": "2105", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2094" + }, + "doc": "Indicates that headers up to a level of h5 will be considered while grouping\nmarkdown content.", + "decorators": [] + }, + { + "$id": "2106", + "kind": "enumvalue", + "name": "h6", + "value": "h6", + "valueType": { + "$id": "2107", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2094" + }, + "doc": "Indicates that headers up to a level of h6 will be considered while grouping\nmarkdown content. This is the default.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Specifies the max header depth that will be considered while grouping markdown\ncontent. Default is `h6`.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "2108", + "kind": "enum", + "name": "BlobIndexerDataToExtract", + "crossLanguageDefinitionId": "Search.BlobIndexerDataToExtract", + "valueType": { + "$id": "2109", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2110", + "kind": "enumvalue", + "name": "StorageMetadata", + "value": "storageMetadata", + "valueType": { + "$id": "2111", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2108" + }, + "doc": "Indexes just the standard blob properties and user-specified metadata.", + "decorators": [] + }, + { + "$id": "2112", + "kind": "enumvalue", + "name": "AllMetadata", + "value": "allMetadata", + "valueType": { + "$id": "2113", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2108" + }, + "doc": "Extracts metadata provided by the Azure blob storage subsystem and the\ncontent-type specific metadata (for example, metadata unique to just .png files\nare indexed).", + "decorators": [] + }, + { + "$id": "2114", + "kind": "enumvalue", + "name": "ContentAndMetadata", + "value": "contentAndMetadata", + "valueType": { + "$id": "2115", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2108" + }, + "doc": "Extracts all metadata and textual content from each blob.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Specifies the data to extract from Azure blob storage and tells the indexer\nwhich data to extract from image content when \"imageAction\" is set to a value\nother than \"none\". This applies to embedded image content in a .PDF or other\napplication, or image files such as .jpg and .png, in Azure blobs.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "2116", + "kind": "enum", + "name": "BlobIndexerImageAction", + "crossLanguageDefinitionId": "Search.BlobIndexerImageAction", + "valueType": { + "$id": "2117", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2118", + "kind": "enumvalue", + "name": "None", + "value": "none", + "valueType": { + "$id": "2119", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2116" + }, + "doc": "Ignores embedded images or image files in the data set. This is the default.", + "decorators": [] + }, + { + "$id": "2120", + "kind": "enumvalue", + "name": "GenerateNormalizedImages", + "value": "generateNormalizedImages", + "valueType": { + "$id": "2121", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2116" + }, + "doc": "Extracts text from images (for example, the word \"STOP\" from a traffic stop\nsign), and embeds it into the content field. This action requires that\n\"dataToExtract\" is set to \"contentAndMetadata\". A normalized image refers to\nadditional processing resulting in uniform image output, sized and rotated to\npromote consistent rendering when you include images in visual search results.\nThis information is generated for each image when you use this option.", + "decorators": [] + }, + { + "$id": "2122", + "kind": "enumvalue", + "name": "GenerateNormalizedImagePerPage", + "value": "generateNormalizedImagePerPage", + "valueType": { + "$id": "2123", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2116" + }, + "doc": "Extracts text from images (for example, the word \"STOP\" from a traffic stop\nsign), and embeds it into the content field, but treats PDF files differently\nin that each page will be rendered as an image and normalized accordingly,\ninstead of extracting embedded images. Non-PDF file types will be treated the\nsame as if \"generateNormalizedImages\" was set.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Determines how to process embedded images and image files in Azure blob\nstorage. Setting the \"imageAction\" configuration to any value other than\n\"none\" requires that a skillset also be attached to that indexer.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "2124", + "kind": "enum", + "name": "BlobIndexerPDFTextRotationAlgorithm", + "crossLanguageDefinitionId": "Search.BlobIndexerPDFTextRotationAlgorithm", + "valueType": { + "$id": "2125", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2126", + "kind": "enumvalue", + "name": "None", + "value": "none", + "valueType": { + "$id": "2127", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2124" + }, + "doc": "Leverages normal text extraction. This is the default.", + "decorators": [] + }, + { + "$id": "2128", + "kind": "enumvalue", + "name": "DetectAngles", + "value": "detectAngles", + "valueType": { + "$id": "2129", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2124" + }, + "doc": "May produce better and more readable text extraction from PDF files that have\nrotated text within them. Note that there may be a small performance speed\nimpact when this parameter is used. This parameter only applies to PDF files,\nand only to PDFs with embedded text. If the rotated text appears within an\nembedded image in the PDF, this parameter does not apply.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Determines algorithm for text extraction from PDF files in Azure blob storage.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "2130", + "kind": "enum", + "name": "IndexerExecutionEnvironment", + "crossLanguageDefinitionId": "Search.IndexerExecutionEnvironment", + "valueType": { + "$id": "2131", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2132", + "kind": "enumvalue", + "name": "standard", + "value": "standard", + "valueType": { + "$id": "2133", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2130" + }, + "doc": "Indicates that the search service can determine where the indexer should\nexecute. This is the default environment when nothing is specified and is the\nrecommended value.", + "decorators": [] + }, + { + "$id": "2134", + "kind": "enumvalue", + "name": "private", + "value": "private", + "valueType": { + "$id": "2135", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2130" + }, + "doc": "Indicates that the indexer should run with the environment provisioned\nspecifically for the search service. This should only be specified as the\nexecution environment if the indexer needs to access resources securely over\nshared private link resources.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Specifies the environment in which the indexer should execute.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "2136", + "kind": "enum", + "name": "IndexerStatus", + "crossLanguageDefinitionId": "Search.IndexerStatus", + "valueType": { + "$id": "2137", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2138", + "kind": "enumvalue", + "name": "Unknown", + "value": "unknown", + "valueType": { + "$id": "2139", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2136" + }, + "doc": "Indicates that the indexer is in an unknown state.", + "decorators": [] + }, + { + "$id": "2140", + "kind": "enumvalue", + "name": "Error", + "value": "error", + "valueType": { + "$id": "2141", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2136" + }, + "doc": "Indicates that the indexer experienced an error that cannot be corrected\nwithout human intervention.", + "decorators": [] + }, + { + "$id": "2142", + "kind": "enumvalue", + "name": "Running", + "value": "running", + "valueType": { + "$id": "2143", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2136" + }, + "doc": "Indicates that the indexer is running normally.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Represents the overall indexer status.", + "isFixed": false, + "isFlags": false, + "usage": "Output,Json", + "decorators": [] + }, + { + "$id": "2144", + "kind": "enum", + "name": "IndexerExecutionStatus", + "crossLanguageDefinitionId": "Search.IndexerExecutionStatus", + "valueType": { + "$id": "2145", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2146", + "kind": "enumvalue", + "name": "TransientFailure", + "value": "transientFailure", + "valueType": { + "$id": "2147", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2144" + }, + "doc": "An indexer invocation has failed, but the failure may be transient. Indexer\ninvocations will continue per schedule.", + "decorators": [] + }, + { + "$id": "2148", + "kind": "enumvalue", + "name": "Success", + "value": "success", + "valueType": { + "$id": "2149", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2144" + }, + "doc": "Indexer execution completed successfully.", + "decorators": [] + }, + { + "$id": "2150", + "kind": "enumvalue", + "name": "InProgress", + "value": "inProgress", + "valueType": { + "$id": "2151", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2144" + }, + "doc": "Indexer execution is in progress.", + "decorators": [] + }, + { + "$id": "2152", + "kind": "enumvalue", + "name": "Reset", + "value": "reset", + "valueType": { + "$id": "2153", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2144" + }, + "doc": "Indexer has been reset.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Represents the status of an individual indexer execution.", + "isFixed": false, + "isFlags": false, + "usage": "Output,Json", + "decorators": [] + }, + { + "$id": "2154", + "kind": "enum", + "name": "IndexerExecutionStatusDetail", + "crossLanguageDefinitionId": "Search.IndexerExecutionStatusDetail", + "valueType": { + "$id": "2155", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2156", + "kind": "enumvalue", + "name": "ResetDocs", + "value": "resetDocs", + "valueType": { + "$id": "2157", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2154" + }, + "doc": "Indicates that the reset that occurred was for a call to ResetDocs.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Details the status of an individual indexer execution.", + "isFixed": false, + "isFlags": false, + "usage": "Output,Json", + "decorators": [] + }, + { + "$id": "2158", + "kind": "enum", + "name": "IndexingMode", + "crossLanguageDefinitionId": "Search.IndexingMode", + "valueType": { + "$id": "2159", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2160", + "kind": "enumvalue", + "name": "IndexingAllDocs", + "value": "indexingAllDocs", + "valueType": { + "$id": "2161", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2158" + }, + "doc": "The indexer is indexing all documents in the datasource.", + "decorators": [] + }, + { + "$id": "2162", + "kind": "enumvalue", + "name": "IndexingResetDocs", + "value": "indexingResetDocs", + "valueType": { + "$id": "2163", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2158" + }, + "doc": "The indexer is indexing selective, reset documents in the datasource. The\ndocuments being indexed are defined on indexer status.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Represents the mode the indexer is executing in.", + "isFixed": false, + "isFlags": false, + "usage": "Output,Json", + "decorators": [] + }, + { + "$id": "2164", + "kind": "enum", + "name": "SearchIndexerDataSourceType", + "crossLanguageDefinitionId": "Search.SearchIndexerDataSourceType", + "valueType": { + "$id": "2165", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2166", + "kind": "enumvalue", + "name": "AzureSql", + "value": "azuresql", + "valueType": { + "$id": "2167", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2164" + }, + "doc": "Indicates an Azure SQL datasource.", + "decorators": [] + }, + { + "$id": "2168", + "kind": "enumvalue", + "name": "CosmosDb", + "value": "cosmosdb", + "valueType": { + "$id": "2169", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2164" + }, + "doc": "Indicates a CosmosDB datasource.", + "decorators": [] + }, + { + "$id": "2170", + "kind": "enumvalue", + "name": "AzureBlob", + "value": "azureblob", + "valueType": { + "$id": "2171", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2164" + }, + "doc": "Indicates an Azure Blob datasource.", + "decorators": [] + }, + { + "$id": "2172", + "kind": "enumvalue", + "name": "AzureTable", + "value": "azuretable", + "valueType": { + "$id": "2173", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2164" + }, + "doc": "Indicates an Azure Table datasource.", + "decorators": [] + }, + { + "$id": "2174", + "kind": "enumvalue", + "name": "MySql", + "value": "mysql", + "valueType": { + "$id": "2175", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2164" + }, + "doc": "Indicates a MySql datasource.", + "decorators": [] + }, + { + "$id": "2176", + "kind": "enumvalue", + "name": "AdlsGen2", + "value": "adlsgen2", + "valueType": { + "$id": "2177", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2164" + }, + "doc": "Indicates an ADLS Gen2 datasource.", + "decorators": [] + }, + { + "$id": "2178", + "kind": "enumvalue", + "name": "OneLake", + "value": "onelake", + "valueType": { + "$id": "2179", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2164" + }, + "doc": "Indicates a Microsoft Fabric OneLake datasource.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "Defines the type of a datasource.", + "isFixed": false, + "isFlags": false, + "usage": "Input,Output,Json", + "decorators": [] + }, + { + "$id": "2180", + "kind": "enum", + "name": "Versions", + "crossLanguageDefinitionId": "Search.Versions", + "valueType": { + "$id": "2181", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "values": [ + { + "$id": "2182", + "kind": "enumvalue", + "name": "v2024_07_01", + "value": "2024-07-01", + "valueType": { + "$id": "2183", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2180" + }, + "doc": "The 2024-07-01 API version.", + "decorators": [] + }, + { + "$id": "2184", + "kind": "enumvalue", + "name": "v2025_03_01_preview", + "value": "2025-03-01-preview", + "valueType": { + "$id": "2185", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "enumType": { + "$ref": "2180" + }, + "doc": "The 2025-03-01-preview API version.", + "decorators": [] + } + ], + "namespace": "Azure.Search.Documents", + "doc": "The available API versions.", + "isFixed": true, + "isFlags": false, + "usage": "ApiVersionEnum", + "decorators": [] + } + ], + "models": [ + { + "$id": "2186", + "kind": "model", + "name": "SearchServiceStatistics", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchServiceStatistics", + "usage": "Output,Json", + "doc": "Response from a get service statistics request. If successful, it includes\nservice level counters and limits.", + "decorators": [], + "properties": [ + { + "$id": "2187", + "kind": "property", + "name": "counters", + "serializedName": "counters", + "doc": "Service level resource counters.", + "type": { + "$id": "2188", + "kind": "model", + "name": "SearchServiceCounters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchServiceCounters", + "usage": "Output,Json", + "doc": "Represents service-level resource counters and quotas.", + "decorators": [], + "properties": [ + { + "$id": "2189", + "kind": "property", + "name": "aliasCounter", + "serializedName": "aliasesCount", + "doc": "Total number of aliases.", + "type": { + "$id": "2190", + "kind": "model", + "name": "ResourceCounter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ResourceCounter", + "usage": "Output,Json", + "doc": "Represents a resource's usage and quota.", + "decorators": [], + "properties": [ + { + "$id": "2191", + "kind": "property", + "name": "usage", + "serializedName": "usage", + "doc": "The resource usage amount.", + "type": { + "$id": "2192", + "kind": "int64", + "name": "int64", + "crossLanguageDefinitionId": "TypeSpec.int64", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ResourceCounter.usage", + "serializationOptions": { + "$id": "2193", + "json": { + "$id": "2194", + "name": "usage" + } + } + }, + { + "$id": "2195", + "kind": "property", + "name": "quota", + "serializedName": "quota", + "doc": "The resource amount quota.", + "type": { + "$id": "2196", + "kind": "int64", + "name": "int64", + "crossLanguageDefinitionId": "TypeSpec.int64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ResourceCounter.quota", + "serializationOptions": { + "$id": "2197", + "json": { + "$id": "2198", + "name": "quota" + } + } + } + ] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceCounters.aliasesCount", + "serializationOptions": { + "$id": "2199", + "json": { + "$id": "2200", + "name": "aliasesCount" + } + } + }, + { + "$id": "2201", + "kind": "property", + "name": "documentCounter", + "serializedName": "documentCount", + "doc": "Total number of documents across all indexes in the service.", + "type": { + "$ref": "2190" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceCounters.documentCount", + "serializationOptions": { + "$id": "2202", + "json": { + "$id": "2203", + "name": "documentCount" + } + } + }, + { + "$id": "2204", + "kind": "property", + "name": "indexCounter", + "serializedName": "indexesCount", + "doc": "Total number of indexes.", + "type": { + "$ref": "2190" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceCounters.indexesCount", + "serializationOptions": { + "$id": "2205", + "json": { + "$id": "2206", + "name": "indexesCount" + } + } + }, + { + "$id": "2207", + "kind": "property", + "name": "indexerCounter", + "serializedName": "indexersCount", + "doc": "Total number of indexers.", + "type": { + "$ref": "2190" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceCounters.indexersCount", + "serializationOptions": { + "$id": "2208", + "json": { + "$id": "2209", + "name": "indexersCount" + } + } + }, + { + "$id": "2210", + "kind": "property", + "name": "dataSourceCounter", + "serializedName": "dataSourcesCount", + "doc": "Total number of data sources.", + "type": { + "$ref": "2190" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceCounters.dataSourcesCount", + "serializationOptions": { + "$id": "2211", + "json": { + "$id": "2212", + "name": "dataSourcesCount" + } + } + }, + { + "$id": "2213", + "kind": "property", + "name": "storageSizeCounter", + "serializedName": "storageSize", + "doc": "Total size of used storage in bytes.", + "type": { + "$ref": "2190" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceCounters.storageSize", + "serializationOptions": { + "$id": "2214", + "json": { + "$id": "2215", + "name": "storageSize" + } + } + }, + { + "$id": "2216", + "kind": "property", + "name": "synonymMapCounter", + "serializedName": "synonymMaps", + "doc": "Total number of synonym maps.", + "type": { + "$ref": "2190" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceCounters.synonymMaps", + "serializationOptions": { + "$id": "2217", + "json": { + "$id": "2218", + "name": "synonymMaps" + } + } + }, + { + "$id": "2219", + "kind": "property", + "name": "skillsetCounter", + "serializedName": "skillsetCount", + "doc": "Total number of skillsets.", + "type": { + "$ref": "2190" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceCounters.skillsetCount", + "serializationOptions": { + "$id": "2220", + "json": { + "$id": "2221", + "name": "skillsetCount" + } + } + }, + { + "$id": "2222", + "kind": "property", + "name": "vectorIndexSizeCounter", + "serializedName": "vectorIndexSize", + "doc": "Total memory consumption of all vector indexes within the service, in bytes.", + "type": { + "$ref": "2190" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceCounters.vectorIndexSize", + "serializationOptions": { + "$id": "2223", + "json": { + "$id": "2224", + "name": "vectorIndexSize" + } + } + } + ] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceStatistics.counters", + "serializationOptions": { + "$id": "2225", + "json": { + "$id": "2226", + "name": "counters" + } + } + }, + { + "$id": "2227", + "kind": "property", + "name": "limits", + "serializedName": "limits", + "doc": "Service level general limits.", + "type": { + "$id": "2228", + "kind": "model", + "name": "SearchServiceLimits", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchServiceLimits", + "usage": "Output,Json", + "doc": "Represents various service level limits.", + "decorators": [], + "properties": [ + { + "$id": "2229", + "kind": "property", + "name": "maxFieldsPerIndex", + "serializedName": "maxFieldsPerIndex", + "doc": "The maximum allowed fields per index.", + "type": { + "$id": "2230", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceLimits.maxFieldsPerIndex", + "serializationOptions": { + "$id": "2231", + "json": { + "$id": "2232", + "name": "maxFieldsPerIndex" + } + } + }, + { + "$id": "2233", + "kind": "property", + "name": "maxFieldNestingDepthPerIndex", + "serializedName": "maxFieldNestingDepthPerIndex", + "doc": "The maximum depth which you can nest sub-fields in an index, including the\ntop-level complex field. For example, a/b/c has a nesting depth of 3.", + "type": { + "$id": "2234", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceLimits.maxFieldNestingDepthPerIndex", + "serializationOptions": { + "$id": "2235", + "json": { + "$id": "2236", + "name": "maxFieldNestingDepthPerIndex" + } + } + }, + { + "$id": "2237", + "kind": "property", + "name": "maxComplexCollectionFieldsPerIndex", + "serializedName": "maxComplexCollectionFieldsPerIndex", + "doc": "The maximum number of fields of type Collection(Edm.ComplexType) allowed in an\nindex.", + "type": { + "$id": "2238", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceLimits.maxComplexCollectionFieldsPerIndex", + "serializationOptions": { + "$id": "2239", + "json": { + "$id": "2240", + "name": "maxComplexCollectionFieldsPerIndex" + } + } + }, + { + "$id": "2241", + "kind": "property", + "name": "maxComplexObjectsInCollectionsPerDocument", + "serializedName": "maxComplexObjectsInCollectionsPerDocument", + "doc": "The maximum number of objects in complex collections allowed per document.", + "type": { + "$id": "2242", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceLimits.maxComplexObjectsInCollectionsPerDocument", + "serializationOptions": { + "$id": "2243", + "json": { + "$id": "2244", + "name": "maxComplexObjectsInCollectionsPerDocument" + } + } + }, + { + "$id": "2245", + "kind": "property", + "name": "maxStoragePerIndexInBytes", + "serializedName": "maxStoragePerIndex", + "doc": "The maximum amount of storage in bytes allowed per index.", + "type": { + "$id": "2246", + "kind": "int64", + "name": "int64", + "crossLanguageDefinitionId": "TypeSpec.int64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceLimits.maxStoragePerIndex", + "serializationOptions": { + "$id": "2247", + "json": { + "$id": "2248", + "name": "maxStoragePerIndex" + } + } + } + ] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchServiceStatistics.limits", + "serializationOptions": { + "$id": "2249", + "json": { + "$id": "2250", + "name": "limits" + } + } + } + ] + }, + { + "$ref": "2188" + }, + { + "$ref": "2190" + }, + { + "$ref": "2228" + }, + { + "$id": "2251", + "kind": "model", + "name": "ErrorResponse", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ErrorResponse", + "usage": "Error,Json,Exception", + "doc": "Common error response for all Azure Resource Manager APIs to return error\ndetails for failed operations. (This also follows the OData error response\nformat.).", + "decorators": [], + "properties": [ + { + "$id": "2252", + "kind": "property", + "name": "error", + "serializedName": "error", + "doc": "The error object.", + "type": { + "$id": "2253", + "kind": "model", + "name": "ErrorDetail", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ErrorDetail", + "usage": "Json,Exception", + "doc": "The error detail.", + "decorators": [], + "properties": [ + { + "$id": "2254", + "kind": "property", + "name": "code", + "serializedName": "code", + "doc": "The error code.", + "type": { + "$id": "2255", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ErrorDetail.code", + "serializationOptions": { + "$id": "2256", + "json": { + "$id": "2257", + "name": "code" + } + } + }, + { + "$id": "2258", + "kind": "property", + "name": "message", + "serializedName": "message", + "doc": "The error message.", + "type": { + "$id": "2259", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ErrorDetail.message", + "serializationOptions": { + "$id": "2260", + "json": { + "$id": "2261", + "name": "message" + } + } + }, + { + "$id": "2262", + "kind": "property", + "name": "target", + "serializedName": "target", + "doc": "The error target.", + "type": { + "$id": "2263", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ErrorDetail.target", + "serializationOptions": { + "$id": "2264", + "json": { + "$id": "2265", + "name": "target" + } + } + }, + { + "$id": "2266", + "kind": "property", + "name": "details", + "serializedName": "details", + "doc": "The error details.", + "type": { + "$id": "2267", + "kind": "array", + "name": "ArrayErrorDetail", + "valueType": { + "$ref": "2253" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ErrorDetail.details", + "serializationOptions": { + "$id": "2268", + "json": { + "$id": "2269", + "name": "details" + } + } + }, + { + "$id": "2270", + "kind": "property", + "name": "additionalInfo", + "serializedName": "additionalInfo", + "doc": "The error additional info.", + "type": { + "$id": "2271", + "kind": "array", + "name": "ArrayErrorAdditionalInfo", + "valueType": { + "$id": "2272", + "kind": "model", + "name": "ErrorAdditionalInfo", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ErrorAdditionalInfo", + "usage": "Json,Exception", + "doc": "The resource management error additional info.", + "decorators": [], + "properties": [ + { + "$id": "2273", + "kind": "property", + "name": "type", + "serializedName": "type", + "doc": "The additional info type.", + "type": { + "$id": "2274", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ErrorAdditionalInfo.type", + "serializationOptions": { + "$id": "2275", + "json": { + "$id": "2276", + "name": "type" + } + } + }, + { + "$id": "2277", + "kind": "property", + "name": "info", + "serializedName": "info", + "doc": "The additional info.", + "type": { + "$id": "2278", + "kind": "dict", + "keyType": { + "$id": "2279", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "valueType": { + "$id": "2280", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ErrorAdditionalInfo.info", + "serializationOptions": { + "$id": "2281", + "json": { + "$id": "2282", + "name": "info" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ErrorDetail.additionalInfo", + "serializationOptions": { + "$id": "2283", + "json": { + "$id": "2284", + "name": "additionalInfo" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ErrorResponse.error", + "serializationOptions": { + "$id": "2285", + "json": { + "$id": "2286", + "name": "error" + } + } + } + ] + }, + { + "$ref": "2253" + }, + { + "$ref": "2272" + }, + { + "$id": "2287", + "kind": "model", + "name": "ListIndexStatsSummary", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ListIndexStatsSummary", + "usage": "Output,Json", + "doc": "Response from a request to retrieve stats summary of all indexes. If successful, it includes the stats of each index in the service.", + "decorators": [], + "properties": [ + { + "$id": "2288", + "kind": "property", + "name": "IndexesStatistics", + "serializedName": "value", + "doc": "The Statistics summary of all indexes in the Search service.", + "type": { + "$id": "2289", + "kind": "array", + "name": "ArrayIndexStatisticsSummary", + "valueType": { + "$id": "2290", + "kind": "model", + "name": "IndexStatisticsSummary", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.IndexStatisticsSummary", + "usage": "Output,Json", + "doc": "Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date.", + "decorators": [], + "properties": [ + { + "$id": "2291", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the index.", + "type": { + "$id": "2292", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexStatisticsSummary.name", + "serializationOptions": { + "$id": "2293", + "json": { + "$id": "2294", + "name": "name" + } + } + }, + { + "$id": "2295", + "kind": "property", + "name": "documentCount", + "serializedName": "documentCount", + "doc": "The number of documents in the index.", + "type": { + "$id": "2296", + "kind": "int64", + "name": "int64", + "crossLanguageDefinitionId": "TypeSpec.int64", + "decorators": [] + }, + "optional": false, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexStatisticsSummary.documentCount", + "serializationOptions": { + "$id": "2297", + "json": { + "$id": "2298", + "name": "documentCount" + } + } + }, + { + "$id": "2299", + "kind": "property", + "name": "storageSize", + "serializedName": "storageSize", + "doc": "The amount of storage in bytes consumed by the index.", + "type": { + "$id": "2300", + "kind": "int64", + "name": "int64", + "crossLanguageDefinitionId": "TypeSpec.int64", + "decorators": [] + }, + "optional": false, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexStatisticsSummary.storageSize", + "serializationOptions": { + "$id": "2301", + "json": { + "$id": "2302", + "name": "storageSize" + } + } + }, + { + "$id": "2303", + "kind": "property", + "name": "vectorIndexSize", + "serializedName": "vectorIndexSize", + "doc": "The amount of memory in bytes consumed by vectors in the index.", + "type": { + "$id": "2304", + "kind": "int64", + "name": "int64", + "crossLanguageDefinitionId": "TypeSpec.int64", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexStatisticsSummary.vectorIndexSize", + "serializationOptions": { + "$id": "2305", + "json": { + "$id": "2306", + "name": "vectorIndexSize" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ListIndexStatsSummary.value", + "serializationOptions": { + "$id": "2307", + "json": { + "$id": "2308", + "name": "value" + } + } + } + ] + }, + { + "$ref": "2290" + }, + { + "$id": "2309", + "kind": "model", + "name": "SearchDocumentsResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchDocumentsResult", + "usage": "Output,Json", + "doc": "Response containing search results from an index.", + "decorators": [], + "properties": [ + { + "$id": "2310", + "kind": "property", + "name": "count", + "serializedName": "@odata.count", + "doc": "The total count of results found by the search operation, or null if the count\nwas not requested. If present, the count may be greater than the number of\nresults in this response. This can happen if you use the $top or $skip\nparameters, or if the query can't return all the requested documents in a\nsingle response.", + "type": { + "$id": "2311", + "kind": "int64", + "name": "int64", + "crossLanguageDefinitionId": "TypeSpec.int64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchDocumentsResult.count", + "serializationOptions": { + "$id": "2312", + "json": { + "$id": "2313", + "name": "@odata.count" + } + } + }, + { + "$id": "2314", + "kind": "property", + "name": "coverage", + "serializedName": "@search.coverage", + "doc": "A value indicating the percentage of the index that was included in the query,\nor null if minimumCoverage was not specified in the request.", + "type": { + "$id": "2315", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchDocumentsResult.coverage", + "serializationOptions": { + "$id": "2316", + "json": { + "$id": "2317", + "name": "@search.coverage" + } + } + }, + { + "$id": "2318", + "kind": "property", + "name": "facets", + "serializedName": "@search.facets", + "doc": "The facet query results for the search operation, organized as a collection of\nbuckets for each faceted field; null if the query did not include any facet\nexpressions.", + "type": { + "$id": "2319", + "kind": "dict", + "keyType": { + "$id": "2320", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "valueType": { + "$id": "2321", + "kind": "array", + "name": "ArrayFacetResult", + "valueType": { + "$id": "2322", + "kind": "model", + "name": "FacetResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.FacetResult", + "usage": "Output,Json", + "doc": "A single bucket of a facet query result. Reports the number of documents with a\nfield value falling within a particular range or having a particular value or\ninterval.", + "decorators": [], + "additionalProperties": { + "$id": "2323", + "kind": "unknown", + "name": "unknown", + "crossLanguageDefinitionId": "", + "decorators": [] + }, + "properties": [ + { + "$id": "2324", + "kind": "property", + "name": "count", + "serializedName": "count", + "doc": "The approximate count of documents falling within the bucket described by this\nfacet.", + "type": { + "$id": "2325", + "kind": "int64", + "name": "int64", + "crossLanguageDefinitionId": "TypeSpec.int64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.FacetResult.count", + "serializationOptions": { + "$id": "2326", + "json": { + "$id": "2327", + "name": "count" + } + } + }, + { + "$id": "2328", + "kind": "property", + "name": "facets", + "serializedName": "@search.facets", + "doc": "The nested facet query results for the search operation, organized as a\ncollection of buckets for each faceted field; null if the query did not contain\nany nested facets.", + "type": { + "$id": "2329", + "kind": "dict", + "keyType": { + "$id": "2330", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "valueType": { + "$id": "2331", + "kind": "array", + "name": "ArrayFacetResult", + "valueType": { + "$ref": "2322" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.FacetResult.facets", + "serializationOptions": { + "$id": "2332", + "json": { + "$id": "2333", + "name": "@search.facets" + } + } + }, + { + "$id": "2334", + "kind": "property", + "name": "sum", + "serializedName": "sum", + "doc": "The resulting total sum for the facet when a sum metric is requested.", + "type": { + "$id": "2335", + "kind": "int64", + "name": "int64", + "crossLanguageDefinitionId": "TypeSpec.int64", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.FacetResult.sum", + "serializationOptions": { + "$id": "2336", + "json": { + "$id": "2337", + "name": "sum" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchDocumentsResult.facets", + "serializationOptions": { + "$id": "2338", + "json": { + "$id": "2339", + "name": "@search.facets" + } + } + }, + { + "$id": "2340", + "kind": "property", + "name": "answers", + "serializedName": "@search.answers", + "doc": "The answers query results for the search operation; null if the answers query\nparameter was not specified or set to 'none'.", + "type": { + "$id": "2341", + "kind": "array", + "name": "ArrayQueryAnswerResult", + "valueType": { + "$id": "2342", + "kind": "model", + "name": "QueryAnswerResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.QueryAnswerResult", + "usage": "Output,Json", + "doc": "An answer is a text passage extracted from the contents of the most relevant\ndocuments that matched the query. Answers are extracted from the top search\nresults. Answer candidates are scored and the top answers are selected.", + "decorators": [], + "additionalProperties": { + "$id": "2343", + "kind": "unknown", + "name": "unknown", + "crossLanguageDefinitionId": "", + "decorators": [] + }, + "properties": [ + { + "$id": "2344", + "kind": "property", + "name": "score", + "serializedName": "score", + "doc": "The score value represents how relevant the answer is to the query relative to\nother answers returned for the query.", + "type": { + "$id": "2345", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryAnswerResult.score", + "serializationOptions": { + "$id": "2346", + "json": { + "$id": "2347", + "name": "score" + } + } + }, + { + "$id": "2348", + "kind": "property", + "name": "key", + "serializedName": "key", + "doc": "The key of the document the answer was extracted from.", + "type": { + "$id": "2349", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryAnswerResult.key", + "serializationOptions": { + "$id": "2350", + "json": { + "$id": "2351", + "name": "key" + } + } + }, + { + "$id": "2352", + "kind": "property", + "name": "text", + "serializedName": "text", + "doc": "The text passage extracted from the document contents as the answer.", + "type": { + "$id": "2353", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryAnswerResult.text", + "serializationOptions": { + "$id": "2354", + "json": { + "$id": "2355", + "name": "text" + } + } + }, + { + "$id": "2356", + "kind": "property", + "name": "highlights", + "serializedName": "highlights", + "doc": "Same text passage as in the Text property with highlighted text phrases most\nrelevant to the query.", + "type": { + "$id": "2357", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryAnswerResult.highlights", + "serializationOptions": { + "$id": "2358", + "json": { + "$id": "2359", + "name": "highlights" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchDocumentsResult.answers", + "serializationOptions": { + "$id": "2360", + "json": { + "$id": "2361", + "name": "@search.answers" + } + } + }, + { + "$id": "2362", + "kind": "property", + "name": "debugInfo", + "serializedName": "@search.debug", + "doc": "Debug information that applies to the search results as a whole.", + "type": { + "$id": "2363", + "kind": "model", + "name": "DebugInfo", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.DebugInfo", + "usage": "Output,Json", + "doc": "Contains debugging information that can be used to further explore your search\nresults.", + "decorators": [], + "properties": [ + { + "$id": "2364", + "kind": "property", + "name": "queryRewrites", + "serializedName": "queryRewrites", + "doc": "Contains debugging information specific to query rewrites.", + "type": { + "$id": "2365", + "kind": "model", + "name": "QueryRewritesDebugInfo", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.QueryRewritesDebugInfo", + "usage": "Output,Json", + "doc": "Contains debugging information specific to query rewrites.", + "decorators": [], + "properties": [ + { + "$id": "2366", + "kind": "property", + "name": "text", + "serializedName": "text", + "doc": "List of query rewrites generated for the text query.", + "type": { + "$id": "2367", + "kind": "model", + "name": "QueryRewritesValuesDebugInfo", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.QueryRewritesValuesDebugInfo", + "usage": "Output,Json", + "doc": "Contains debugging information specific to query rewrites.", + "decorators": [], + "properties": [ + { + "$id": "2368", + "kind": "property", + "name": "inputQuery", + "serializedName": "inputQuery", + "doc": "The input text to the generative query rewriting model. There may be cases\nwhere the user query and the input to the generative model are not identical.", + "type": { + "$id": "2369", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryRewritesValuesDebugInfo.inputQuery", + "serializationOptions": { + "$id": "2370", + "json": { + "$id": "2371", + "name": "inputQuery" + } + } + }, + { + "$id": "2372", + "kind": "property", + "name": "rewrites", + "serializedName": "rewrites", + "doc": "List of query rewrites.", + "type": { + "$id": "2373", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "2374", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryRewritesValuesDebugInfo.rewrites", + "serializationOptions": { + "$id": "2375", + "json": { + "$id": "2376", + "name": "rewrites" + } + } + } + ] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryRewritesDebugInfo.text", + "serializationOptions": { + "$id": "2377", + "json": { + "$id": "2378", + "name": "text" + } + } + }, + { + "$id": "2379", + "kind": "property", + "name": "vectors", + "serializedName": "vectors", + "doc": "List of query rewrites generated for the vectorizable text queries.", + "type": { + "$id": "2380", + "kind": "array", + "name": "ArrayQueryRewritesValuesDebugInfo", + "valueType": { + "$ref": "2367" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryRewritesDebugInfo.vectors", + "serializationOptions": { + "$id": "2381", + "json": { + "$id": "2382", + "name": "vectors" + } + } + } + ] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DebugInfo.queryRewrites", + "serializationOptions": { + "$id": "2383", + "json": { + "$id": "2384", + "name": "queryRewrites" + } + } + } + ] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchDocumentsResult.debugInfo", + "serializationOptions": { + "$id": "2385", + "json": { + "$id": "2386", + "name": "@search.debug" + } + } + }, + { + "$id": "2387", + "kind": "property", + "name": "nextPageParameters", + "serializedName": "@search.nextPageParameters", + "doc": "Continuation JSON payload returned when the query can't return all the\nrequested results in a single response. You can use this JSON along with", + "type": { + "$id": "2388", + "kind": "model", + "name": "SearchRequest", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchRequest", + "usage": "Input,Output,Json", + "doc": "Parameters for filtering, sorting, faceting, paging, and other search query\nbehaviors.", + "decorators": [], + "properties": [ + { + "$id": "2389", + "kind": "property", + "name": "includeTotalResultCount", + "serializedName": "count", + "doc": "A value that specifies whether to fetch the total count of results. Default is\nfalse. Setting this value to true may have a performance impact. Note that the\ncount returned is an approximation.", + "type": { + "$id": "2390", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.count", + "serializationOptions": { + "$id": "2391", + "json": { + "$id": "2392", + "name": "count" + } + } + }, + { + "$id": "2393", + "kind": "property", + "name": "facets", + "serializedName": "facets", + "doc": "The list of facet expressions to apply to the search query. Each facet\nexpression contains a field name, optionally followed by a comma-separated list\nof name:value pairs.", + "type": { + "$id": "2394", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "2395", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.facets", + "serializationOptions": { + "$id": "2396", + "json": { + "$id": "2397", + "name": "facets" + } + } + }, + { + "$id": "2398", + "kind": "property", + "name": "filter", + "serializedName": "filter", + "doc": "The OData $filter expression to apply to the search query.", + "type": { + "$id": "2399", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.filter", + "serializationOptions": { + "$id": "2400", + "json": { + "$id": "2401", + "name": "filter" + } + } + }, + { + "$id": "2402", + "kind": "property", + "name": "highlightFields", + "serializedName": "highlight", + "doc": "The comma-separated list of field names to use for hit highlights. Only\nsearchable fields can be used for hit highlighting.", + "type": { + "$id": "2403", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.highlight", + "serializationOptions": { + "$id": "2404", + "json": { + "$id": "2405", + "name": "highlight" + } + } + }, + { + "$id": "2406", + "kind": "property", + "name": "highlightPostTag", + "serializedName": "highlightPostTag", + "doc": "A string tag that is appended to hit highlights. Must be set with\nhighlightPreTag. Default is </em>.", + "type": { + "$id": "2407", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.highlightPostTag", + "serializationOptions": { + "$id": "2408", + "json": { + "$id": "2409", + "name": "highlightPostTag" + } + } + }, + { + "$id": "2410", + "kind": "property", + "name": "highlightPreTag", + "serializedName": "highlightPreTag", + "doc": "A string tag that is prepended to hit highlights. Must be set with\nhighlightPostTag. Default is <em>.", + "type": { + "$id": "2411", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.highlightPreTag", + "serializationOptions": { + "$id": "2412", + "json": { + "$id": "2413", + "name": "highlightPreTag" + } + } + }, + { + "$id": "2414", + "kind": "property", + "name": "minimumCoverage", + "serializedName": "minimumCoverage", + "doc": "A number between 0 and 100 indicating the percentage of the index that must be\ncovered by a search query in order for the query to be reported as a success.\nThis parameter can be useful for ensuring search availability even for services\nwith only one replica. The default is 100.", + "type": { + "$id": "2415", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.minimumCoverage", + "serializationOptions": { + "$id": "2416", + "json": { + "$id": "2417", + "name": "minimumCoverage" + } + } + }, + { + "$id": "2418", + "kind": "property", + "name": "orderBy", + "serializedName": "orderby", + "doc": "The comma-separated list of OData $orderby expressions by which to sort the\nresults. Each expression can be either a field name or a call to either the\ngeo.distance() or the search.score() functions. Each expression can be followed\nby asc to indicate ascending, or desc to indicate descending. The default is\nascending order. Ties will be broken by the match scores of documents. If no\n$orderby is specified, the default sort order is descending by document match\nscore. There can be at most 32 $orderby clauses.", + "type": { + "$id": "2419", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.orderby", + "serializationOptions": { + "$id": "2420", + "json": { + "$id": "2421", + "name": "orderby" + } + } + }, + { + "$id": "2422", + "kind": "property", + "name": "queryType", + "serializedName": "queryType", + "doc": "A value that specifies the syntax of the search query. The default is 'simple'.\nUse 'full' if your query uses the Lucene query syntax.", + "type": { + "$ref": "2" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.queryType", + "serializationOptions": { + "$id": "2423", + "json": { + "$id": "2424", + "name": "queryType" + } + } + }, + { + "$id": "2425", + "kind": "property", + "name": "scoringStatistics", + "serializedName": "scoringStatistics", + "doc": "A value that specifies whether we want to calculate scoring statistics (such as\ndocument frequency) globally for more consistent scoring, or locally, for lower\nlatency. The default is 'local'. Use 'global' to aggregate scoring statistics\nglobally before scoring. Using global scoring statistics can increase latency\nof search queries.", + "type": { + "$ref": "16" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.scoringStatistics", + "serializationOptions": { + "$id": "2426", + "json": { + "$id": "2427", + "name": "scoringStatistics" + } + } + }, + { + "$id": "2428", + "kind": "property", + "name": "sessionId", + "serializedName": "sessionId", + "doc": "A value to be used to create a sticky session, which can help getting more\nconsistent results. As long as the same sessionId is used, a best-effort\nattempt will be made to target the same replica set. Be wary that reusing the\nsame sessionID values repeatedly can interfere with the load balancing of the\nrequests across replicas and adversely affect the performance of the search\nservice. The value used as sessionId cannot start with a '_' character.", + "type": { + "$id": "2429", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.sessionId", + "serializationOptions": { + "$id": "2430", + "json": { + "$id": "2431", + "name": "sessionId" + } + } + }, + { + "$id": "2432", + "kind": "property", + "name": "scoringParameters", + "serializedName": "scoringParameters", + "doc": "The list of parameter values to be used in scoring functions (for example,\nreferencePointParameter) using the format name-values. For example, if the\nscoring profile defines a function with a parameter called 'mylocation' the\nparameter string would be \"mylocation--122.2,44.8\" (without the quotes).", + "type": { + "$id": "2433", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "2434", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.scoringParameters", + "serializationOptions": { + "$id": "2435", + "json": { + "$id": "2436", + "name": "scoringParameters" + } + } + }, + { + "$id": "2437", + "kind": "property", + "name": "scoringProfile", + "serializedName": "scoringProfile", + "doc": "The name of a scoring profile to evaluate match scores for matching documents\nin order to sort the results.", + "type": { + "$id": "2438", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.scoringProfile", + "serializationOptions": { + "$id": "2439", + "json": { + "$id": "2440", + "name": "scoringProfile" + } + } + }, + { + "$id": "2441", + "kind": "property", + "name": "debug", + "serializedName": "debug", + "doc": "Enables a debugging tool that can be used to further explore your reranked\nresults.", + "type": { + "$ref": "46" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.debug", + "serializationOptions": { + "$id": "2442", + "json": { + "$id": "2443", + "name": "debug" + } + } + }, + { + "$id": "2444", + "kind": "property", + "name": "searchText", + "serializedName": "search", + "doc": "A full-text search query expression; Use \"*\" or omit this parameter to match\nall documents.", + "type": { + "$id": "2445", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.search", + "serializationOptions": { + "$id": "2446", + "json": { + "$id": "2447", + "name": "search" + } + } + }, + { + "$id": "2448", + "kind": "property", + "name": "searchFields", + "serializedName": "searchFields", + "doc": "The comma-separated list of field names to which to scope the full-text search.\nWhen using fielded search (fieldName:searchExpression) in a full Lucene query,\nthe field names of each fielded search expression take precedence over any\nfield names listed in this parameter.", + "type": { + "$id": "2449", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.searchFields", + "serializationOptions": { + "$id": "2450", + "json": { + "$id": "2451", + "name": "searchFields" + } + } + }, + { + "$id": "2452", + "kind": "property", + "name": "searchMode", + "serializedName": "searchMode", + "doc": "A value that specifies whether any or all of the search terms must be matched\nin order to count the document as a match.", + "type": { + "$ref": "10" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.searchMode", + "serializationOptions": { + "$id": "2453", + "json": { + "$id": "2454", + "name": "searchMode" + } + } + }, + { + "$id": "2455", + "kind": "property", + "name": "queryLanguage", + "serializedName": "queryLanguage", + "doc": "A value that specifies the language of the search query.", + "type": { + "$ref": "58" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.queryLanguage", + "serializationOptions": { + "$id": "2456", + "json": { + "$id": "2457", + "name": "queryLanguage" + } + } + }, + { + "$id": "2458", + "kind": "property", + "name": "speller", + "serializedName": "speller", + "doc": "A value that specified the type of the speller to use to spell-correct\nindividual search query terms.", + "type": { + "$ref": "204" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.speller", + "serializationOptions": { + "$id": "2459", + "json": { + "$id": "2460", + "name": "speller" + } + } + }, + { + "$id": "2461", + "kind": "property", + "name": "select", + "serializedName": "select", + "doc": "The comma-separated list of fields to retrieve. If unspecified, all fields\nmarked as retrievable in the schema are included.", + "type": { + "$id": "2462", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.select", + "serializationOptions": { + "$id": "2463", + "json": { + "$id": "2464", + "name": "select" + } + } + }, + { + "$id": "2465", + "kind": "property", + "name": "skip", + "serializedName": "skip", + "doc": "The number of search results to skip. This value cannot be greater than\n100,000. If you need to scan documents in sequence, but cannot use skip due to\nthis limitation, consider using orderby on a totally-ordered key and filter\nwith a range query instead.", + "type": { + "$id": "2466", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.skip", + "serializationOptions": { + "$id": "2467", + "json": { + "$id": "2468", + "name": "skip" + } + } + }, + { + "$id": "2469", + "kind": "property", + "name": "top", + "serializedName": "top", + "doc": "The number of search results to retrieve. This can be used in conjunction with\n$skip to implement client-side paging of search results. If results are\ntruncated due to server-side paging, the response will include a continuation\ntoken that can be used to issue another Search request for the next page of\nresults.", + "type": { + "$id": "2470", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.top", + "serializationOptions": { + "$id": "2471", + "json": { + "$id": "2472", + "name": "top" + } + } + }, + { + "$id": "2473", + "kind": "property", + "name": "semanticConfiguration", + "serializedName": "semanticConfiguration", + "doc": "The name of a semantic configuration that will be used when processing\ndocuments for queries of type semantic.", + "type": { + "$id": "2474", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.semanticConfiguration", + "serializationOptions": { + "$id": "2475", + "json": { + "$id": "2476", + "name": "semanticConfiguration" + } + } + }, + { + "$id": "2477", + "kind": "property", + "name": "semanticErrorHandling", + "serializedName": "semanticErrorHandling", + "doc": "Allows the user to choose whether a semantic call should fail completely\n(default / current behavior), or to return partial results.", + "type": { + "$ref": "22" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.semanticErrorHandling", + "serializationOptions": { + "$id": "2478", + "json": { + "$id": "2479", + "name": "semanticErrorHandling" + } + } + }, + { + "$id": "2480", + "kind": "property", + "name": "semanticMaxWaitInMilliseconds", + "serializedName": "semanticMaxWaitInMilliseconds", + "doc": "Allows the user to set an upper bound on the amount of time it takes for\nsemantic enrichment to finish processing before the request fails.", + "type": { + "$id": "2481", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.semanticMaxWaitInMilliseconds", + "serializationOptions": { + "$id": "2482", + "json": { + "$id": "2483", + "name": "semanticMaxWaitInMilliseconds" + } + } + }, + { + "$id": "2484", + "kind": "property", + "name": "semanticQuery", + "serializedName": "semanticQuery", + "doc": "Allows setting a separate search query that will be solely used for semantic\nreranking, semantic captions and semantic answers. Is useful for scenarios\nwhere there is a need to use different queries between the base retrieval and\nranking phase, and the L2 semantic phase.", + "type": { + "$id": "2485", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.semanticQuery", + "serializationOptions": { + "$id": "2486", + "json": { + "$id": "2487", + "name": "semanticQuery" + } + } + }, + { + "$id": "2488", + "kind": "property", + "name": "answers", + "serializedName": "answers", + "doc": "A value that specifies whether answers should be returned as part of the search\nresponse.", + "type": { + "$ref": "28" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.answers", + "serializationOptions": { + "$id": "2489", + "json": { + "$id": "2490", + "name": "answers" + } + } + }, + { + "$id": "2491", + "kind": "property", + "name": "captions", + "serializedName": "captions", + "doc": "A value that specifies whether captions should be returned as part of the\nsearch response.", + "type": { + "$ref": "34" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.captions", + "serializationOptions": { + "$id": "2492", + "json": { + "$id": "2493", + "name": "captions" + } + } + }, + { + "$id": "2494", + "kind": "property", + "name": "queryRewrites", + "serializedName": "queryRewrites", + "doc": "A value that specifies whether query rewrites should be generated to augment\nthe search query.", + "type": { + "$ref": "40" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.queryRewrites", + "serializationOptions": { + "$id": "2495", + "json": { + "$id": "2496", + "name": "queryRewrites" + } + } + }, + { + "$id": "2497", + "kind": "property", + "name": "semanticFields", + "serializedName": "semanticFields", + "doc": "The comma-separated list of field names used for semantic ranking.", + "type": { + "$id": "2498", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.semanticFields", + "serializationOptions": { + "$id": "2499", + "json": { + "$id": "2500", + "name": "semanticFields" + } + } + }, + { + "$id": "2501", + "kind": "property", + "name": "vectorQueries", + "serializedName": "vectorQueries", + "doc": "The query parameters for vector and hybrid search queries.", + "type": { + "$id": "2502", + "kind": "array", + "name": "ArrayVectorQuery", + "valueType": { + "$id": "2503", + "kind": "model", + "name": "VectorQuery", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.VectorQuery", + "usage": "Input,Output,Json", + "doc": "The query parameters for vector and hybrid search queries.", + "decorators": [], + "discriminatorProperty": { + "$id": "2504", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "Type of query.", + "type": { + "$ref": "216" + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorQuery.kind", + "serializationOptions": { + "$id": "2505", + "json": { + "$id": "2506", + "name": "kind" + } + } + }, + "properties": [ + { + "$id": "2507", + "kind": "property", + "name": "kNearestNeighbors", + "serializedName": "k", + "doc": "Number of nearest neighbors to return as top hits.", + "type": { + "$id": "2508", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorQuery.k", + "serializationOptions": { + "$id": "2509", + "json": { + "$id": "2510", + "name": "k" + } + } + }, + { + "$id": "2511", + "kind": "property", + "name": "fields", + "serializedName": "fields", + "doc": "Vector Fields of type Collection(Edm.Single) to be included in the vector\nsearched.", + "type": { + "$id": "2512", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorQuery.fields", + "serializationOptions": { + "$id": "2513", + "json": { + "$id": "2514", + "name": "fields" + } + } + }, + { + "$id": "2515", + "kind": "property", + "name": "exhaustive", + "serializedName": "exhaustive", + "doc": "When true, triggers an exhaustive k-nearest neighbor search across all vectors\nwithin the vector index. Useful for scenarios where exact matches are critical,\nsuch as determining ground truth values.", + "type": { + "$id": "2516", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorQuery.exhaustive", + "serializationOptions": { + "$id": "2517", + "json": { + "$id": "2518", + "name": "exhaustive" + } + } + }, + { + "$id": "2519", + "kind": "property", + "name": "oversampling", + "serializedName": "oversampling", + "doc": "Oversampling factor. Minimum value is 1. It overrides the 'defaultOversampling'\nparameter configured in the index definition. It can be set only when 'rerankWithOriginalVectors'\nis true. This parameter is only permitted when a\ncompression method is used on the underlying vector field.", + "type": { + "$id": "2520", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorQuery.oversampling", + "serializationOptions": { + "$id": "2521", + "json": { + "$id": "2522", + "name": "oversampling" + } + } + }, + { + "$id": "2523", + "kind": "property", + "name": "weight", + "serializedName": "weight", + "doc": "Relative weight of the vector query when compared to other vector query and/or\nthe text query within the same search request. This value is used when\ncombining the results of multiple ranking lists produced by the different\nvector queries and/or the results retrieved through the text query. The higher\nthe weight, the higher the documents that matched that query will be in the\nfinal ranking. Default is 1.0 and the value needs to be a positive number\nlarger than zero.", + "type": { + "$id": "2524", + "kind": "float32", + "name": "float32", + "crossLanguageDefinitionId": "TypeSpec.float32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorQuery.weight", + "serializationOptions": { + "$id": "2525", + "json": { + "$id": "2526", + "name": "weight" + } + } + }, + { + "$id": "2527", + "kind": "property", + "name": "threshold", + "serializedName": "threshold", + "doc": "The threshold used for vector queries. Note this can only be set if all 'fields' use the same similarity metric.", + "type": { + "$id": "2528", + "kind": "model", + "name": "VectorThreshold", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.VectorThreshold", + "usage": "Input,Output,Json", + "doc": "The threshold used for vector queries.", + "decorators": [], + "discriminatorProperty": { + "$id": "2529", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "Type of threshold.", + "type": { + "$ref": "210" + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorThreshold.kind", + "serializationOptions": { + "$id": "2530", + "json": { + "$id": "2531", + "name": "kind" + } + } + }, + "properties": [ + { + "$ref": "2529" + } + ], + "discriminatedSubtypes": { + "$id": "2532", + "vectorSimilarity": { + "$id": "2533", + "kind": "model", + "name": "VectorSimilarityThreshold", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.VectorSimilarityThreshold", + "usage": "Input,Output,Json", + "doc": "The results of the vector query will be filtered based on the vector similarity\nmetric. Note this is the canonical definition of similarity metric, not the 'distance'\nversion. The threshold direction (larger or smaller) will be chosen\nautomatically according to the metric used by the field.", + "discriminatorValue": "vectorSimilarity", + "decorators": [], + "baseModel": { + "$ref": "2528" + }, + "properties": [ + { + "$id": "2534", + "kind": "property", + "name": "value", + "serializedName": "value", + "doc": "The threshold will filter based on the similarity metric value. Note this is\nthe canonical definition of similarity metric, not the 'distance' version. The\nthreshold direction (larger or smaller) will be chosen automatically according\nto the metric used by the field.", + "type": { + "$id": "2535", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSimilarityThreshold.value", + "serializationOptions": { + "$id": "2536", + "json": { + "$id": "2537", + "name": "value" + } + } + }, + { + "$id": "2538", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "The kind of threshold used to filter vector queries", + "type": { + "$id": "2539", + "kind": "constant", + "valueType": { + "$id": "2540", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "vectorSimilarity", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSimilarityThreshold.kind", + "serializationOptions": { + "$id": "2541", + "json": { + "$id": "2542", + "name": "kind" + } + } + } + ] + }, + "searchScore": { + "$id": "2543", + "kind": "model", + "name": "SearchScoreThreshold", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchScoreThreshold", + "usage": "Input,Output,Json", + "doc": "The results of the vector query will filter based on the '@search.score' value.\nNote this is the @search.score returned as part of the search response. The\nthreshold direction will be chosen for higher @search.score.", + "discriminatorValue": "searchScore", + "decorators": [], + "baseModel": { + "$ref": "2528" + }, + "properties": [ + { + "$id": "2544", + "kind": "property", + "name": "value", + "serializedName": "value", + "doc": "The threshold will filter based on the '@search.score' value. Note this is the\n@search.score returned as part of the search response. The threshold direction\nwill be chosen for higher @search.score.", + "type": { + "$id": "2545", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchScoreThreshold.value", + "serializationOptions": { + "$id": "2546", + "json": { + "$id": "2547", + "name": "value" + } + } + }, + { + "$id": "2548", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "The kind of threshold used to filter vector queries", + "type": { + "$id": "2549", + "kind": "constant", + "valueType": { + "$id": "2550", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "searchScore", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchScoreThreshold.kind", + "serializationOptions": { + "$id": "2551", + "json": { + "$id": "2552", + "name": "kind" + } + } + } + ] + } + } + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorQuery.threshold", + "serializationOptions": { + "$id": "2553", + "json": { + "$id": "2554", + "name": "threshold" + } + } + }, + { + "$id": "2555", + "kind": "property", + "name": "filterOverride", + "serializedName": "filterOverride", + "doc": "The OData filter expression to apply to this specific vector query. If no\nfilter expression is defined at the vector level, the expression defined in the\ntop level filter parameter is used instead.", + "type": { + "$id": "2556", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorQuery.filterOverride", + "serializationOptions": { + "$id": "2557", + "json": { + "$id": "2558", + "name": "filterOverride" + } + } + }, + { + "$ref": "2504" + } + ], + "discriminatedSubtypes": { + "$id": "2559", + "vector": { + "$id": "2560", + "kind": "model", + "name": "VectorizedQuery", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.VectorizedQuery", + "usage": "Input,Output,Json", + "doc": "The query parameters to use for vector search when a raw vector value is\nprovided.", + "discriminatorValue": "vector", + "decorators": [], + "baseModel": { + "$ref": "2503" + }, + "properties": [ + { + "$id": "2561", + "kind": "property", + "name": "vector", + "serializedName": "vector", + "doc": "The vector representation of a search query.", + "type": { + "$id": "2562", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "2563", + "kind": "float32", + "name": "float32", + "crossLanguageDefinitionId": "TypeSpec.float32", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorizedQuery.vector", + "serializationOptions": { + "$id": "2564", + "json": { + "$id": "2565", + "name": "vector" + } + } + }, + { + "$id": "2566", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "The kind of vector query being performed.", + "type": { + "$id": "2567", + "kind": "constant", + "valueType": { + "$id": "2568", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "vector", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorizedQuery.kind", + "serializationOptions": { + "$id": "2569", + "json": { + "$id": "2570", + "name": "kind" + } + } + } + ] + }, + "text": { + "$id": "2571", + "kind": "model", + "name": "VectorizableTextQuery", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.VectorizableTextQuery", + "usage": "Input,Output,Json", + "doc": "The query parameters to use for vector search when a text value that needs to\nbe vectorized is provided.", + "discriminatorValue": "text", + "decorators": [], + "baseModel": { + "$ref": "2503" + }, + "properties": [ + { + "$id": "2572", + "kind": "property", + "name": "text", + "serializedName": "text", + "doc": "The text to be vectorized to perform a vector search query.", + "type": { + "$id": "2573", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorizableTextQuery.text", + "serializationOptions": { + "$id": "2574", + "json": { + "$id": "2575", + "name": "text" + } + } + }, + { + "$id": "2576", + "kind": "property", + "name": "queryRewrites", + "serializedName": "queryRewrites", + "doc": "Can be configured to let a generative model rewrite the query before sending it\nto be vectorized.", + "type": { + "$ref": "40" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorizableTextQuery.queryRewrites", + "serializationOptions": { + "$id": "2577", + "json": { + "$id": "2578", + "name": "queryRewrites" + } + } + }, + { + "$id": "2579", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "The kind of vector query being performed.", + "type": { + "$id": "2580", + "kind": "constant", + "valueType": { + "$id": "2581", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "text", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorizableTextQuery.kind", + "serializationOptions": { + "$id": "2582", + "json": { + "$id": "2583", + "name": "kind" + } + } + } + ] + }, + "imageUrl": { + "$id": "2584", + "kind": "model", + "name": "VectorizableImageUrlQuery", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.VectorizableImageUrlQuery", + "usage": "Input,Output,Json", + "doc": "The query parameters to use for vector search when an url that represents an\nimage value that needs to be vectorized is provided.", + "discriminatorValue": "imageUrl", + "decorators": [], + "baseModel": { + "$ref": "2503" + }, + "properties": [ + { + "$id": "2585", + "kind": "property", + "name": "url", + "serializedName": "url", + "doc": "The URL of an image to be vectorized to perform a vector search query.", + "type": { + "$id": "2586", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorizableImageUrlQuery.url", + "serializationOptions": { + "$id": "2587", + "json": { + "$id": "2588", + "name": "url" + } + } + }, + { + "$id": "2589", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "The kind of vector query being performed.", + "type": { + "$id": "2590", + "kind": "constant", + "valueType": { + "$id": "2591", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "imageUrl", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorizableImageUrlQuery.kind", + "serializationOptions": { + "$id": "2592", + "json": { + "$id": "2593", + "name": "kind" + } + } + } + ] + }, + "imageBinary": { + "$id": "2594", + "kind": "model", + "name": "VectorizableImageBinaryQuery", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.VectorizableImageBinaryQuery", + "usage": "Input,Output,Json", + "doc": "The query parameters to use for vector search when a base 64 encoded binary of\nan image that needs to be vectorized is provided.", + "discriminatorValue": "imageBinary", + "decorators": [], + "baseModel": { + "$ref": "2503" + }, + "properties": [ + { + "$id": "2595", + "kind": "property", + "name": "base64Image", + "serializedName": "base64Image", + "doc": "The base 64 encoded binary of an image to be vectorized to perform a vector\nsearch query.", + "type": { + "$id": "2596", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorizableImageBinaryQuery.base64Image", + "serializationOptions": { + "$id": "2597", + "json": { + "$id": "2598", + "name": "base64Image" + } + } + }, + { + "$id": "2599", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "The kind of vector query being performed.", + "type": { + "$id": "2600", + "kind": "constant", + "valueType": { + "$id": "2601", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "imageBinary", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorizableImageBinaryQuery.kind", + "serializationOptions": { + "$id": "2602", + "json": { + "$id": "2603", + "name": "kind" + } + } + } + ] + } + } + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.vectorQueries", + "serializationOptions": { + "$id": "2604", + "json": { + "$id": "2605", + "name": "vectorQueries" + } + } + }, + { + "$id": "2606", + "kind": "property", + "name": "vectorFilterMode", + "serializedName": "vectorFilterMode", + "doc": "Determines whether or not filters are applied before or after the vector search\nis performed. Default is 'preFilter' for new indexes.", + "type": { + "$ref": "226" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.vectorFilterMode", + "serializationOptions": { + "$id": "2607", + "json": { + "$id": "2608", + "name": "vectorFilterMode" + } + } + }, + { + "$id": "2609", + "kind": "property", + "name": "hybridSearch", + "serializedName": "hybridSearch", + "doc": "The query parameters to configure hybrid search behaviors.", + "type": { + "$id": "2610", + "kind": "model", + "name": "HybridSearch", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.HybridSearch", + "usage": "Input,Output,Json", + "doc": "TThe query parameters to configure hybrid search behaviors.", + "decorators": [], + "properties": [ + { + "$id": "2611", + "kind": "property", + "name": "maxTextRecallSize", + "serializedName": "maxTextRecallSize", + "doc": "Determines the maximum number of documents to be retrieved by the text query\nportion of a hybrid search request. Those documents will be combined with the\ndocuments matching the vector queries to produce a single final list of\nresults. Choosing a larger maxTextRecallSize value will allow retrieving and\npaging through more documents (using the top and skip parameters), at the cost\nof higher resource utilization and higher latency. The value needs to be\nbetween 1 and 10,000. Default is 1000.", + "type": { + "$id": "2612", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.HybridSearch.maxTextRecallSize", + "serializationOptions": { + "$id": "2613", + "json": { + "$id": "2614", + "name": "maxTextRecallSize" + } + } + }, + { + "$id": "2615", + "kind": "property", + "name": "countAndFacetMode", + "serializedName": "countAndFacetMode", + "doc": "Determines whether the count and facets should includes all documents that\nmatched the search query, or only the documents that are retrieved within the 'maxTextRecallSize' window.", + "type": { + "$ref": "232" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.HybridSearch.countAndFacetMode", + "serializationOptions": { + "$id": "2616", + "json": { + "$id": "2617", + "name": "countAndFacetMode" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchRequest.hybridSearch", + "serializationOptions": { + "$id": "2618", + "json": { + "$id": "2619", + "name": "hybridSearch" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchDocumentsResult.nextPageParameters", + "serializationOptions": { + "$id": "2620", + "json": { + "$id": "2621", + "name": "@search.nextPageParameters" + } + } + }, + { + "$id": "2622", + "kind": "property", + "name": "results", + "serializedName": "value", + "doc": "The sequence of results returned by the query.", + "type": { + "$id": "2623", + "kind": "array", + "name": "ArraySearchResult", + "valueType": { + "$id": "2624", + "kind": "model", + "name": "SearchResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchResult", + "usage": "Output,Json", + "doc": "Contains a document found by a search query, plus associated metadata.", + "decorators": [], + "additionalProperties": { + "$id": "2625", + "kind": "unknown", + "name": "unknown", + "crossLanguageDefinitionId": "", + "decorators": [] + }, + "properties": [ + { + "$id": "2626", + "kind": "property", + "name": "score", + "serializedName": "@search.score", + "doc": "The relevance score of the document compared to other documents returned by the\nquery.", + "type": { + "$id": "2627", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchResult.score", + "serializationOptions": { + "$id": "2628", + "json": { + "$id": "2629", + "name": "@search.score" + } + } + }, + { + "$id": "2630", + "kind": "property", + "name": "rerankerScore", + "serializedName": "@search.rerankerScore", + "doc": "The relevance score computed by the semantic ranker for the top search results.\nSearch results are sorted by the RerankerScore first and then by the Score.\nRerankerScore is only returned for queries of type 'semantic'.", + "type": { + "$id": "2631", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchResult.rerankerScore", + "serializationOptions": { + "$id": "2632", + "json": { + "$id": "2633", + "name": "@search.rerankerScore" + } + } + }, + { + "$id": "2634", + "kind": "property", + "name": "highlights", + "serializedName": "@search.highlights", + "doc": "Text fragments from the document that indicate the matching search terms,\norganized by each applicable field; null if hit highlighting was not enabled\nfor the query.", + "type": { + "$id": "2635", + "kind": "dict", + "keyType": { + "$id": "2636", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "valueType": { + "$id": "2637", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "2638", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchResult.highlights", + "serializationOptions": { + "$id": "2639", + "json": { + "$id": "2640", + "name": "@search.highlights" + } + } + }, + { + "$id": "2641", + "kind": "property", + "name": "captions", + "serializedName": "@search.captions", + "doc": "Captions are the most representative passages from the document relatively to\nthe search query. They are often used as document summary. Captions are only\nreturned for queries of type 'semantic'.", + "type": { + "$id": "2642", + "kind": "array", + "name": "ArrayQueryCaptionResult", + "valueType": { + "$id": "2643", + "kind": "model", + "name": "QueryCaptionResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.QueryCaptionResult", + "usage": "Output,Json", + "doc": "Captions are the most representative passages from the document relatively to\nthe search query. They are often used as document summary. Captions are only\nreturned for queries of type `semantic`.", + "decorators": [], + "additionalProperties": { + "$id": "2644", + "kind": "unknown", + "name": "unknown", + "crossLanguageDefinitionId": "", + "decorators": [] + }, + "properties": [ + { + "$id": "2645", + "kind": "property", + "name": "text", + "serializedName": "text", + "doc": "A representative text passage extracted from the document most relevant to the\nsearch query.", + "type": { + "$id": "2646", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryCaptionResult.text", + "serializationOptions": { + "$id": "2647", + "json": { + "$id": "2648", + "name": "text" + } + } + }, + { + "$id": "2649", + "kind": "property", + "name": "highlights", + "serializedName": "highlights", + "doc": "Same text passage as in the Text property with highlighted phrases most\nrelevant to the query.", + "type": { + "$id": "2650", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryCaptionResult.highlights", + "serializationOptions": { + "$id": "2651", + "json": { + "$id": "2652", + "name": "highlights" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchResult.captions", + "serializationOptions": { + "$id": "2653", + "json": { + "$id": "2654", + "name": "@search.captions" + } + } + }, + { + "$id": "2655", + "kind": "property", + "name": "documentDebugInfo", + "serializedName": "@search.documentDebugInfo", + "doc": "Contains debugging information that can be used to further explore your search\nresults.", + "type": { + "$id": "2656", + "kind": "array", + "name": "ArrayDocumentDebugInfo", + "valueType": { + "$id": "2657", + "kind": "model", + "name": "DocumentDebugInfo", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.DocumentDebugInfo", + "usage": "Output,Json", + "doc": "Contains debugging information that can be used to further explore your search\nresults.", + "decorators": [], + "properties": [ + { + "$id": "2658", + "kind": "property", + "name": "semantic", + "serializedName": "semantic", + "doc": "Contains debugging information specific to semantic ranking requests.", + "type": { + "$id": "2659", + "kind": "model", + "name": "SemanticDebugInfo", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SemanticDebugInfo", + "usage": "Output,Json", + "doc": "Contains debugging information specific to semantic ranking requests.", + "decorators": [], + "properties": [ + { + "$id": "2660", + "kind": "property", + "name": "titleField", + "serializedName": "titleField", + "doc": "The title field that was sent to the semantic enrichment process, as well as\nhow it was used", + "type": { + "$id": "2661", + "kind": "model", + "name": "QueryResultDocumentSemanticField", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.QueryResultDocumentSemanticField", + "usage": "Output,Json", + "doc": "Description of fields that were sent to the semantic enrichment process, as\nwell as how they were used", + "decorators": [], + "properties": [ + { + "$id": "2662", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the field that was sent to the semantic enrichment process", + "type": { + "$id": "2663", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryResultDocumentSemanticField.name", + "serializationOptions": { + "$id": "2664", + "json": { + "$id": "2665", + "name": "name" + } + } + }, + { + "$id": "2666", + "kind": "property", + "name": "state", + "serializedName": "state", + "doc": "The way the field was used for the semantic enrichment process (fully used,\npartially used, or unused)", + "type": { + "$ref": "238" + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryResultDocumentSemanticField.state", + "serializationOptions": { + "$id": "2667", + "json": { + "$id": "2668", + "name": "state" + } + } + } + ] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SemanticDebugInfo.titleField", + "serializationOptions": { + "$id": "2669", + "json": { + "$id": "2670", + "name": "titleField" + } + } + }, + { + "$id": "2671", + "kind": "property", + "name": "contentFields", + "serializedName": "contentFields", + "doc": "The content fields that were sent to the semantic enrichment process, as well\nas how they were used", + "type": { + "$id": "2672", + "kind": "array", + "name": "ArrayQueryResultDocumentSemanticField", + "valueType": { + "$ref": "2661" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SemanticDebugInfo.contentFields", + "serializationOptions": { + "$id": "2673", + "json": { + "$id": "2674", + "name": "contentFields" + } + } + }, + { + "$id": "2675", + "kind": "property", + "name": "keywordFields", + "serializedName": "keywordFields", + "doc": "The keyword fields that were sent to the semantic enrichment process, as well\nas how they were used", + "type": { + "$id": "2676", + "kind": "array", + "name": "ArrayQueryResultDocumentSemanticField", + "valueType": { + "$ref": "2661" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SemanticDebugInfo.keywordFields", + "serializationOptions": { + "$id": "2677", + "json": { + "$id": "2678", + "name": "keywordFields" + } + } + }, + { + "$id": "2679", + "kind": "property", + "name": "rerankerInput", + "serializedName": "rerankerInput", + "doc": "The raw concatenated strings that were sent to the semantic enrichment process.", + "type": { + "$id": "2680", + "kind": "model", + "name": "QueryResultDocumentRerankerInput", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.QueryResultDocumentRerankerInput", + "usage": "Output,Json", + "doc": "The raw concatenated strings that were sent to the semantic enrichment process.", + "decorators": [], + "properties": [ + { + "$id": "2681", + "kind": "property", + "name": "title", + "serializedName": "title", + "doc": "The raw string for the title field that was used for semantic enrichment.", + "type": { + "$id": "2682", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryResultDocumentRerankerInput.title", + "serializationOptions": { + "$id": "2683", + "json": { + "$id": "2684", + "name": "title" + } + } + }, + { + "$id": "2685", + "kind": "property", + "name": "content", + "serializedName": "content", + "doc": "The raw concatenated strings for the content fields that were used for semantic\nenrichment.", + "type": { + "$id": "2686", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryResultDocumentRerankerInput.content", + "serializationOptions": { + "$id": "2687", + "json": { + "$id": "2688", + "name": "content" + } + } + }, + { + "$id": "2689", + "kind": "property", + "name": "keywords", + "serializedName": "keywords", + "doc": "The raw concatenated strings for the keyword fields that were used for semantic\nenrichment.", + "type": { + "$id": "2690", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryResultDocumentRerankerInput.keywords", + "serializationOptions": { + "$id": "2691", + "json": { + "$id": "2692", + "name": "keywords" + } + } + } + ] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SemanticDebugInfo.rerankerInput", + "serializationOptions": { + "$id": "2693", + "json": { + "$id": "2694", + "name": "rerankerInput" + } + } + } + ] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DocumentDebugInfo.semantic", + "serializationOptions": { + "$id": "2695", + "json": { + "$id": "2696", + "name": "semantic" + } + } + }, + { + "$id": "2697", + "kind": "property", + "name": "vectors", + "serializedName": "vectors", + "doc": "Contains debugging information specific to vector and hybrid search.", + "type": { + "$id": "2698", + "kind": "model", + "name": "VectorsDebugInfo", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.VectorsDebugInfo", + "usage": "Output,Json", + "doc": "\"Contains debugging information specific to vector and hybrid search.\")", + "decorators": [], + "properties": [ + { + "$id": "2699", + "kind": "property", + "name": "subscores", + "serializedName": "subscores", + "doc": "The breakdown of subscores of the document prior to the chosen result set\nfusion/combination method such as RRF.", + "type": { + "$id": "2700", + "kind": "model", + "name": "QueryResultDocumentSubscores", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.QueryResultDocumentSubscores", + "usage": "Output,Json", + "doc": "The breakdown of subscores between the text and vector query components of the\nsearch query for this document. Each vector query is shown as a separate object\nin the same order they were received.", + "decorators": [], + "properties": [ + { + "$id": "2701", + "kind": "property", + "name": "text", + "serializedName": "text", + "doc": "The BM25 or Classic score for the text portion of the query.", + "type": { + "$id": "2702", + "kind": "model", + "name": "TextResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.TextResult", + "usage": "Output,Json", + "doc": "The BM25 or Classic score for the text portion of the query.", + "decorators": [], + "properties": [ + { + "$id": "2703", + "kind": "property", + "name": "searchScore", + "serializedName": "searchScore", + "doc": "The BM25 or Classic score for the text portion of the query.", + "type": { + "$id": "2704", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.TextResult.searchScore", + "serializationOptions": { + "$id": "2705", + "json": { + "$id": "2706", + "name": "searchScore" + } + } + } + ] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryResultDocumentSubscores.text", + "serializationOptions": { + "$id": "2707", + "json": { + "$id": "2708", + "name": "text" + } + } + }, + { + "$id": "2709", + "kind": "property", + "name": "vectors", + "serializedName": "vectors", + "doc": "The vector similarity and @search.score values for each vector query.", + "type": { + "$id": "2710", + "kind": "array", + "name": "ArrayRecord", + "valueType": { + "$id": "2711", + "kind": "dict", + "keyType": { + "$id": "2712", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "valueType": { + "$id": "2713", + "kind": "model", + "name": "SingleVectorFieldResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SingleVectorFieldResult", + "usage": "Output,Json", + "doc": "A single vector field result. Both @search.score and vector similarity values\nare returned. Vector similarity is related to @search.score by an equation.", + "decorators": [], + "properties": [ + { + "$id": "2714", + "kind": "property", + "name": "searchScore", + "serializedName": "searchScore", + "doc": "The @search.score value that is calculated from the vector similarity score.\nThis is the score that's visible in a pure single-field single-vector query.", + "type": { + "$id": "2715", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SingleVectorFieldResult.searchScore", + "serializationOptions": { + "$id": "2716", + "json": { + "$id": "2717", + "name": "searchScore" + } + } + }, + { + "$id": "2718", + "kind": "property", + "name": "vectorSimilarity", + "serializedName": "vectorSimilarity", + "doc": "The vector similarity score for this document. Note this is the canonical\ndefinition of similarity metric, not the 'distance' version. For example,\ncosine similarity instead of cosine distance.", + "type": { + "$id": "2719", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SingleVectorFieldResult.vectorSimilarity", + "serializationOptions": { + "$id": "2720", + "json": { + "$id": "2721", + "name": "vectorSimilarity" + } + } + } + ] + }, + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryResultDocumentSubscores.vectors", + "serializationOptions": { + "$id": "2722", + "json": { + "$id": "2723", + "name": "vectors" + } + } + }, + { + "$id": "2724", + "kind": "property", + "name": "documentBoost", + "serializedName": "documentBoost", + "doc": "The BM25 or Classic score for the text portion of the query.", + "type": { + "$id": "2725", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.QueryResultDocumentSubscores.documentBoost", + "serializationOptions": { + "$id": "2726", + "json": { + "$id": "2727", + "name": "documentBoost" + } + } + } + ] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorsDebugInfo.subscores", + "serializationOptions": { + "$id": "2728", + "json": { + "$id": "2729", + "name": "subscores" + } + } + } + ] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DocumentDebugInfo.vectors", + "serializationOptions": { + "$id": "2730", + "json": { + "$id": "2731", + "name": "vectors" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchResult.documentDebugInfo", + "serializationOptions": { + "$id": "2732", + "json": { + "$id": "2733", + "name": "@search.documentDebugInfo" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchDocumentsResult.value", + "serializationOptions": { + "$id": "2734", + "json": { + "$id": "2735", + "name": "value" + } + } + }, + { + "$id": "2736", + "kind": "property", + "name": "nextLink", + "serializedName": "@odata.nextLink", + "doc": "Continuation URL returned when the query can't return all the requested results\nin a single response. You can use this URL to formulate another GET or POST\nSearch request to get the next part of the search response. Make sure to use\nthe same verb (GET or POST) as the request that produced this response.", + "type": { + "$id": "2737", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchDocumentsResult.nextLink", + "serializationOptions": { + "$id": "2738", + "json": { + "$id": "2739", + "name": "@odata.nextLink" + } + } + }, + { + "$id": "2740", + "kind": "property", + "name": "semanticPartialResponseReason", + "serializedName": "@search.semanticPartialResponseReason", + "doc": "Reason that a partial response was returned for a semantic ranking request.", + "type": { + "$ref": "246" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchDocumentsResult.semanticPartialResponseReason", + "serializationOptions": { + "$id": "2741", + "json": { + "$id": "2742", + "name": "@search.semanticPartialResponseReason" + } + } + }, + { + "$id": "2743", + "kind": "property", + "name": "semanticPartialResponseType", + "serializedName": "@search.semanticPartialResponseType", + "doc": "Type of partial response that was returned for a semantic ranking request.", + "type": { + "$ref": "254" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchDocumentsResult.semanticPartialResponseType", + "serializationOptions": { + "$id": "2744", + "json": { + "$id": "2745", + "name": "@search.semanticPartialResponseType" + } + } + }, + { + "$id": "2746", + "kind": "property", + "name": "semanticQueryRewritesResultType", + "serializedName": "@search.semanticQueryRewritesResultType", + "doc": "Type of query rewrite that was used to retrieve documents.", + "type": { + "$ref": "260" + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchDocumentsResult.semanticQueryRewritesResultType", + "serializationOptions": { + "$id": "2747", + "json": { + "$id": "2748", + "name": "@search.semanticQueryRewritesResultType" + } + } + } + ] + }, + { + "$ref": "2322" + }, + { + "$ref": "2342" + }, + { + "$ref": "2363" + }, + { + "$ref": "2365" + }, + { + "$ref": "2367" + }, + { + "$ref": "2388" + }, + { + "$ref": "2503" + }, + { + "$ref": "2528" + }, + { + "$ref": "2533" + }, + { + "$ref": "2543" + }, + { + "$ref": "2560" + }, + { + "$ref": "2571" + }, + { + "$ref": "2584" + }, + { + "$ref": "2594" + }, + { + "$ref": "2610" + }, + { + "$ref": "2624" + }, + { + "$ref": "2643" + }, + { + "$ref": "2657" + }, + { + "$ref": "2659" + }, + { + "$ref": "2661" + }, + { + "$ref": "2680" + }, + { + "$ref": "2698" + }, + { + "$ref": "2700" + }, + { + "$ref": "2702" + }, + { + "$ref": "2713" + }, + { + "$id": "2749", + "kind": "model", + "name": "LookupDocument", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.LookupDocument", + "usage": "Output,Json", + "doc": "A document retrieved via a document lookup operation.", + "decorators": [], + "additionalProperties": { + "$id": "2750", + "kind": "unknown", + "name": "unknown", + "crossLanguageDefinitionId": "", + "decorators": [] + }, + "properties": [] + }, + { + "$id": "2751", + "kind": "model", + "name": "SuggestDocumentsResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SuggestDocumentsResult", + "usage": "Output,Json", + "doc": "Response containing suggestion query results from an index.", + "decorators": [], + "properties": [ + { + "$id": "2752", + "kind": "property", + "name": "results", + "serializedName": "value", + "doc": "The sequence of results returned by the query.", + "type": { + "$id": "2753", + "kind": "array", + "name": "ArraySuggestResult", + "valueType": { + "$id": "2754", + "kind": "model", + "name": "SuggestResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SuggestResult", + "usage": "Output,Json", + "doc": "A result containing a document found by a suggestion query, plus associated\nmetadata.", + "decorators": [], + "additionalProperties": { + "$id": "2755", + "kind": "unknown", + "name": "unknown", + "crossLanguageDefinitionId": "", + "decorators": [] + }, + "properties": [ + { + "$id": "2756", + "kind": "property", + "name": "text", + "serializedName": "@search.text", + "doc": "The text of the suggestion result.", + "type": { + "$id": "2757", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SuggestResult.text", + "serializationOptions": { + "$id": "2758", + "json": { + "$id": "2759", + "name": "@search.text" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SuggestDocumentsResult.value", + "serializationOptions": { + "$id": "2760", + "json": { + "$id": "2761", + "name": "value" + } + } + }, + { + "$id": "2762", + "kind": "property", + "name": "coverage", + "serializedName": "@search.coverage", + "doc": "A value indicating the percentage of the index that was included in the query,\nor null if minimumCoverage was not set in the request.", + "type": { + "$id": "2763", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SuggestDocumentsResult.coverage", + "serializationOptions": { + "$id": "2764", + "json": { + "$id": "2765", + "name": "@search.coverage" + } + } + } + ] + }, + { + "$ref": "2754" + }, + { + "$id": "2766", + "kind": "model", + "name": "SuggestRequest", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SuggestRequest", + "usage": "Input,Json", + "doc": "Parameters for filtering, sorting, fuzzy matching, and other suggestions query\nbehaviors.", + "decorators": [], + "properties": [ + { + "$id": "2767", + "kind": "property", + "name": "filter", + "serializedName": "filter", + "doc": "An OData expression that filters the documents considered for suggestions.", + "type": { + "$id": "2768", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SuggestRequest.filter", + "serializationOptions": { + "$id": "2769", + "json": { + "$id": "2770", + "name": "filter" + } + } + }, + { + "$id": "2771", + "kind": "property", + "name": "useFuzzyMatching", + "serializedName": "fuzzy", + "doc": "A value indicating whether to use fuzzy matching for the suggestion query.\nDefault is false. When set to true, the query will find suggestions even if\nthere's a substituted or missing character in the search text. While this\nprovides a better experience in some scenarios, it comes at a performance cost\nas fuzzy suggestion searches are slower and consume more resources.", + "type": { + "$id": "2772", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SuggestRequest.fuzzy", + "serializationOptions": { + "$id": "2773", + "json": { + "$id": "2774", + "name": "fuzzy" + } + } + }, + { + "$id": "2775", + "kind": "property", + "name": "highlightPostTag", + "serializedName": "highlightPostTag", + "doc": "A string tag that is appended to hit highlights. Must be set with\nhighlightPreTag. If omitted, hit highlighting of suggestions is disabled.", + "type": { + "$id": "2776", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SuggestRequest.highlightPostTag", + "serializationOptions": { + "$id": "2777", + "json": { + "$id": "2778", + "name": "highlightPostTag" + } + } + }, + { + "$id": "2779", + "kind": "property", + "name": "highlightPreTag", + "serializedName": "highlightPreTag", + "doc": "A string tag that is prepended to hit highlights. Must be set with\nhighlightPostTag. If omitted, hit highlighting of suggestions is disabled.", + "type": { + "$id": "2780", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SuggestRequest.highlightPreTag", + "serializationOptions": { + "$id": "2781", + "json": { + "$id": "2782", + "name": "highlightPreTag" + } + } + }, + { + "$id": "2783", + "kind": "property", + "name": "minimumCoverage", + "serializedName": "minimumCoverage", + "doc": "A number between 0 and 100 indicating the percentage of the index that must be\ncovered by a suggestion query in order for the query to be reported as a\nsuccess. This parameter can be useful for ensuring search availability even for\nservices with only one replica. The default is 80.", + "type": { + "$id": "2784", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SuggestRequest.minimumCoverage", + "serializationOptions": { + "$id": "2785", + "json": { + "$id": "2786", + "name": "minimumCoverage" + } + } + }, + { + "$id": "2787", + "kind": "property", + "name": "orderBy", + "serializedName": "orderby", + "doc": "The comma-separated list of OData $orderby expressions by which to sort the\nresults. Each expression can be either a field name or a call to either the\ngeo.distance() or the search.score() functions. Each expression can be followed\nby asc to indicate ascending, or desc to indicate descending. The default is\nascending order. Ties will be broken by the match scores of documents. If no\n$orderby is specified, the default sort order is descending by document match\nscore. There can be at most 32 $orderby clauses.", + "type": { + "$id": "2788", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SuggestRequest.orderby", + "serializationOptions": { + "$id": "2789", + "json": { + "$id": "2790", + "name": "orderby" + } + } + }, + { + "$id": "2791", + "kind": "property", + "name": "searchText", + "serializedName": "search", + "doc": "The search text to use to suggest documents. Must be at least 1 character, and\nno more than 100 characters.", + "type": { + "$id": "2792", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SuggestRequest.search", + "serializationOptions": { + "$id": "2793", + "json": { + "$id": "2794", + "name": "search" + } + } + }, + { + "$id": "2795", + "kind": "property", + "name": "searchFields", + "serializedName": "searchFields", + "doc": "The comma-separated list of field names to search for the specified search\ntext. Target fields must be included in the specified suggester.", + "type": { + "$id": "2796", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SuggestRequest.searchFields", + "serializationOptions": { + "$id": "2797", + "json": { + "$id": "2798", + "name": "searchFields" + } + } + }, + { + "$id": "2799", + "kind": "property", + "name": "select", + "serializedName": "select", + "doc": "The comma-separated list of fields to retrieve. If unspecified, only the key\nfield will be included in the results.", + "type": { + "$id": "2800", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SuggestRequest.select", + "serializationOptions": { + "$id": "2801", + "json": { + "$id": "2802", + "name": "select" + } + } + }, + { + "$id": "2803", + "kind": "property", + "name": "suggesterName", + "serializedName": "suggesterName", + "doc": "The name of the suggester as specified in the suggesters collection that's part\nof the index definition.", + "type": { + "$id": "2804", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SuggestRequest.suggesterName", + "serializationOptions": { + "$id": "2805", + "json": { + "$id": "2806", + "name": "suggesterName" + } + } + }, + { + "$id": "2807", + "kind": "property", + "name": "top", + "serializedName": "top", + "doc": "The number of suggestions to retrieve. This must be a value between 1 and 100.\nThe default is 5.", + "type": { + "$id": "2808", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SuggestRequest.top", + "serializationOptions": { + "$id": "2809", + "json": { + "$id": "2810", + "name": "top" + } + } + } + ] + }, + { + "$id": "2811", + "kind": "model", + "name": "IndexBatch", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.IndexBatch", + "usage": "Input,Json", + "doc": "Contains a batch of document write actions to send to the index.", + "decorators": [], + "properties": [ + { + "$id": "2812", + "kind": "property", + "name": "actions", + "serializedName": "value", + "doc": "The actions in the batch.", + "type": { + "$id": "2813", + "kind": "array", + "name": "ArrayIndexAction", + "valueType": { + "$id": "2814", + "kind": "model", + "name": "IndexAction", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.IndexAction", + "usage": "Input,Json", + "doc": "Represents an index action that operates on a document.", + "decorators": [], + "additionalProperties": { + "$id": "2815", + "kind": "unknown", + "name": "unknown", + "crossLanguageDefinitionId": "", + "decorators": [] + }, + "properties": [ + { + "$id": "2816", + "kind": "property", + "name": "actionType", + "serializedName": "@search.action", + "doc": "The operation to perform on a document in an indexing batch.", + "type": { + "$ref": "264" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexAction.actionType", + "serializationOptions": { + "$id": "2817", + "json": { + "$id": "2818", + "name": "@search.action" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexBatch.value", + "serializationOptions": { + "$id": "2819", + "json": { + "$id": "2820", + "name": "value" + } + } + } + ] + }, + { + "$ref": "2814" + }, + { + "$id": "2821", + "kind": "model", + "name": "IndexDocumentsResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.IndexDocumentsResult", + "usage": "Output,Json", + "doc": "Response containing the status of operations for all documents in the indexing\nrequest.", + "decorators": [], + "properties": [ + { + "$id": "2822", + "kind": "property", + "name": "results", + "serializedName": "value", + "doc": "The list of status information for each document in the indexing request.", + "type": { + "$id": "2823", + "kind": "array", + "name": "ArrayIndexingResult", + "valueType": { + "$id": "2824", + "kind": "model", + "name": "IndexingResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.IndexingResult", + "usage": "Output,Json", + "doc": "Status of an indexing operation for a single document.", + "decorators": [], + "properties": [ + { + "$id": "2825", + "kind": "property", + "name": "key", + "serializedName": "key", + "doc": "The key of a document that was in the indexing request.", + "type": { + "$id": "2826", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingResult.key", + "serializationOptions": { + "$id": "2827", + "json": { + "$id": "2828", + "name": "key" + } + } + }, + { + "$id": "2829", + "kind": "property", + "name": "errorMessage", + "serializedName": "errorMessage", + "doc": "The error message explaining why the indexing operation failed for the document\nidentified by the key; null if indexing succeeded.", + "type": { + "$id": "2830", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingResult.errorMessage", + "serializationOptions": { + "$id": "2831", + "json": { + "$id": "2832", + "name": "errorMessage" + } + } + }, + { + "$id": "2833", + "kind": "property", + "name": "succeeded", + "serializedName": "status", + "doc": "A value indicating whether the indexing operation succeeded for the document\nidentified by the key.", + "type": { + "$id": "2834", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingResult.status", + "serializationOptions": { + "$id": "2835", + "json": { + "$id": "2836", + "name": "status" + } + } + }, + { + "$id": "2837", + "kind": "property", + "name": "statusCode", + "serializedName": "statusCode", + "doc": "The status code of the indexing operation. Possible values include: 200 for a\nsuccessful update or delete, 201 for successful document creation, 400 for a\nmalformed input document, 404 for document not found, 409 for a version\nconflict, 422 when the index is temporarily unavailable, or 503 for when the\nservice is too busy.", + "type": { + "$id": "2838", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingResult.statusCode", + "serializationOptions": { + "$id": "2839", + "json": { + "$id": "2840", + "name": "statusCode" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexDocumentsResult.value", + "serializationOptions": { + "$id": "2841", + "json": { + "$id": "2842", + "name": "value" + } + } + } + ] + }, + { + "$ref": "2824" + }, + { + "$id": "2843", + "kind": "model", + "name": "AutocompleteResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AutocompleteResult", + "usage": "Output,Json", + "doc": "The result of Autocomplete query.", + "decorators": [], + "properties": [ + { + "$id": "2844", + "kind": "property", + "name": "coverage", + "serializedName": "@search.coverage", + "doc": "A value indicating the percentage of the index that was considered by the\nautocomplete request, or null if minimumCoverage was not specified in the\nrequest.", + "type": { + "$id": "2845", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AutocompleteResult.coverage", + "serializationOptions": { + "$id": "2846", + "json": { + "$id": "2847", + "name": "@search.coverage" + } + } + }, + { + "$id": "2848", + "kind": "property", + "name": "results", + "serializedName": "value", + "doc": "The list of returned Autocompleted items.", + "type": { + "$id": "2849", + "kind": "array", + "name": "ArrayAutocompleteItem", + "valueType": { + "$id": "2850", + "kind": "model", + "name": "AutocompleteItem", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AutocompleteItem", + "usage": "Output,Json", + "doc": "The result of Autocomplete requests.", + "decorators": [], + "properties": [ + { + "$id": "2851", + "kind": "property", + "name": "text", + "serializedName": "text", + "doc": "The completed term.", + "type": { + "$id": "2852", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AutocompleteItem.text", + "serializationOptions": { + "$id": "2853", + "json": { + "$id": "2854", + "name": "text" + } + } + }, + { + "$id": "2855", + "kind": "property", + "name": "queryPlusText", + "serializedName": "queryPlusText", + "doc": "The query along with the completed term.", + "type": { + "$id": "2856", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AutocompleteItem.queryPlusText", + "serializationOptions": { + "$id": "2857", + "json": { + "$id": "2858", + "name": "queryPlusText" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AutocompleteResult.value", + "serializationOptions": { + "$id": "2859", + "json": { + "$id": "2860", + "name": "value" + } + } + } + ] + }, + { + "$ref": "2850" + }, + { + "$id": "2861", + "kind": "model", + "name": "AutocompleteRequest", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AutocompleteRequest", + "usage": "Input,Json", + "doc": "Parameters for fuzzy matching, and other autocomplete query behaviors.", + "decorators": [], + "properties": [ + { + "$id": "2862", + "kind": "property", + "name": "searchText", + "serializedName": "search", + "doc": "The search text on which to base autocomplete results.", + "type": { + "$id": "2863", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AutocompleteRequest.search", + "serializationOptions": { + "$id": "2864", + "json": { + "$id": "2865", + "name": "search" + } + } + }, + { + "$id": "2866", + "kind": "property", + "name": "autocompleteMode", + "serializedName": "autocompleteMode", + "doc": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms'\nto get shingles and 'oneTermWithContext' to use the current context while\nproducing auto-completed terms.", + "type": { + "$ref": "274" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AutocompleteRequest.autocompleteMode", + "serializationOptions": { + "$id": "2867", + "json": { + "$id": "2868", + "name": "autocompleteMode" + } + } + }, + { + "$id": "2869", + "kind": "property", + "name": "filter", + "serializedName": "filter", + "doc": "An OData expression that filters the documents used to produce completed terms\nfor the Autocomplete result.", + "type": { + "$id": "2870", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AutocompleteRequest.filter", + "serializationOptions": { + "$id": "2871", + "json": { + "$id": "2872", + "name": "filter" + } + } + }, + { + "$id": "2873", + "kind": "property", + "name": "useFuzzyMatching", + "serializedName": "fuzzy", + "doc": "A value indicating whether to use fuzzy matching for the autocomplete query.\nDefault is false. When set to true, the query will autocomplete terms even if\nthere's a substituted or missing character in the search text. While this\nprovides a better experience in some scenarios, it comes at a performance cost\nas fuzzy autocomplete queries are slower and consume more resources.", + "type": { + "$id": "2874", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AutocompleteRequest.fuzzy", + "serializationOptions": { + "$id": "2875", + "json": { + "$id": "2876", + "name": "fuzzy" + } + } + }, + { + "$id": "2877", + "kind": "property", + "name": "highlightPostTag", + "serializedName": "highlightPostTag", + "doc": "A string tag that is appended to hit highlights. Must be set with\nhighlightPreTag. If omitted, hit highlighting is disabled.", + "type": { + "$id": "2878", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AutocompleteRequest.highlightPostTag", + "serializationOptions": { + "$id": "2879", + "json": { + "$id": "2880", + "name": "highlightPostTag" + } + } + }, + { + "$id": "2881", + "kind": "property", + "name": "highlightPreTag", + "serializedName": "highlightPreTag", + "doc": "A string tag that is prepended to hit highlights. Must be set with\nhighlightPostTag. If omitted, hit highlighting is disabled.", + "type": { + "$id": "2882", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AutocompleteRequest.highlightPreTag", + "serializationOptions": { + "$id": "2883", + "json": { + "$id": "2884", + "name": "highlightPreTag" + } + } + }, + { + "$id": "2885", + "kind": "property", + "name": "minimumCoverage", + "serializedName": "minimumCoverage", + "doc": "A number between 0 and 100 indicating the percentage of the index that must be\ncovered by an autocomplete query in order for the query to be reported as a\nsuccess. This parameter can be useful for ensuring search availability even for\nservices with only one replica. The default is 80.", + "type": { + "$id": "2886", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AutocompleteRequest.minimumCoverage", + "serializationOptions": { + "$id": "2887", + "json": { + "$id": "2888", + "name": "minimumCoverage" + } + } + }, + { + "$id": "2889", + "kind": "property", + "name": "searchFields", + "serializedName": "searchFields", + "doc": "The comma-separated list of field names to consider when querying for\nauto-completed terms. Target fields must be included in the specified\nsuggester.", + "type": { + "$id": "2890", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AutocompleteRequest.searchFields", + "serializationOptions": { + "$id": "2891", + "json": { + "$id": "2892", + "name": "searchFields" + } + } + }, + { + "$id": "2893", + "kind": "property", + "name": "suggesterName", + "serializedName": "suggesterName", + "doc": "The name of the suggester as specified in the suggesters collection that's part\nof the index definition.", + "type": { + "$id": "2894", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AutocompleteRequest.suggesterName", + "serializationOptions": { + "$id": "2895", + "json": { + "$id": "2896", + "name": "suggesterName" + } + } + }, + { + "$id": "2897", + "kind": "property", + "name": "top", + "serializedName": "top", + "doc": "The number of auto-completed terms to retrieve. This must be a value between 1\nand 100. The default is 5.", + "type": { + "$id": "2898", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AutocompleteRequest.top", + "serializationOptions": { + "$id": "2899", + "json": { + "$id": "2900", + "name": "top" + } + } + } + ] + }, + { + "$id": "2901", + "kind": "model", + "name": "SearchAlias", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchAlias", + "usage": "Input,Output,Json", + "doc": "Represents an index alias, which describes a mapping from the alias name to an\nindex. The alias name can be used in place of the index name for supported\noperations.", + "decorators": [], + "properties": [ + { + "$id": "2902", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the alias.", + "type": { + "$id": "2903", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchAlias.name", + "serializationOptions": { + "$id": "2904", + "json": { + "$id": "2905", + "name": "name" + } + } + }, + { + "$id": "2906", + "kind": "property", + "name": "indexes", + "serializedName": "indexes", + "doc": "The name of the index this alias maps to. Only one index name may be specified.", + "type": { + "$id": "2907", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "2908", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchAlias.indexes", + "serializationOptions": { + "$id": "2909", + "json": { + "$id": "2910", + "name": "indexes" + } + } + }, + { + "$id": "2911", + "kind": "property", + "name": "eTag", + "serializedName": "@odata.etag", + "doc": "The ETag of the alias.", + "type": { + "$id": "2912", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchAlias.eTag", + "serializationOptions": { + "$id": "2913", + "json": { + "$id": "2914", + "name": "@odata.etag" + } + } + } + ] + }, + { + "$id": "2915", + "kind": "model", + "name": "ListAliasesResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ListAliasesResult", + "usage": "Output,Json", + "doc": "Response from a List Aliases request. If successful, it includes the associated\nindex mappings for all aliases.", + "decorators": [], + "properties": [ + { + "$id": "2916", + "kind": "property", + "name": "aliases", + "serializedName": "value", + "doc": "The aliases in the Search service.", + "type": { + "$id": "2917", + "kind": "array", + "name": "ArraySearchAlias", + "valueType": { + "$ref": "2901" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ListAliasesResult.value", + "serializationOptions": { + "$id": "2918", + "json": { + "$id": "2919", + "name": "value" + } + } + } + ] + }, + { + "$id": "2920", + "kind": "model", + "name": "SearchIndex", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndex", + "usage": "Input,Output,Json", + "doc": "Represents a search index definition, which describes the fields and search\nbehavior of an index.", + "decorators": [], + "properties": [ + { + "$id": "2921", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the index.", + "type": { + "$id": "2922", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.name", + "serializationOptions": { + "$id": "2923", + "json": { + "$id": "2924", + "name": "name" + } + } + }, + { + "$id": "2925", + "kind": "property", + "name": "fields", + "serializedName": "fields", + "doc": "The fields of the index.", + "type": { + "$id": "2926", + "kind": "array", + "name": "ArraySearchField", + "valueType": { + "$id": "2927", + "kind": "model", + "name": "SearchField", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchField", + "usage": "Input,Output,Json", + "doc": "Represents a field in an index definition, which describes the name, data type,\nand search behavior of a field.", + "decorators": [], + "properties": [ + { + "$id": "2928", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the field, which must be unique within the fields collection of the\nindex or parent field.", + "type": { + "$id": "2929", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.name", + "serializationOptions": { + "$id": "2930", + "json": { + "$id": "2931", + "name": "name" + } + } + }, + { + "$id": "2932", + "kind": "property", + "name": "type", + "serializedName": "type", + "doc": "The data type of the field.", + "type": { + "$ref": "282" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.type", + "serializationOptions": { + "$id": "2933", + "json": { + "$id": "2934", + "name": "type" + } + } + }, + { + "$id": "2935", + "kind": "property", + "name": "key", + "serializedName": "key", + "doc": "A value indicating whether the field uniquely identifies documents in the\nindex. Exactly one top-level field in each index must be chosen as the key\nfield and it must be of type Edm.String. Key fields can be used to look up\ndocuments directly and update or delete specific documents. Default is false\nfor simple fields and null for complex fields.", + "type": { + "$id": "2936", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.key", + "serializationOptions": { + "$id": "2937", + "json": { + "$id": "2938", + "name": "key" + } + } + }, + { + "$id": "2939", + "kind": "property", + "name": "retrievable", + "serializedName": "retrievable", + "doc": "A value indicating whether the field can be returned in a search result. You\ncan disable this option if you want to use a field (for example, margin) as a\nfilter, sorting, or scoring mechanism but do not want the field to be visible\nto the end user. This property must be true for key fields, and it must be null\nfor complex fields. This property can be changed on existing fields. Enabling\nthis property does not cause any increase in index storage requirements.\nDefault is true for simple fields, false for vector fields, and null for\ncomplex fields.", + "type": { + "$id": "2940", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.retrievable", + "serializationOptions": { + "$id": "2941", + "json": { + "$id": "2942", + "name": "retrievable" + } + } + }, + { + "$id": "2943", + "kind": "property", + "name": "stored", + "serializedName": "stored", + "doc": "An immutable value indicating whether the field will be persisted separately on\ndisk to be returned in a search result. You can disable this option if you\ndon't plan to return the field contents in a search response to save on storage\noverhead. This can only be set during index creation and only for vector\nfields. This property cannot be changed for existing fields or set as false for\nnew fields. If this property is set as false, the property 'retrievable' must\nalso be set to false. This property must be true or unset for key fields, for\nnew fields, and for non-vector fields, and it must be null for complex fields.\nDisabling this property will reduce index storage requirements. The default is\ntrue for vector fields.", + "type": { + "$id": "2944", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.stored", + "serializationOptions": { + "$id": "2945", + "json": { + "$id": "2946", + "name": "stored" + } + } + }, + { + "$id": "2947", + "kind": "property", + "name": "searchable", + "serializedName": "searchable", + "doc": "A value indicating whether the field is full-text searchable. This means it\nwill undergo analysis such as word-breaking during indexing. If you set a\nsearchable field to a value like \"sunny day\", internally it will be split into\nthe individual tokens \"sunny\" and \"day\". This enables full-text searches for\nthese terms. Fields of type Edm.String or Collection(Edm.String) are searchable\nby default. This property must be false for simple fields of other non-string\ndata types, and it must be null for complex fields. Note: searchable fields\nconsume extra space in your index to accommodate additional tokenized versions\nof the field value for full-text searches. If you want to save space in your\nindex and you don't need a field to be included in searches, set searchable to\nfalse.", + "type": { + "$id": "2948", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.searchable", + "serializationOptions": { + "$id": "2949", + "json": { + "$id": "2950", + "name": "searchable" + } + } + }, + { + "$id": "2951", + "kind": "property", + "name": "filterable", + "serializedName": "filterable", + "doc": "A value indicating whether to enable the field to be referenced in $filter\nqueries. filterable differs from searchable in how strings are handled. Fields\nof type Edm.String or Collection(Edm.String) that are filterable do not undergo\nword-breaking, so comparisons are for exact matches only. For example, if you\nset such a field f to \"sunny day\", $filter=f eq 'sunny' will find no matches,\nbut $filter=f eq 'sunny day' will. This property must be null for complex\nfields. Default is true for simple fields and null for complex fields.", + "type": { + "$id": "2952", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.filterable", + "serializationOptions": { + "$id": "2953", + "json": { + "$id": "2954", + "name": "filterable" + } + } + }, + { + "$id": "2955", + "kind": "property", + "name": "sortable", + "serializedName": "sortable", + "doc": "A value indicating whether to enable the field to be referenced in $orderby\nexpressions. By default, the search engine sorts results by score, but in many\nexperiences users will want to sort by fields in the documents. A simple field\ncan be sortable only if it is single-valued (it has a single value in the scope\nof the parent document). Simple collection fields cannot be sortable, since\nthey are multi-valued. Simple sub-fields of complex collections are also\nmulti-valued, and therefore cannot be sortable. This is true whether it's an\nimmediate parent field, or an ancestor field, that's the complex collection.\nComplex fields cannot be sortable and the sortable property must be null for\nsuch fields. The default for sortable is true for single-valued simple fields,\nfalse for multi-valued simple fields, and null for complex fields.", + "type": { + "$id": "2956", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.sortable", + "serializationOptions": { + "$id": "2957", + "json": { + "$id": "2958", + "name": "sortable" + } + } + }, + { + "$id": "2959", + "kind": "property", + "name": "facetable", + "serializedName": "facetable", + "doc": "A value indicating whether to enable the field to be referenced in facet\nqueries. Typically used in a presentation of search results that includes hit\ncount by category (for example, search for digital cameras and see hits by\nbrand, by megapixels, by price, and so on). This property must be null for\ncomplex fields. Fields of type Edm.GeographyPoint or\nCollection(Edm.GeographyPoint) cannot be facetable. Default is true for all\nother simple fields.", + "type": { + "$id": "2960", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.facetable", + "serializationOptions": { + "$id": "2961", + "json": { + "$id": "2962", + "name": "facetable" + } + } + }, + { + "$id": "2963", + "kind": "property", + "name": "analyzer", + "serializedName": "analyzer", + "doc": "The name of the analyzer to use for the field. This option can be used only\nwith searchable fields and it can't be set together with either searchAnalyzer\nor indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the\nfield. Must be null for complex fields.", + "type": { + "$ref": "310" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.analyzer", + "serializationOptions": { + "$id": "2964", + "json": { + "$id": "2965", + "name": "analyzer" + } + } + }, + { + "$id": "2966", + "kind": "property", + "name": "searchAnalyzer", + "serializedName": "searchAnalyzer", + "doc": "The name of the analyzer used at search time for the field. This option can be\nused only with searchable fields. It must be set together with indexAnalyzer\nand it cannot be set together with the analyzer option. This property cannot be\nset to the name of a language analyzer; use the analyzer property instead if\nyou need a language analyzer. This analyzer can be updated on an existing\nfield. Must be null for complex fields.", + "type": { + "$ref": "310" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.searchAnalyzer", + "serializationOptions": { + "$id": "2967", + "json": { + "$id": "2968", + "name": "searchAnalyzer" + } + } + }, + { + "$id": "2969", + "kind": "property", + "name": "indexAnalyzer", + "serializedName": "indexAnalyzer", + "doc": "The name of the analyzer used at indexing time for the field. This option can\nbe used only with searchable fields. It must be set together with\nsearchAnalyzer and it cannot be set together with the analyzer option. This\nproperty cannot be set to the name of a language analyzer; use the analyzer\nproperty instead if you need a language analyzer. Once the analyzer is chosen,\nit cannot be changed for the field. Must be null for complex fields.", + "type": { + "$ref": "310" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.indexAnalyzer", + "serializationOptions": { + "$id": "2970", + "json": { + "$id": "2971", + "name": "indexAnalyzer" + } + } + }, + { + "$id": "2972", + "kind": "property", + "name": "normalizer", + "serializedName": "normalizer", + "doc": "The name of the normalizer to use for the field. This option can be used only\nwith fields with filterable, sortable, or facetable enabled. Once the\nnormalizer is chosen, it cannot be changed for the field. Must be null for\ncomplex fields.", + "type": { + "$ref": "498" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.normalizer", + "serializationOptions": { + "$id": "2973", + "json": { + "$id": "2974", + "name": "normalizer" + } + } + }, + { + "$id": "2975", + "kind": "property", + "name": "vectorSearchDimensions", + "serializedName": "dimensions", + "doc": "The dimensionality of the vector field.", + "type": { + "$id": "2976", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.dimensions", + "serializationOptions": { + "$id": "2977", + "json": { + "$id": "2978", + "name": "dimensions" + } + } + }, + { + "$id": "2979", + "kind": "property", + "name": "vectorSearchProfileName", + "serializedName": "vectorSearchProfile", + "doc": "The name of the vector search profile that specifies the algorithm and\nvectorizer to use when searching the vector field.", + "type": { + "$id": "2980", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.vectorSearchProfile", + "serializationOptions": { + "$id": "2981", + "json": { + "$id": "2982", + "name": "vectorSearchProfile" + } + } + }, + { + "$id": "2983", + "kind": "property", + "name": "vectorEncodingFormat", + "serializedName": "vectorEncoding", + "doc": "The encoding format to interpret the field contents.", + "type": { + "$ref": "510" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.vectorEncoding", + "serializationOptions": { + "$id": "2984", + "json": { + "$id": "2985", + "name": "vectorEncoding" + } + } + }, + { + "$id": "2986", + "kind": "property", + "name": "synonymMaps", + "serializedName": "synonymMaps", + "doc": "A list of the names of synonym maps to associate with this field. This option\ncan be used only with searchable fields. Currently only one synonym map per\nfield is supported. Assigning a synonym map to a field ensures that query terms\ntargeting that field are expanded at query-time using the rules in the synonym\nmap. This attribute can be changed on existing fields. Must be null or an empty\ncollection for complex fields.", + "type": { + "$id": "2987", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "2988", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.synonymMaps", + "serializationOptions": { + "$id": "2989", + "json": { + "$id": "2990", + "name": "synonymMaps" + } + } + }, + { + "$id": "2991", + "kind": "property", + "name": "fields", + "serializedName": "fields", + "doc": "A list of sub-fields if this is a field of type Edm.ComplexType or\nCollection(Edm.ComplexType). Must be null or empty for simple fields.", + "type": { + "$id": "2992", + "kind": "array", + "name": "ArraySearchField", + "valueType": { + "$ref": "2927" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchField.fields", + "serializationOptions": { + "$id": "2993", + "json": { + "$id": "2994", + "name": "fields" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.fields", + "serializationOptions": { + "$id": "2995", + "json": { + "$id": "2996", + "name": "fields" + } + } + }, + { + "$id": "2997", + "kind": "property", + "name": "scoringProfiles", + "serializedName": "scoringProfiles", + "doc": "The scoring profiles for the index.", + "type": { + "$id": "2998", + "kind": "array", + "name": "ArrayScoringProfile", + "valueType": { + "$id": "2999", + "kind": "model", + "name": "ScoringProfile", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ScoringProfile", + "usage": "Input,Output,Json", + "doc": "Defines parameters for a search index that influence scoring in search queries.", + "decorators": [], + "properties": [ + { + "$id": "3000", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the scoring profile.", + "type": { + "$id": "3001", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ScoringProfile.name", + "serializationOptions": { + "$id": "3002", + "json": { + "$id": "3003", + "name": "name" + } + } + }, + { + "$id": "3004", + "kind": "property", + "name": "textWeights", + "serializedName": "text", + "doc": "Parameters that boost scoring based on text matches in certain index fields.", + "type": { + "$id": "3005", + "kind": "model", + "name": "TextWeights", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.TextWeights", + "usage": "Input,Output,Json", + "doc": "Defines weights on index fields for which matches should boost scoring in\nsearch queries.", + "decorators": [], + "properties": [ + { + "$id": "3006", + "kind": "property", + "name": "weights", + "serializedName": "weights", + "doc": "The dictionary of per-field weights to boost document scoring. The keys are\nfield names and the values are the weights for each field.", + "type": { + "$id": "3007", + "kind": "dict", + "keyType": { + "$id": "3008", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "valueType": { + "$id": "3009", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.TextWeights.weights", + "serializationOptions": { + "$id": "3010", + "json": { + "$id": "3011", + "name": "weights" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ScoringProfile.text", + "serializationOptions": { + "$id": "3012", + "json": { + "$id": "3013", + "name": "text" + } + } + }, + { + "$id": "3014", + "kind": "property", + "name": "functions", + "serializedName": "functions", + "doc": "The collection of functions that influence the scoring of documents.", + "type": { + "$id": "3015", + "kind": "array", + "name": "ArrayScoringFunction", + "valueType": { + "$id": "3016", + "kind": "model", + "name": "ScoringFunction", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ScoringFunction", + "usage": "Input,Output,Json", + "doc": "Base type for functions that can modify document scores during ranking.", + "decorators": [], + "discriminatorProperty": { + "$id": "3017", + "kind": "property", + "name": "type", + "serializedName": "type", + "doc": "Type of ScoringFunction.", + "type": { + "$id": "3018", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ScoringFunction.type", + "serializationOptions": { + "$id": "3019", + "json": { + "$id": "3020", + "name": "type" + } + } + }, + "properties": [ + { + "$id": "3021", + "kind": "property", + "name": "fieldName", + "serializedName": "fieldName", + "doc": "The name of the field used as input to the scoring function.", + "type": { + "$id": "3022", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ScoringFunction.fieldName", + "serializationOptions": { + "$id": "3023", + "json": { + "$id": "3024", + "name": "fieldName" + } + } + }, + { + "$id": "3025", + "kind": "property", + "name": "boost", + "serializedName": "boost", + "doc": "A multiplier for the raw score. Must be a positive number not equal to 1.0.", + "type": { + "$id": "3026", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ScoringFunction.boost", + "serializationOptions": { + "$id": "3027", + "json": { + "$id": "3028", + "name": "boost" + } + } + }, + { + "$id": "3029", + "kind": "property", + "name": "interpolation", + "serializedName": "interpolation", + "doc": "A value indicating how boosting will be interpolated across document scores;\ndefaults to \"Linear\".", + "type": { + "$ref": "514" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ScoringFunction.interpolation", + "serializationOptions": { + "$id": "3030", + "json": { + "$id": "3031", + "name": "interpolation" + } + } + }, + { + "$ref": "3017" + } + ], + "discriminatedSubtypes": { + "$id": "3032", + "distance": { + "$id": "3033", + "kind": "model", + "name": "DistanceScoringFunction", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.DistanceScoringFunction", + "usage": "Input,Output,Json", + "doc": "Defines a function that boosts scores based on distance from a geographic\nlocation.", + "discriminatorValue": "distance", + "decorators": [], + "baseModel": { + "$ref": "3016" + }, + "properties": [ + { + "$id": "3034", + "kind": "property", + "name": "parameters", + "serializedName": "distance", + "doc": "Parameter values for the distance scoring function.", + "type": { + "$id": "3035", + "kind": "model", + "name": "DistanceScoringParameters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.DistanceScoringParameters", + "usage": "Input,Output,Json", + "doc": "Provides parameter values to a distance scoring function.", + "decorators": [], + "properties": [ + { + "$id": "3036", + "kind": "property", + "name": "referencePointParameter", + "serializedName": "referencePointParameter", + "doc": "The name of the parameter passed in search queries to specify the reference\nlocation.", + "type": { + "$id": "3037", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DistanceScoringParameters.referencePointParameter", + "serializationOptions": { + "$id": "3038", + "json": { + "$id": "3039", + "name": "referencePointParameter" + } + } + }, + { + "$id": "3040", + "kind": "property", + "name": "boostingDistance", + "serializedName": "boostingDistance", + "doc": "The distance in kilometers from the reference location where the boosting range\nends.", + "type": { + "$id": "3041", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DistanceScoringParameters.boostingDistance", + "serializationOptions": { + "$id": "3042", + "json": { + "$id": "3043", + "name": "boostingDistance" + } + } + } + ] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DistanceScoringFunction.distance", + "serializationOptions": { + "$id": "3044", + "json": { + "$id": "3045", + "name": "distance" + } + } + }, + { + "$id": "3046", + "kind": "property", + "name": "type", + "serializedName": "type", + "doc": "Indicates the type of function to use. Valid values include magnitude,\nfreshness, distance, and tag. The function type must be lower case.", + "type": { + "$id": "3047", + "kind": "constant", + "valueType": { + "$id": "3048", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "distance", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DistanceScoringFunction.type", + "serializationOptions": { + "$id": "3049", + "json": { + "$id": "3050", + "name": "type" + } + } + } + ] + }, + "freshness": { + "$id": "3051", + "kind": "model", + "name": "FreshnessScoringFunction", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.FreshnessScoringFunction", + "usage": "Input,Output,Json", + "doc": "Defines a function that boosts scores based on the value of a date-time field.", + "discriminatorValue": "freshness", + "decorators": [], + "baseModel": { + "$ref": "3016" + }, + "properties": [ + { + "$id": "3052", + "kind": "property", + "name": "parameters", + "serializedName": "freshness", + "doc": "Parameter values for the freshness scoring function.", + "type": { + "$id": "3053", + "kind": "model", + "name": "FreshnessScoringParameters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.FreshnessScoringParameters", + "usage": "Input,Output,Json", + "doc": "Provides parameter values to a freshness scoring function.", + "decorators": [], + "properties": [ + { + "$id": "3054", + "kind": "property", + "name": "boostingDuration", + "serializedName": "boostingDuration", + "doc": "The expiration period after which boosting will stop for a particular document.", + "type": { + "$id": "3055", + "kind": "duration", + "name": "duration", + "encode": "ISO8601", + "wireType": { + "$id": "3056", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.duration", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.FreshnessScoringParameters.boostingDuration", + "serializationOptions": { + "$id": "3057", + "json": { + "$id": "3058", + "name": "boostingDuration" + } + } + } + ] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.FreshnessScoringFunction.freshness", + "serializationOptions": { + "$id": "3059", + "json": { + "$id": "3060", + "name": "freshness" + } + } + }, + { + "$id": "3061", + "kind": "property", + "name": "type", + "serializedName": "type", + "doc": "Indicates the type of function to use. Valid values include magnitude,\nfreshness, distance, and tag. The function type must be lower case.", + "type": { + "$id": "3062", + "kind": "constant", + "valueType": { + "$id": "3063", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "freshness", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.FreshnessScoringFunction.type", + "serializationOptions": { + "$id": "3064", + "json": { + "$id": "3065", + "name": "type" + } + } + } + ] + }, + "magnitude": { + "$id": "3066", + "kind": "model", + "name": "MagnitudeScoringFunction", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.MagnitudeScoringFunction", + "usage": "Input,Output,Json", + "doc": "Defines a function that boosts scores based on the magnitude of a numeric field.", + "discriminatorValue": "magnitude", + "decorators": [], + "baseModel": { + "$ref": "3016" + }, + "properties": [ + { + "$id": "3067", + "kind": "property", + "name": "parameters", + "serializedName": "magnitude", + "doc": "Parameter values for the magnitude scoring function.", + "type": { + "$id": "3068", + "kind": "model", + "name": "MagnitudeScoringParameters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.MagnitudeScoringParameters", + "usage": "Input,Output,Json", + "doc": "Provides parameter values to a magnitude scoring function.", + "decorators": [], + "properties": [ + { + "$id": "3069", + "kind": "property", + "name": "boostingRangeStart", + "serializedName": "boostingRangeStart", + "doc": "The field value at which boosting starts.", + "type": { + "$id": "3070", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MagnitudeScoringParameters.boostingRangeStart", + "serializationOptions": { + "$id": "3071", + "json": { + "$id": "3072", + "name": "boostingRangeStart" + } + } + }, + { + "$id": "3073", + "kind": "property", + "name": "boostingRangeEnd", + "serializedName": "boostingRangeEnd", + "doc": "The field value at which boosting ends.", + "type": { + "$id": "3074", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MagnitudeScoringParameters.boostingRangeEnd", + "serializationOptions": { + "$id": "3075", + "json": { + "$id": "3076", + "name": "boostingRangeEnd" + } + } + }, + { + "$id": "3077", + "kind": "property", + "name": "shouldBoostBeyondRangeByConstant", + "serializedName": "constantBoostBeyondRange", + "doc": "A value indicating whether to apply a constant boost for field values beyond\nthe range end value; default is false.", + "type": { + "$id": "3078", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MagnitudeScoringParameters.constantBoostBeyondRange", + "serializationOptions": { + "$id": "3079", + "json": { + "$id": "3080", + "name": "constantBoostBeyondRange" + } + } + } + ] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MagnitudeScoringFunction.magnitude", + "serializationOptions": { + "$id": "3081", + "json": { + "$id": "3082", + "name": "magnitude" + } + } + }, + { + "$id": "3083", + "kind": "property", + "name": "type", + "serializedName": "type", + "doc": "Indicates the type of function to use. Valid values include magnitude,\nfreshness, distance, and tag. The function type must be lower case.", + "type": { + "$id": "3084", + "kind": "constant", + "valueType": { + "$id": "3085", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "magnitude", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MagnitudeScoringFunction.type", + "serializationOptions": { + "$id": "3086", + "json": { + "$id": "3087", + "name": "type" + } + } + } + ] + }, + "tag": { + "$id": "3088", + "kind": "model", + "name": "TagScoringFunction", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.TagScoringFunction", + "usage": "Input,Output,Json", + "doc": "Defines a function that boosts scores of documents with string values matching\na given list of tags.", + "discriminatorValue": "tag", + "decorators": [], + "baseModel": { + "$ref": "3016" + }, + "properties": [ + { + "$id": "3089", + "kind": "property", + "name": "parameters", + "serializedName": "tag", + "doc": "Parameter values for the tag scoring function.", + "type": { + "$id": "3090", + "kind": "model", + "name": "TagScoringParameters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.TagScoringParameters", + "usage": "Input,Output,Json", + "doc": "Provides parameter values to a tag scoring function.", + "decorators": [], + "properties": [ + { + "$id": "3091", + "kind": "property", + "name": "tagsParameter", + "serializedName": "tagsParameter", + "doc": "The name of the parameter passed in search queries to specify the list of tags\nto compare against the target field.", + "type": { + "$id": "3092", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.TagScoringParameters.tagsParameter", + "serializationOptions": { + "$id": "3093", + "json": { + "$id": "3094", + "name": "tagsParameter" + } + } + } + ] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.TagScoringFunction.tag", + "serializationOptions": { + "$id": "3095", + "json": { + "$id": "3096", + "name": "tag" + } + } + }, + { + "$id": "3097", + "kind": "property", + "name": "type", + "serializedName": "type", + "doc": "Indicates the type of function to use. Valid values include magnitude,\nfreshness, distance, and tag. The function type must be lower case.", + "type": { + "$id": "3098", + "kind": "constant", + "valueType": { + "$id": "3099", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "tag", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.TagScoringFunction.type", + "serializationOptions": { + "$id": "3100", + "json": { + "$id": "3101", + "name": "type" + } + } + } + ] + } + } + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ScoringProfile.functions", + "serializationOptions": { + "$id": "3102", + "json": { + "$id": "3103", + "name": "functions" + } + } + }, + { + "$id": "3104", + "kind": "property", + "name": "functionAggregation", + "serializedName": "functionAggregation", + "doc": "A value indicating how the results of individual scoring functions should be\ncombined. Defaults to \"Sum\". Ignored if there are no scoring functions.", + "type": { + "$ref": "524" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ScoringProfile.functionAggregation", + "serializationOptions": { + "$id": "3105", + "json": { + "$id": "3106", + "name": "functionAggregation" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.scoringProfiles", + "serializationOptions": { + "$id": "3107", + "json": { + "$id": "3108", + "name": "scoringProfiles" + } + } + }, + { + "$id": "3109", + "kind": "property", + "name": "defaultScoringProfile", + "serializedName": "defaultScoringProfile", + "doc": "The name of the scoring profile to use if none is specified in the query. If\nthis property is not set and no scoring profile is specified in the query, then\ndefault scoring (tf-idf) will be used.", + "type": { + "$id": "3110", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.defaultScoringProfile", + "serializationOptions": { + "$id": "3111", + "json": { + "$id": "3112", + "name": "defaultScoringProfile" + } + } + }, + { + "$id": "3113", + "kind": "property", + "name": "corsOptions", + "serializedName": "corsOptions", + "doc": "Options to control Cross-Origin Resource Sharing (CORS) for the index.", + "type": { + "$id": "3114", + "kind": "model", + "name": "CorsOptions", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.CorsOptions", + "usage": "Input,Output,Json", + "doc": "Defines options to control Cross-Origin Resource Sharing (CORS) for an index.", + "decorators": [], + "properties": [ + { + "$id": "3115", + "kind": "property", + "name": "allowedOrigins", + "serializedName": "allowedOrigins", + "doc": "The list of origins from which JavaScript code will be granted access to your\nindex. Can contain a list of hosts of the form\n{protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow\nall origins (not recommended).", + "type": { + "$id": "3116", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3117", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CorsOptions.allowedOrigins", + "serializationOptions": { + "$id": "3118", + "json": { + "$id": "3119", + "name": "allowedOrigins" + } + } + }, + { + "$id": "3120", + "kind": "property", + "name": "maxAgeInSeconds", + "serializedName": "maxAgeInSeconds", + "doc": "The duration for which browsers should cache CORS preflight responses. Defaults\nto 5 minutes.", + "type": { + "$id": "3121", + "kind": "int64", + "name": "int64", + "crossLanguageDefinitionId": "TypeSpec.int64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CorsOptions.maxAgeInSeconds", + "serializationOptions": { + "$id": "3122", + "json": { + "$id": "3123", + "name": "maxAgeInSeconds" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.corsOptions", + "serializationOptions": { + "$id": "3124", + "json": { + "$id": "3125", + "name": "corsOptions" + } + } + }, + { + "$id": "3126", + "kind": "property", + "name": "suggesters", + "serializedName": "suggesters", + "doc": "The suggesters for the index.", + "type": { + "$id": "3127", + "kind": "array", + "name": "ArraySearchSuggester", + "valueType": { + "$id": "3128", + "kind": "model", + "name": "SearchSuggester", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchSuggester", + "usage": "Input,Output,Json", + "doc": "Defines how the Suggest API should apply to a group of fields in the index.", + "decorators": [], + "properties": [ + { + "$id": "3129", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the suggester.", + "type": { + "$id": "3130", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchSuggester.name", + "serializationOptions": { + "$id": "3131", + "json": { + "$id": "3132", + "name": "name" + } + } + }, + { + "$id": "3133", + "kind": "property", + "name": "searchMode", + "serializedName": "searchMode", + "doc": "A value indicating the capabilities of the suggester.", + "type": { + "$id": "3134", + "kind": "constant", + "valueType": { + "$ref": "536" + }, + "value": "analyzingInfixMatching", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchSuggester.searchMode", + "serializationOptions": { + "$id": "3135", + "json": { + "$id": "3136", + "name": "searchMode" + } + } + }, + { + "$id": "3137", + "kind": "property", + "name": "sourceFields", + "serializedName": "sourceFields", + "doc": "The list of field names to which the suggester applies. Each field must be\nsearchable.", + "type": { + "$id": "3138", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3139", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchSuggester.sourceFields", + "serializationOptions": { + "$id": "3140", + "json": { + "$id": "3141", + "name": "sourceFields" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.suggesters", + "serializationOptions": { + "$id": "3142", + "json": { + "$id": "3143", + "name": "suggesters" + } + } + }, + { + "$id": "3144", + "kind": "property", + "name": "analyzers", + "serializedName": "analyzers", + "doc": "The analyzers for the index.", + "type": { + "$id": "3145", + "kind": "array", + "name": "ArrayLexicalAnalyzer", + "valueType": { + "$id": "3146", + "kind": "model", + "name": "LexicalAnalyzer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.LexicalAnalyzer", + "usage": "Input,Output,Json", + "doc": "Base type for analyzers.", + "decorators": [], + "discriminatorProperty": { + "$id": "3147", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "The discriminator for derived types.", + "type": { + "$id": "3148", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LexicalAnalyzer.@odata.type", + "serializationOptions": { + "$id": "3149", + "json": { + "$id": "3150", + "name": "@odata.type" + } + } + }, + "properties": [ + { + "$ref": "3147" + }, + { + "$id": "3151", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the analyzer. It must only contain letters, digits, spaces, dashes\nor underscores, can only start and end with alphanumeric characters, and is\nlimited to 128 characters.", + "type": { + "$id": "3152", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LexicalAnalyzer.name", + "serializationOptions": { + "$id": "3153", + "json": { + "$id": "3154", + "name": "name" + } + } + } + ], + "discriminatedSubtypes": { + "$id": "3155", + "#Microsoft.Azure.Search.CustomAnalyzer": { + "$id": "3156", + "kind": "model", + "name": "CustomAnalyzer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.CustomAnalyzer", + "usage": "Input,Output,Json", + "doc": "Allows you to take control over the process of converting text into\nindexable/searchable tokens. It's a user-defined configuration consisting of a\nsingle predefined tokenizer and one or more filters. The tokenizer is\nresponsible for breaking text into tokens, and the filters for modifying tokens\nemitted by the tokenizer.", + "discriminatorValue": "#Microsoft.Azure.Search.CustomAnalyzer", + "decorators": [], + "baseModel": { + "$ref": "3146" + }, + "properties": [ + { + "$id": "3157", + "kind": "property", + "name": "tokenizer", + "serializedName": "tokenizer", + "doc": "The name of the tokenizer to use to divide continuous text into a sequence of\ntokens, such as breaking a sentence into words.", + "type": { + "$ref": "539" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomAnalyzer.tokenizer", + "serializationOptions": { + "$id": "3158", + "json": { + "$id": "3159", + "name": "tokenizer" + } + } + }, + { + "$id": "3160", + "kind": "property", + "name": "tokenFilters", + "serializedName": "tokenFilters", + "doc": "A list of token filters used to filter out or modify the tokens generated by a\ntokenizer. For example, you can specify a lowercase filter that converts all\ncharacters to lowercase. The filters are run in the order in which they are\nlisted.", + "type": { + "$id": "3161", + "kind": "array", + "name": "ArrayTokenFilterName", + "valueType": { + "$ref": "567" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomAnalyzer.tokenFilters", + "serializationOptions": { + "$id": "3162", + "json": { + "$id": "3163", + "name": "tokenFilters" + } + } + }, + { + "$id": "3164", + "kind": "property", + "name": "charFilters", + "serializedName": "charFilters", + "doc": "A list of character filters used to prepare input text before it is processed\nby the tokenizer. For instance, they can replace certain characters or symbols.\nThe filters are run in the order in which they are listed.", + "type": { + "$id": "3165", + "kind": "array", + "name": "ArrayCharFilterName", + "valueType": { + "$ref": "637" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomAnalyzer.charFilters", + "serializationOptions": { + "$id": "3166", + "json": { + "$id": "3167", + "name": "charFilters" + } + } + }, + { + "$id": "3168", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of analyzer.", + "type": { + "$id": "3169", + "kind": "constant", + "valueType": { + "$id": "3170", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.CustomAnalyzer", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomAnalyzer.@odata.type", + "serializationOptions": { + "$id": "3171", + "json": { + "$id": "3172", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.PatternAnalyzer": { + "$id": "3173", + "kind": "model", + "name": "PatternAnalyzer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.PatternAnalyzer", + "usage": "Input,Output,Json", + "doc": "Flexibly separates text into terms via a regular expression pattern. This\nanalyzer is implemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.PatternAnalyzer", + "decorators": [], + "baseModel": { + "$ref": "3146" + }, + "properties": [ + { + "$id": "3174", + "kind": "property", + "name": "lowerCaseTerms", + "serializedName": "lowercase", + "doc": "A value indicating whether terms should be lower-cased. Default is true.", + "type": { + "$id": "3175", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternAnalyzer.lowercase", + "serializationOptions": { + "$id": "3176", + "json": { + "$id": "3177", + "name": "lowercase" + } + } + }, + { + "$id": "3178", + "kind": "property", + "name": "pattern", + "serializedName": "pattern", + "doc": "A regular expression pattern to match token separators. Default is an\nexpression that matches one or more non-word characters.", + "type": { + "$id": "3179", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternAnalyzer.pattern", + "serializationOptions": { + "$id": "3180", + "json": { + "$id": "3181", + "name": "pattern" + } + } + }, + { + "$id": "3182", + "kind": "property", + "name": "flags", + "serializedName": "flags", + "doc": "Regular expression flags.", + "type": { + "$ref": "641" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternAnalyzer.flags", + "serializationOptions": { + "$id": "3183", + "json": { + "$id": "3184", + "name": "flags" + } + } + }, + { + "$id": "3185", + "kind": "property", + "name": "stopwords", + "serializedName": "stopwords", + "doc": "A list of stopwords.", + "type": { + "$id": "3186", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3187", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternAnalyzer.stopwords", + "serializationOptions": { + "$id": "3188", + "json": { + "$id": "3189", + "name": "stopwords" + } + } + }, + { + "$id": "3190", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of analyzer.", + "type": { + "$id": "3191", + "kind": "constant", + "valueType": { + "$id": "3192", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.PatternAnalyzer", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternAnalyzer.@odata.type", + "serializationOptions": { + "$id": "3193", + "json": { + "$id": "3194", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.StandardAnalyzer": { + "$id": "3195", + "kind": "model", + "name": "LuceneStandardAnalyzer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.LuceneStandardAnalyzer", + "usage": "Input,Output,Json", + "doc": "Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase\nfilter and stop filter.", + "discriminatorValue": "#Microsoft.Azure.Search.StandardAnalyzer", + "decorators": [], + "baseModel": { + "$ref": "3146" + }, + "properties": [ + { + "$id": "3196", + "kind": "property", + "name": "maxTokenLength", + "serializedName": "maxTokenLength", + "doc": "The maximum token length. Default is 255. Tokens longer than the maximum length\nare split. The maximum token length that can be used is 300 characters.", + "type": { + "$id": "3197", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LuceneStandardAnalyzer.maxTokenLength", + "serializationOptions": { + "$id": "3198", + "json": { + "$id": "3199", + "name": "maxTokenLength" + } + } + }, + { + "$id": "3200", + "kind": "property", + "name": "stopwords", + "serializedName": "stopwords", + "doc": "A list of stopwords.", + "type": { + "$id": "3201", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3202", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LuceneStandardAnalyzer.stopwords", + "serializationOptions": { + "$id": "3203", + "json": { + "$id": "3204", + "name": "stopwords" + } + } + }, + { + "$id": "3205", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of analyzer.", + "type": { + "$id": "3206", + "kind": "constant", + "valueType": { + "$id": "3207", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.StandardAnalyzer", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LuceneStandardAnalyzer.@odata.type", + "serializationOptions": { + "$id": "3208", + "json": { + "$id": "3209", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.StopAnalyzer": { + "$id": "3210", + "kind": "model", + "name": "StopAnalyzer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.StopAnalyzer", + "usage": "Input,Output,Json", + "doc": "Divides text at non-letters; Applies the lowercase and stopword token filters.\nThis analyzer is implemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.StopAnalyzer", + "decorators": [], + "baseModel": { + "$ref": "3146" + }, + "properties": [ + { + "$id": "3211", + "kind": "property", + "name": "stopwords", + "serializedName": "stopwords", + "doc": "A list of stopwords.", + "type": { + "$id": "3212", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3213", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.StopAnalyzer.stopwords", + "serializationOptions": { + "$id": "3214", + "json": { + "$id": "3215", + "name": "stopwords" + } + } + }, + { + "$id": "3216", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of analyzer.", + "type": { + "$id": "3217", + "kind": "constant", + "valueType": { + "$id": "3218", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.StopAnalyzer", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.StopAnalyzer.@odata.type", + "serializationOptions": { + "$id": "3219", + "json": { + "$id": "3220", + "name": "@odata.type" + } + } + } + ] + } + } + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.analyzers", + "serializationOptions": { + "$id": "3221", + "json": { + "$id": "3222", + "name": "analyzers" + } + } + }, + { + "$id": "3223", + "kind": "property", + "name": "tokenizers", + "serializedName": "tokenizers", + "doc": "The tokenizers for the index.", + "type": { + "$id": "3224", + "kind": "array", + "name": "ArrayLexicalTokenizer", + "valueType": { + "$id": "3225", + "kind": "model", + "name": "LexicalTokenizer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.LexicalTokenizer", + "usage": "Input,Output,Json", + "doc": "Base type for tokenizers.", + "decorators": [], + "discriminatorProperty": { + "$id": "3226", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "The discriminator for derived types.", + "type": { + "$id": "3227", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LexicalTokenizer.@odata.type", + "serializationOptions": { + "$id": "3228", + "json": { + "$id": "3229", + "name": "@odata.type" + } + } + }, + "properties": [ + { + "$ref": "3226" + }, + { + "$id": "3230", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the tokenizer. It must only contain letters, digits, spaces, dashes\nor underscores, can only start and end with alphanumeric characters, and is\nlimited to 128 characters.", + "type": { + "$id": "3231", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LexicalTokenizer.name", + "serializationOptions": { + "$id": "3232", + "json": { + "$id": "3233", + "name": "name" + } + } + } + ], + "discriminatedSubtypes": { + "$id": "3234", + "#Microsoft.Azure.Search.ClassicTokenizer": { + "$id": "3235", + "kind": "model", + "name": "ClassicTokenizer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ClassicTokenizer", + "usage": "Input,Output,Json", + "doc": "Grammar-based tokenizer that is suitable for processing most European-language\ndocuments. This tokenizer is implemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.ClassicTokenizer", + "decorators": [], + "baseModel": { + "$ref": "3225" + }, + "properties": [ + { + "$id": "3236", + "kind": "property", + "name": "maxTokenLength", + "serializedName": "maxTokenLength", + "doc": "The maximum token length. Default is 255. Tokens longer than the maximum length\nare split. The maximum token length that can be used is 300 characters.", + "type": { + "$id": "3237", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ClassicTokenizer.maxTokenLength", + "serializationOptions": { + "$id": "3238", + "json": { + "$id": "3239", + "name": "maxTokenLength" + } + } + }, + { + "$id": "3240", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of tokenizer.", + "type": { + "$id": "3241", + "kind": "constant", + "valueType": { + "$id": "3242", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.ClassicTokenizer", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ClassicTokenizer.@odata.type", + "serializationOptions": { + "$id": "3243", + "json": { + "$id": "3244", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.EdgeNGramTokenizer": { + "$id": "3245", + "kind": "model", + "name": "EdgeNGramTokenizer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.EdgeNGramTokenizer", + "usage": "Input,Output,Json", + "doc": "Tokenizes the input from an edge into n-grams of the given size(s). This\ntokenizer is implemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.EdgeNGramTokenizer", + "decorators": [], + "baseModel": { + "$ref": "3225" + }, + "properties": [ + { + "$id": "3246", + "kind": "property", + "name": "minGram", + "serializedName": "minGram", + "doc": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the\nvalue of maxGram.", + "type": { + "$id": "3247", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EdgeNGramTokenizer.minGram", + "serializationOptions": { + "$id": "3248", + "json": { + "$id": "3249", + "name": "minGram" + } + } + }, + { + "$id": "3250", + "kind": "property", + "name": "maxGram", + "serializedName": "maxGram", + "doc": "The maximum n-gram length. Default is 2. Maximum is 300.", + "type": { + "$id": "3251", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EdgeNGramTokenizer.maxGram", + "serializationOptions": { + "$id": "3252", + "json": { + "$id": "3253", + "name": "maxGram" + } + } + }, + { + "$id": "3254", + "kind": "property", + "name": "tokenChars", + "serializedName": "tokenChars", + "doc": "Character classes to keep in the tokens.", + "type": { + "$id": "3255", + "kind": "array", + "name": "ArrayTokenCharacterKind", + "valueType": { + "$ref": "659" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EdgeNGramTokenizer.tokenChars", + "serializationOptions": { + "$id": "3256", + "json": { + "$id": "3257", + "name": "tokenChars" + } + } + }, + { + "$id": "3258", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of tokenizer.", + "type": { + "$id": "3259", + "kind": "constant", + "valueType": { + "$id": "3260", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.EdgeNGramTokenizer", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EdgeNGramTokenizer.@odata.type", + "serializationOptions": { + "$id": "3261", + "json": { + "$id": "3262", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.KeywordTokenizerV2": { + "$id": "3263", + "kind": "model", + "name": "KeywordTokenizerV2", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.KeywordTokenizerV2", + "usage": "Input,Output,Json", + "doc": "Emits the entire input as a single token. This tokenizer is implemented using\nApache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.KeywordTokenizerV2", + "decorators": [], + "baseModel": { + "$ref": "3225" + }, + "properties": [ + { + "$id": "3264", + "kind": "property", + "name": "maxTokenLength", + "serializedName": "maxTokenLength", + "doc": "The maximum token length. Default is 256. Tokens longer than the maximum length\nare split. The maximum token length that can be used is 300 characters.", + "type": { + "$id": "3265", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.KeywordTokenizerV2.maxTokenLength", + "serializationOptions": { + "$id": "3266", + "json": { + "$id": "3267", + "name": "maxTokenLength" + } + } + }, + { + "$id": "3268", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of tokenizer.", + "type": { + "$id": "3269", + "kind": "constant", + "valueType": { + "$id": "3270", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.KeywordTokenizerV2", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.KeywordTokenizerV2.@odata.type", + "serializationOptions": { + "$id": "3271", + "json": { + "$id": "3272", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.MicrosoftLanguageTokenizer": { + "$id": "3273", + "kind": "model", + "name": "MicrosoftLanguageTokenizer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.MicrosoftLanguageTokenizer", + "usage": "Input,Output,Json", + "doc": "Divides text using language-specific rules.", + "discriminatorValue": "#Microsoft.Azure.Search.MicrosoftLanguageTokenizer", + "decorators": [], + "baseModel": { + "$ref": "3225" + }, + "properties": [ + { + "$id": "3274", + "kind": "property", + "name": "maxTokenLength", + "serializedName": "maxTokenLength", + "doc": "The maximum token length. Tokens longer than the maximum length are split.\nMaximum token length that can be used is 300 characters. Tokens longer than 300\ncharacters are first split into tokens of length 300 and then each of those\ntokens is split based on the max token length set. Default is 255.", + "type": { + "$id": "3275", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MicrosoftLanguageTokenizer.maxTokenLength", + "serializationOptions": { + "$id": "3276", + "json": { + "$id": "3277", + "name": "maxTokenLength" + } + } + }, + { + "$id": "3278", + "kind": "property", + "name": "isSearchTokenizer", + "serializedName": "isSearchTokenizer", + "doc": "A value indicating how the tokenizer is used. Set to true if used as the search\ntokenizer, set to false if used as the indexing tokenizer. Default is false.", + "type": { + "$id": "3279", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MicrosoftLanguageTokenizer.isSearchTokenizer", + "serializationOptions": { + "$id": "3280", + "json": { + "$id": "3281", + "name": "isSearchTokenizer" + } + } + }, + { + "$id": "3282", + "kind": "property", + "name": "language", + "serializedName": "language", + "doc": "The language to use. The default is English.", + "type": { + "$ref": "671" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MicrosoftLanguageTokenizer.language", + "serializationOptions": { + "$id": "3283", + "json": { + "$id": "3284", + "name": "language" + } + } + }, + { + "$id": "3285", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of tokenizer.", + "type": { + "$id": "3286", + "kind": "constant", + "valueType": { + "$id": "3287", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.MicrosoftLanguageTokenizer", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MicrosoftLanguageTokenizer.@odata.type", + "serializationOptions": { + "$id": "3288", + "json": { + "$id": "3289", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer": { + "$id": "3290", + "kind": "model", + "name": "MicrosoftLanguageStemmingTokenizer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.MicrosoftLanguageStemmingTokenizer", + "usage": "Input,Output,Json", + "doc": "Divides text using language-specific rules and reduces words to their base\nforms.", + "discriminatorValue": "#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer", + "decorators": [], + "baseModel": { + "$ref": "3225" + }, + "properties": [ + { + "$id": "3291", + "kind": "property", + "name": "maxTokenLength", + "serializedName": "maxTokenLength", + "doc": "The maximum token length. Tokens longer than the maximum length are split.\nMaximum token length that can be used is 300 characters. Tokens longer than 300\ncharacters are first split into tokens of length 300 and then each of those\ntokens is split based on the max token length set. Default is 255.", + "type": { + "$id": "3292", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MicrosoftLanguageStemmingTokenizer.maxTokenLength", + "serializationOptions": { + "$id": "3293", + "json": { + "$id": "3294", + "name": "maxTokenLength" + } + } + }, + { + "$id": "3295", + "kind": "property", + "name": "isSearchTokenizer", + "serializedName": "isSearchTokenizer", + "doc": "A value indicating how the tokenizer is used. Set to true if used as the search\ntokenizer, set to false if used as the indexing tokenizer. Default is false.", + "type": { + "$id": "3296", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MicrosoftLanguageStemmingTokenizer.isSearchTokenizer", + "serializationOptions": { + "$id": "3297", + "json": { + "$id": "3298", + "name": "isSearchTokenizer" + } + } + }, + { + "$id": "3299", + "kind": "property", + "name": "language", + "serializedName": "language", + "doc": "The language to use. The default is English.", + "type": { + "$ref": "757" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MicrosoftLanguageStemmingTokenizer.language", + "serializationOptions": { + "$id": "3300", + "json": { + "$id": "3301", + "name": "language" + } + } + }, + { + "$id": "3302", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of tokenizer.", + "type": { + "$id": "3303", + "kind": "constant", + "valueType": { + "$id": "3304", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MicrosoftLanguageStemmingTokenizer.@odata.type", + "serializationOptions": { + "$id": "3305", + "json": { + "$id": "3306", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.NGramTokenizer": { + "$id": "3307", + "kind": "model", + "name": "NGramTokenizer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.NGramTokenizer", + "usage": "Input,Output,Json", + "doc": "Tokenizes the input into n-grams of the given size(s). This tokenizer is\nimplemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.NGramTokenizer", + "decorators": [], + "baseModel": { + "$ref": "3225" + }, + "properties": [ + { + "$id": "3308", + "kind": "property", + "name": "minGram", + "serializedName": "minGram", + "doc": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the\nvalue of maxGram.", + "type": { + "$id": "3309", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.NGramTokenizer.minGram", + "serializationOptions": { + "$id": "3310", + "json": { + "$id": "3311", + "name": "minGram" + } + } + }, + { + "$id": "3312", + "kind": "property", + "name": "maxGram", + "serializedName": "maxGram", + "doc": "The maximum n-gram length. Default is 2. Maximum is 300.", + "type": { + "$id": "3313", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.NGramTokenizer.maxGram", + "serializationOptions": { + "$id": "3314", + "json": { + "$id": "3315", + "name": "maxGram" + } + } + }, + { + "$id": "3316", + "kind": "property", + "name": "tokenChars", + "serializedName": "tokenChars", + "doc": "Character classes to keep in the tokens.", + "type": { + "$id": "3317", + "kind": "array", + "name": "ArrayTokenCharacterKind", + "valueType": { + "$ref": "659" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.NGramTokenizer.tokenChars", + "serializationOptions": { + "$id": "3318", + "json": { + "$id": "3319", + "name": "tokenChars" + } + } + }, + { + "$id": "3320", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of tokenizer.", + "type": { + "$id": "3321", + "kind": "constant", + "valueType": { + "$id": "3322", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.NGramTokenizer", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.NGramTokenizer.@odata.type", + "serializationOptions": { + "$id": "3323", + "json": { + "$id": "3324", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.PathHierarchyTokenizerV2": { + "$id": "3325", + "kind": "model", + "name": "PathHierarchyTokenizerV2", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.PathHierarchyTokenizerV2", + "usage": "Input,Output,Json", + "doc": "Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache\nLucene.", + "discriminatorValue": "#Microsoft.Azure.Search.PathHierarchyTokenizerV2", + "decorators": [], + "baseModel": { + "$ref": "3225" + }, + "properties": [ + { + "$id": "3326", + "kind": "property", + "name": "delimiter", + "serializedName": "delimiter", + "doc": "The delimiter character to use. Default is \"/\".", + "type": { + "$id": "3327", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PathHierarchyTokenizerV2.delimiter", + "serializationOptions": { + "$id": "3328", + "json": { + "$id": "3329", + "name": "delimiter" + } + } + }, + { + "$id": "3330", + "kind": "property", + "name": "replacement", + "serializedName": "replacement", + "doc": "A value that, if set, replaces the delimiter character. Default is \"/\".", + "type": { + "$id": "3331", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PathHierarchyTokenizerV2.replacement", + "serializationOptions": { + "$id": "3332", + "json": { + "$id": "3333", + "name": "replacement" + } + } + }, + { + "$id": "3334", + "kind": "property", + "name": "maxTokenLength", + "serializedName": "maxTokenLength", + "doc": "The maximum token length. Default and maximum is 300.", + "type": { + "$id": "3335", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PathHierarchyTokenizerV2.maxTokenLength", + "serializationOptions": { + "$id": "3336", + "json": { + "$id": "3337", + "name": "maxTokenLength" + } + } + }, + { + "$id": "3338", + "kind": "property", + "name": "reverseTokenOrder", + "serializedName": "reverse", + "doc": "A value indicating whether to generate tokens in reverse order. Default is\nfalse.", + "type": { + "$id": "3339", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PathHierarchyTokenizerV2.reverse", + "serializationOptions": { + "$id": "3340", + "json": { + "$id": "3341", + "name": "reverse" + } + } + }, + { + "$id": "3342", + "kind": "property", + "name": "numberOfTokensToSkip", + "serializedName": "skip", + "doc": "The number of initial tokens to skip. Default is 0.", + "type": { + "$id": "3343", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PathHierarchyTokenizerV2.skip", + "serializationOptions": { + "$id": "3344", + "json": { + "$id": "3345", + "name": "skip" + } + } + }, + { + "$id": "3346", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of tokenizer.", + "type": { + "$id": "3347", + "kind": "constant", + "valueType": { + "$id": "3348", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.PathHierarchyTokenizerV2", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PathHierarchyTokenizerV2.@odata.type", + "serializationOptions": { + "$id": "3349", + "json": { + "$id": "3350", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.PatternTokenizer": { + "$id": "3351", + "kind": "model", + "name": "PatternTokenizer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.PatternTokenizer", + "usage": "Input,Output,Json", + "doc": "Tokenizer that uses regex pattern matching to construct distinct tokens. This\ntokenizer is implemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.PatternTokenizer", + "decorators": [], + "baseModel": { + "$ref": "3225" + }, + "properties": [ + { + "$id": "3352", + "kind": "property", + "name": "pattern", + "serializedName": "pattern", + "doc": "A regular expression pattern to match token separators. Default is an\nexpression that matches one or more non-word characters.", + "type": { + "$id": "3353", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternTokenizer.pattern", + "serializationOptions": { + "$id": "3354", + "json": { + "$id": "3355", + "name": "pattern" + } + } + }, + { + "$id": "3356", + "kind": "property", + "name": "flags", + "serializedName": "flags", + "doc": "Regular expression flags.", + "type": { + "$ref": "641" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternTokenizer.flags", + "serializationOptions": { + "$id": "3357", + "json": { + "$id": "3358", + "name": "flags" + } + } + }, + { + "$id": "3359", + "kind": "property", + "name": "group", + "serializedName": "group", + "doc": "The zero-based ordinal of the matching group in the regular expression pattern\nto extract into tokens. Use -1 if you want to use the entire pattern to split\nthe input into tokens, irrespective of matching groups. Default is -1.", + "type": { + "$id": "3360", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternTokenizer.group", + "serializationOptions": { + "$id": "3361", + "json": { + "$id": "3362", + "name": "group" + } + } + }, + { + "$id": "3363", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of tokenizer.", + "type": { + "$id": "3364", + "kind": "constant", + "valueType": { + "$id": "3365", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.PatternTokenizer", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternTokenizer.@odata.type", + "serializationOptions": { + "$id": "3366", + "json": { + "$id": "3367", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.StandardTokenizerV2": { + "$id": "3368", + "kind": "model", + "name": "LuceneStandardTokenizerV2", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.LuceneStandardTokenizerV2", + "usage": "Input,Output,Json", + "doc": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is\nimplemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.StandardTokenizerV2", + "decorators": [], + "baseModel": { + "$ref": "3225" + }, + "properties": [ + { + "$id": "3369", + "kind": "property", + "name": "maxTokenLength", + "serializedName": "maxTokenLength", + "doc": "The maximum token length. Default is 255. Tokens longer than the maximum length\nare split. The maximum token length that can be used is 300 characters.", + "type": { + "$id": "3370", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LuceneStandardTokenizerV2.maxTokenLength", + "serializationOptions": { + "$id": "3371", + "json": { + "$id": "3372", + "name": "maxTokenLength" + } + } + }, + { + "$id": "3373", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of tokenizer.", + "type": { + "$id": "3374", + "kind": "constant", + "valueType": { + "$id": "3375", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.StandardTokenizerV2", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LuceneStandardTokenizerV2.@odata.type", + "serializationOptions": { + "$id": "3376", + "json": { + "$id": "3377", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.UaxUrlEmailTokenizer": { + "$id": "3378", + "kind": "model", + "name": "UaxUrlEmailTokenizer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.UaxUrlEmailTokenizer", + "usage": "Input,Output,Json", + "doc": "Tokenizes urls and emails as one token. This tokenizer is implemented using\nApache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.UaxUrlEmailTokenizer", + "decorators": [], + "baseModel": { + "$ref": "3225" + }, + "properties": [ + { + "$id": "3379", + "kind": "property", + "name": "maxTokenLength", + "serializedName": "maxTokenLength", + "doc": "The maximum token length. Default is 255. Tokens longer than the maximum length\nare split. The maximum token length that can be used is 300 characters.", + "type": { + "$id": "3380", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.UaxUrlEmailTokenizer.maxTokenLength", + "serializationOptions": { + "$id": "3381", + "json": { + "$id": "3382", + "name": "maxTokenLength" + } + } + }, + { + "$id": "3383", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of tokenizer.", + "type": { + "$id": "3384", + "kind": "constant", + "valueType": { + "$id": "3385", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.UaxUrlEmailTokenizer", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.UaxUrlEmailTokenizer.@odata.type", + "serializationOptions": { + "$id": "3386", + "json": { + "$id": "3387", + "name": "@odata.type" + } + } + } + ] + } + } + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.tokenizers", + "serializationOptions": { + "$id": "3388", + "json": { + "$id": "3389", + "name": "tokenizers" + } + } + }, + { + "$id": "3390", + "kind": "property", + "name": "tokenFilters", + "serializedName": "tokenFilters", + "doc": "The token filters for the index.", + "type": { + "$id": "3391", + "kind": "array", + "name": "ArrayTokenFilter", + "valueType": { + "$id": "3392", + "kind": "model", + "name": "TokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.TokenFilter", + "usage": "Input,Output,Json", + "doc": "Base type for token filters.", + "decorators": [], + "discriminatorProperty": { + "$id": "3393", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "The discriminator for derived types.", + "type": { + "$id": "3394", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.TokenFilter.@odata.type", + "serializationOptions": { + "$id": "3395", + "json": { + "$id": "3396", + "name": "@odata.type" + } + } + }, + "properties": [ + { + "$ref": "3393" + }, + { + "$id": "3397", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the token filter. It must only contain letters, digits, spaces,\ndashes or underscores, can only start and end with alphanumeric characters, and\nis limited to 128 characters.", + "type": { + "$id": "3398", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.TokenFilter.name", + "serializationOptions": { + "$id": "3399", + "json": { + "$id": "3400", + "name": "name" + } + } + } + ], + "discriminatedSubtypes": { + "$id": "3401", + "#Microsoft.Azure.Search.AsciiFoldingTokenFilter": { + "$id": "3402", + "kind": "model", + "name": "AsciiFoldingTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AsciiFoldingTokenFilter", + "usage": "Input,Output,Json", + "doc": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in\nthe first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their\nASCII equivalents, if such equivalents exist. This token filter is implemented\nusing Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3403", + "kind": "property", + "name": "preserveOriginal", + "serializedName": "preserveOriginal", + "doc": "A value indicating whether the original token will be kept. Default is false.", + "type": { + "$id": "3404", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AsciiFoldingTokenFilter.preserveOriginal", + "serializationOptions": { + "$id": "3405", + "json": { + "$id": "3406", + "name": "preserveOriginal" + } + } + }, + { + "$id": "3407", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3408", + "kind": "constant", + "valueType": { + "$id": "3409", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AsciiFoldingTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3410", + "json": { + "$id": "3411", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.CjkBigramTokenFilter": { + "$id": "3412", + "kind": "model", + "name": "CjkBigramTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.CjkBigramTokenFilter", + "usage": "Input,Output,Json", + "doc": "Forms bigrams of CJK terms that are generated from the standard tokenizer. This\ntoken filter is implemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.CjkBigramTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3413", + "kind": "property", + "name": "ignoreScripts", + "serializedName": "ignoreScripts", + "doc": "The scripts to ignore.", + "type": { + "$id": "3414", + "kind": "array", + "name": "ArrayCjkBigramTokenFilterScripts", + "valueType": { + "$ref": "849" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CjkBigramTokenFilter.ignoreScripts", + "serializationOptions": { + "$id": "3415", + "json": { + "$id": "3416", + "name": "ignoreScripts" + } + } + }, + { + "$id": "3417", + "kind": "property", + "name": "outputUnigrams", + "serializedName": "outputUnigrams", + "doc": "A value indicating whether to output both unigrams and bigrams (if true), or\njust bigrams (if false). Default is false.", + "type": { + "$id": "3418", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CjkBigramTokenFilter.outputUnigrams", + "serializationOptions": { + "$id": "3419", + "json": { + "$id": "3420", + "name": "outputUnigrams" + } + } + }, + { + "$id": "3421", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3422", + "kind": "constant", + "valueType": { + "$id": "3423", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.CjkBigramTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CjkBigramTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3424", + "json": { + "$id": "3425", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.CommonGramTokenFilter": { + "$id": "3426", + "kind": "model", + "name": "CommonGramTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.CommonGramTokenFilter", + "usage": "Input,Output,Json", + "doc": "Construct bigrams for frequently occurring terms while indexing. Single terms\nare still indexed too, with bigrams overlaid. This token filter is implemented\nusing Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.CommonGramTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3427", + "kind": "property", + "name": "commonWords", + "serializedName": "commonWords", + "doc": "The set of common words.", + "type": { + "$id": "3428", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3429", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CommonGramTokenFilter.commonWords", + "serializationOptions": { + "$id": "3430", + "json": { + "$id": "3431", + "name": "commonWords" + } + } + }, + { + "$id": "3432", + "kind": "property", + "name": "ignoreCase", + "serializedName": "ignoreCase", + "doc": "A value indicating whether common words matching will be case insensitive.\nDefault is false.", + "type": { + "$id": "3433", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CommonGramTokenFilter.ignoreCase", + "serializationOptions": { + "$id": "3434", + "json": { + "$id": "3435", + "name": "ignoreCase" + } + } + }, + { + "$id": "3436", + "kind": "property", + "name": "useQueryMode", + "serializedName": "queryMode", + "doc": "A value that indicates whether the token filter is in query mode. When in query\nmode, the token filter generates bigrams and then removes common words and\nsingle terms followed by a common word. Default is false.", + "type": { + "$id": "3437", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CommonGramTokenFilter.queryMode", + "serializationOptions": { + "$id": "3438", + "json": { + "$id": "3439", + "name": "queryMode" + } + } + }, + { + "$id": "3440", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3441", + "kind": "constant", + "valueType": { + "$id": "3442", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.CommonGramTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CommonGramTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3443", + "json": { + "$id": "3444", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter": { + "$id": "3445", + "kind": "model", + "name": "DictionaryDecompounderTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.DictionaryDecompounderTokenFilter", + "usage": "Input,Output,Json", + "doc": "Decomposes compound words found in many Germanic languages. This token filter\nis implemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3446", + "kind": "property", + "name": "wordList", + "serializedName": "wordList", + "doc": "The list of words to match against.", + "type": { + "$id": "3447", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3448", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DictionaryDecompounderTokenFilter.wordList", + "serializationOptions": { + "$id": "3449", + "json": { + "$id": "3450", + "name": "wordList" + } + } + }, + { + "$id": "3451", + "kind": "property", + "name": "minWordSize", + "serializedName": "minWordSize", + "doc": "The minimum word size. Only words longer than this get processed. Default is 5.\nMaximum is 300.", + "type": { + "$id": "3452", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DictionaryDecompounderTokenFilter.minWordSize", + "serializationOptions": { + "$id": "3453", + "json": { + "$id": "3454", + "name": "minWordSize" + } + } + }, + { + "$id": "3455", + "kind": "property", + "name": "minSubwordSize", + "serializedName": "minSubwordSize", + "doc": "The minimum subword size. Only subwords longer than this are outputted. Default\nis 2. Maximum is 300.", + "type": { + "$id": "3456", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DictionaryDecompounderTokenFilter.minSubwordSize", + "serializationOptions": { + "$id": "3457", + "json": { + "$id": "3458", + "name": "minSubwordSize" + } + } + }, + { + "$id": "3459", + "kind": "property", + "name": "maxSubwordSize", + "serializedName": "maxSubwordSize", + "doc": "The maximum subword size. Only subwords shorter than this are outputted.\nDefault is 15. Maximum is 300.", + "type": { + "$id": "3460", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DictionaryDecompounderTokenFilter.maxSubwordSize", + "serializationOptions": { + "$id": "3461", + "json": { + "$id": "3462", + "name": "maxSubwordSize" + } + } + }, + { + "$id": "3463", + "kind": "property", + "name": "onlyLongestMatch", + "serializedName": "onlyLongestMatch", + "doc": "A value indicating whether to add only the longest matching subword to the\noutput. Default is false.", + "type": { + "$id": "3464", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DictionaryDecompounderTokenFilter.onlyLongestMatch", + "serializationOptions": { + "$id": "3465", + "json": { + "$id": "3466", + "name": "onlyLongestMatch" + } + } + }, + { + "$id": "3467", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3468", + "kind": "constant", + "valueType": { + "$id": "3469", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DictionaryDecompounderTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3470", + "json": { + "$id": "3471", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2": { + "$id": "3472", + "kind": "model", + "name": "EdgeNGramTokenFilterV2", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.EdgeNGramTokenFilterV2", + "usage": "Input,Output,Json", + "doc": "Generates n-grams of the given size(s) starting from the front or the back of\nan input token. This token filter is implemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3473", + "kind": "property", + "name": "minGram", + "serializedName": "minGram", + "doc": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the\nvalue of maxGram.", + "type": { + "$id": "3474", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EdgeNGramTokenFilterV2.minGram", + "serializationOptions": { + "$id": "3475", + "json": { + "$id": "3476", + "name": "minGram" + } + } + }, + { + "$id": "3477", + "kind": "property", + "name": "maxGram", + "serializedName": "maxGram", + "doc": "The maximum n-gram length. Default is 2. Maximum is 300.", + "type": { + "$id": "3478", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EdgeNGramTokenFilterV2.maxGram", + "serializationOptions": { + "$id": "3479", + "json": { + "$id": "3480", + "name": "maxGram" + } + } + }, + { + "$id": "3481", + "kind": "property", + "name": "side", + "serializedName": "side", + "doc": "Specifies which side of the input the n-gram should be generated from. Default\nis \"front\".", + "type": { + "$ref": "859" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EdgeNGramTokenFilterV2.side", + "serializationOptions": { + "$id": "3482", + "json": { + "$id": "3483", + "name": "side" + } + } + }, + { + "$id": "3484", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3485", + "kind": "constant", + "valueType": { + "$id": "3486", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EdgeNGramTokenFilterV2.@odata.type", + "serializationOptions": { + "$id": "3487", + "json": { + "$id": "3488", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.ElisionTokenFilter": { + "$id": "3489", + "kind": "model", + "name": "ElisionTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ElisionTokenFilter", + "usage": "Input,Output,Json", + "doc": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to\n\"avion\" (plane). This token filter is implemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.ElisionTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3490", + "kind": "property", + "name": "articles", + "serializedName": "articles", + "doc": "The set of articles to remove.", + "type": { + "$id": "3491", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3492", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ElisionTokenFilter.articles", + "serializationOptions": { + "$id": "3493", + "json": { + "$id": "3494", + "name": "articles" + } + } + }, + { + "$id": "3495", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3496", + "kind": "constant", + "valueType": { + "$id": "3497", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.ElisionTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ElisionTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3498", + "json": { + "$id": "3499", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.KeepTokenFilter": { + "$id": "3500", + "kind": "model", + "name": "KeepTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.KeepTokenFilter", + "usage": "Input,Output,Json", + "doc": "A token filter that only keeps tokens with text contained in a specified list\nof words. This token filter is implemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.KeepTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3501", + "kind": "property", + "name": "keepWords", + "serializedName": "keepWords", + "doc": "The list of words to keep.", + "type": { + "$id": "3502", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3503", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.KeepTokenFilter.keepWords", + "serializationOptions": { + "$id": "3504", + "json": { + "$id": "3505", + "name": "keepWords" + } + } + }, + { + "$id": "3506", + "kind": "property", + "name": "lowerCaseKeepWords", + "serializedName": "keepWordsCase", + "doc": "A value indicating whether to lower case all words first. Default is false.", + "type": { + "$id": "3507", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.KeepTokenFilter.keepWordsCase", + "serializationOptions": { + "$id": "3508", + "json": { + "$id": "3509", + "name": "keepWordsCase" + } + } + }, + { + "$id": "3510", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3511", + "kind": "constant", + "valueType": { + "$id": "3512", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.KeepTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.KeepTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3513", + "json": { + "$id": "3514", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.KeywordMarkerTokenFilter": { + "$id": "3515", + "kind": "model", + "name": "KeywordMarkerTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.KeywordMarkerTokenFilter", + "usage": "Input,Output,Json", + "doc": "Marks terms as keywords. This token filter is implemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.KeywordMarkerTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3516", + "kind": "property", + "name": "keywords", + "serializedName": "keywords", + "doc": "A list of words to mark as keywords.", + "type": { + "$id": "3517", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3518", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.KeywordMarkerTokenFilter.keywords", + "serializationOptions": { + "$id": "3519", + "json": { + "$id": "3520", + "name": "keywords" + } + } + }, + { + "$id": "3521", + "kind": "property", + "name": "ignoreCase", + "serializedName": "ignoreCase", + "doc": "A value indicating whether to ignore case. If true, all words are converted to\nlower case first. Default is false.", + "type": { + "$id": "3522", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.KeywordMarkerTokenFilter.ignoreCase", + "serializationOptions": { + "$id": "3523", + "json": { + "$id": "3524", + "name": "ignoreCase" + } + } + }, + { + "$id": "3525", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3526", + "kind": "constant", + "valueType": { + "$id": "3527", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.KeywordMarkerTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.KeywordMarkerTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3528", + "json": { + "$id": "3529", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.LengthTokenFilter": { + "$id": "3530", + "kind": "model", + "name": "LengthTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.LengthTokenFilter", + "usage": "Input,Output,Json", + "doc": "Removes words that are too long or too short. This token filter is implemented\nusing Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.LengthTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3531", + "kind": "property", + "name": "minLength", + "serializedName": "min", + "doc": "The minimum length in characters. Default is 0. Maximum is 300. Must be less\nthan the value of max.", + "type": { + "$id": "3532", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LengthTokenFilter.min", + "serializationOptions": { + "$id": "3533", + "json": { + "$id": "3534", + "name": "min" + } + } + }, + { + "$id": "3535", + "kind": "property", + "name": "maxLength", + "serializedName": "max", + "doc": "The maximum length in characters. Default and maximum is 300.", + "type": { + "$id": "3536", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LengthTokenFilter.max", + "serializationOptions": { + "$id": "3537", + "json": { + "$id": "3538", + "name": "max" + } + } + }, + { + "$id": "3539", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3540", + "kind": "constant", + "valueType": { + "$id": "3541", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.LengthTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LengthTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3542", + "json": { + "$id": "3543", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.LimitTokenFilter": { + "$id": "3544", + "kind": "model", + "name": "LimitTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.LimitTokenFilter", + "usage": "Input,Output,Json", + "doc": "Limits the number of tokens while indexing. This token filter is implemented\nusing Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.LimitTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3545", + "kind": "property", + "name": "maxTokenCount", + "serializedName": "maxTokenCount", + "doc": "The maximum number of tokens to produce. Default is 1.", + "type": { + "$id": "3546", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LimitTokenFilter.maxTokenCount", + "serializationOptions": { + "$id": "3547", + "json": { + "$id": "3548", + "name": "maxTokenCount" + } + } + }, + { + "$id": "3549", + "kind": "property", + "name": "consumeAllTokens", + "serializedName": "consumeAllTokens", + "doc": "A value indicating whether all tokens from the input must be consumed even if\nmaxTokenCount is reached. Default is false.", + "type": { + "$id": "3550", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LimitTokenFilter.consumeAllTokens", + "serializationOptions": { + "$id": "3551", + "json": { + "$id": "3552", + "name": "consumeAllTokens" + } + } + }, + { + "$id": "3553", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3554", + "kind": "constant", + "valueType": { + "$id": "3555", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.LimitTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LimitTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3556", + "json": { + "$id": "3557", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.NGramTokenFilterV2": { + "$id": "3558", + "kind": "model", + "name": "NGramTokenFilterV2", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.NGramTokenFilterV2", + "usage": "Input,Output,Json", + "doc": "Generates n-grams of the given size(s). This token filter is implemented using\nApache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.NGramTokenFilterV2", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3559", + "kind": "property", + "name": "minGram", + "serializedName": "minGram", + "doc": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the\nvalue of maxGram.", + "type": { + "$id": "3560", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.NGramTokenFilterV2.minGram", + "serializationOptions": { + "$id": "3561", + "json": { + "$id": "3562", + "name": "minGram" + } + } + }, + { + "$id": "3563", + "kind": "property", + "name": "maxGram", + "serializedName": "maxGram", + "doc": "The maximum n-gram length. Default is 2. Maximum is 300.", + "type": { + "$id": "3564", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.NGramTokenFilterV2.maxGram", + "serializationOptions": { + "$id": "3565", + "json": { + "$id": "3566", + "name": "maxGram" + } + } + }, + { + "$id": "3567", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3568", + "kind": "constant", + "valueType": { + "$id": "3569", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.NGramTokenFilterV2", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.NGramTokenFilterV2.@odata.type", + "serializationOptions": { + "$id": "3570", + "json": { + "$id": "3571", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.PatternCaptureTokenFilter": { + "$id": "3572", + "kind": "model", + "name": "PatternCaptureTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.PatternCaptureTokenFilter", + "usage": "Input,Output,Json", + "doc": "Uses Java regexes to emit multiple tokens - one for each capture group in one\nor more patterns. This token filter is implemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.PatternCaptureTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3573", + "kind": "property", + "name": "patterns", + "serializedName": "patterns", + "doc": "A list of patterns to match against each token.", + "type": { + "$id": "3574", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3575", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternCaptureTokenFilter.patterns", + "serializationOptions": { + "$id": "3576", + "json": { + "$id": "3577", + "name": "patterns" + } + } + }, + { + "$id": "3578", + "kind": "property", + "name": "preserveOriginal", + "serializedName": "preserveOriginal", + "doc": "A value indicating whether to return the original token even if one of the\npatterns matches. Default is true.", + "type": { + "$id": "3579", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternCaptureTokenFilter.preserveOriginal", + "serializationOptions": { + "$id": "3580", + "json": { + "$id": "3581", + "name": "preserveOriginal" + } + } + }, + { + "$id": "3582", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3583", + "kind": "constant", + "valueType": { + "$id": "3584", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.PatternCaptureTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternCaptureTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3585", + "json": { + "$id": "3586", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.PatternReplaceTokenFilter": { + "$id": "3587", + "kind": "model", + "name": "PatternReplaceTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.PatternReplaceTokenFilter", + "usage": "Input,Output,Json", + "doc": "A character filter that replaces characters in the input string. It uses a\nregular expression to identify character sequences to preserve and a\nreplacement pattern to identify characters to replace. For example, given the\ninput text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the\nresult would be \"aa#bb aa#bb\". This token filter is implemented using Apache\nLucene.", + "discriminatorValue": "#Microsoft.Azure.Search.PatternReplaceTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3588", + "kind": "property", + "name": "pattern", + "serializedName": "pattern", + "doc": "A regular expression pattern.", + "type": { + "$id": "3589", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternReplaceTokenFilter.pattern", + "serializationOptions": { + "$id": "3590", + "json": { + "$id": "3591", + "name": "pattern" + } + } + }, + { + "$id": "3592", + "kind": "property", + "name": "replacement", + "serializedName": "replacement", + "doc": "The replacement text.", + "type": { + "$id": "3593", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternReplaceTokenFilter.replacement", + "serializationOptions": { + "$id": "3594", + "json": { + "$id": "3595", + "name": "replacement" + } + } + }, + { + "$id": "3596", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3597", + "kind": "constant", + "valueType": { + "$id": "3598", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.PatternReplaceTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternReplaceTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3599", + "json": { + "$id": "3600", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.PhoneticTokenFilter": { + "$id": "3601", + "kind": "model", + "name": "PhoneticTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.PhoneticTokenFilter", + "usage": "Input,Output,Json", + "doc": "Create tokens for phonetic matches. This token filter is implemented using\nApache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.PhoneticTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3602", + "kind": "property", + "name": "encoder", + "serializedName": "encoder", + "doc": "The phonetic encoder to use. Default is \"metaphone\".", + "type": { + "$ref": "865" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PhoneticTokenFilter.encoder", + "serializationOptions": { + "$id": "3603", + "json": { + "$id": "3604", + "name": "encoder" + } + } + }, + { + "$id": "3605", + "kind": "property", + "name": "replaceOriginalTokens", + "serializedName": "replace", + "doc": "A value indicating whether encoded tokens should replace original tokens. If\nfalse, encoded tokens are added as synonyms. Default is true.", + "type": { + "$id": "3606", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PhoneticTokenFilter.replace", + "serializationOptions": { + "$id": "3607", + "json": { + "$id": "3608", + "name": "replace" + } + } + }, + { + "$id": "3609", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3610", + "kind": "constant", + "valueType": { + "$id": "3611", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.PhoneticTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PhoneticTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3612", + "json": { + "$id": "3613", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.ShingleTokenFilter": { + "$id": "3614", + "kind": "model", + "name": "ShingleTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ShingleTokenFilter", + "usage": "Input,Output,Json", + "doc": "Creates combinations of tokens as a single token. This token filter is\nimplemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.ShingleTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3615", + "kind": "property", + "name": "maxShingleSize", + "serializedName": "maxShingleSize", + "doc": "The maximum shingle size. Default and minimum value is 2.", + "type": { + "$id": "3616", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ShingleTokenFilter.maxShingleSize", + "serializationOptions": { + "$id": "3617", + "json": { + "$id": "3618", + "name": "maxShingleSize" + } + } + }, + { + "$id": "3619", + "kind": "property", + "name": "minShingleSize", + "serializedName": "minShingleSize", + "doc": "The minimum shingle size. Default and minimum value is 2. Must be less than the\nvalue of maxShingleSize.", + "type": { + "$id": "3620", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ShingleTokenFilter.minShingleSize", + "serializationOptions": { + "$id": "3621", + "json": { + "$id": "3622", + "name": "minShingleSize" + } + } + }, + { + "$id": "3623", + "kind": "property", + "name": "outputUnigrams", + "serializedName": "outputUnigrams", + "doc": "A value indicating whether the output stream will contain the input tokens\n(unigrams) as well as shingles. Default is true.", + "type": { + "$id": "3624", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ShingleTokenFilter.outputUnigrams", + "serializationOptions": { + "$id": "3625", + "json": { + "$id": "3626", + "name": "outputUnigrams" + } + } + }, + { + "$id": "3627", + "kind": "property", + "name": "outputUnigramsIfNoShingles", + "serializedName": "outputUnigramsIfNoShingles", + "doc": "A value indicating whether to output unigrams for those times when no shingles\nare available. This property takes precedence when outputUnigrams is set to\nfalse. Default is false.", + "type": { + "$id": "3628", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ShingleTokenFilter.outputUnigramsIfNoShingles", + "serializationOptions": { + "$id": "3629", + "json": { + "$id": "3630", + "name": "outputUnigramsIfNoShingles" + } + } + }, + { + "$id": "3631", + "kind": "property", + "name": "tokenSeparator", + "serializedName": "tokenSeparator", + "doc": "The string to use when joining adjacent tokens to form a shingle. Default is a\nsingle space (\" \").", + "type": { + "$id": "3632", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ShingleTokenFilter.tokenSeparator", + "serializationOptions": { + "$id": "3633", + "json": { + "$id": "3634", + "name": "tokenSeparator" + } + } + }, + { + "$id": "3635", + "kind": "property", + "name": "filterToken", + "serializedName": "filterToken", + "doc": "The string to insert for each position at which there is no token. Default is\nan underscore (\"_\").", + "type": { + "$id": "3636", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ShingleTokenFilter.filterToken", + "serializationOptions": { + "$id": "3637", + "json": { + "$id": "3638", + "name": "filterToken" + } + } + }, + { + "$id": "3639", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3640", + "kind": "constant", + "valueType": { + "$id": "3641", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.ShingleTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ShingleTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3642", + "json": { + "$id": "3643", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.SnowballTokenFilter": { + "$id": "3644", + "kind": "model", + "name": "SnowballTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SnowballTokenFilter", + "usage": "Input,Output,Json", + "doc": "A filter that stems words using a Snowball-generated stemmer. This token filter\nis implemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.SnowballTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3645", + "kind": "property", + "name": "language", + "serializedName": "language", + "doc": "The language to use.", + "type": { + "$ref": "889" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SnowballTokenFilter.language", + "serializationOptions": { + "$id": "3646", + "json": { + "$id": "3647", + "name": "language" + } + } + }, + { + "$id": "3648", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3649", + "kind": "constant", + "valueType": { + "$id": "3650", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.SnowballTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SnowballTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3651", + "json": { + "$id": "3652", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.StemmerTokenFilter": { + "$id": "3653", + "kind": "model", + "name": "StemmerTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.StemmerTokenFilter", + "usage": "Input,Output,Json", + "doc": "Language specific stemming filter. This token filter is implemented using\nApache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.StemmerTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3654", + "kind": "property", + "name": "language", + "serializedName": "language", + "doc": "The language to use.", + "type": { + "$ref": "935" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.StemmerTokenFilter.language", + "serializationOptions": { + "$id": "3655", + "json": { + "$id": "3656", + "name": "language" + } + } + }, + { + "$id": "3657", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3658", + "kind": "constant", + "valueType": { + "$id": "3659", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.StemmerTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.StemmerTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3660", + "json": { + "$id": "3661", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.StemmerOverrideTokenFilter": { + "$id": "3662", + "kind": "model", + "name": "StemmerOverrideTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.StemmerOverrideTokenFilter", + "usage": "Input,Output,Json", + "doc": "Provides the ability to override other stemming filters with custom\ndictionary-based stemming. Any dictionary-stemmed terms will be marked as\nkeywords so that they will not be stemmed with stemmers down the chain. Must be\nplaced before any stemming filters. This token filter is implemented using\nApache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.StemmerOverrideTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3663", + "kind": "property", + "name": "rules", + "serializedName": "rules", + "doc": "A list of stemming rules in the following format: \"word => stem\", for example:\n\"ran => run\".", + "type": { + "$id": "3664", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3665", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.StemmerOverrideTokenFilter.rules", + "serializationOptions": { + "$id": "3666", + "json": { + "$id": "3667", + "name": "rules" + } + } + }, + { + "$id": "3668", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3669", + "kind": "constant", + "valueType": { + "$id": "3670", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.StemmerOverrideTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.StemmerOverrideTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3671", + "json": { + "$id": "3672", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.StopwordsTokenFilter": { + "$id": "3673", + "kind": "model", + "name": "StopwordsTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.StopwordsTokenFilter", + "usage": "Input,Output,Json", + "doc": "Removes stop words from a token stream. This token filter is implemented using\nApache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.StopwordsTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3674", + "kind": "property", + "name": "stopwords", + "serializedName": "stopwords", + "doc": "The list of stopwords. This property and the stopwords list property cannot\nboth be set.", + "type": { + "$id": "3675", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3676", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.StopwordsTokenFilter.stopwords", + "serializationOptions": { + "$id": "3677", + "json": { + "$id": "3678", + "name": "stopwords" + } + } + }, + { + "$id": "3679", + "kind": "property", + "name": "stopwordsList", + "serializedName": "stopwordsList", + "doc": "A predefined list of stopwords to use. This property and the stopwords property\ncannot both be set. Default is English.", + "type": { + "$ref": "1045" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.StopwordsTokenFilter.stopwordsList", + "serializationOptions": { + "$id": "3680", + "json": { + "$id": "3681", + "name": "stopwordsList" + } + } + }, + { + "$id": "3682", + "kind": "property", + "name": "ignoreCase", + "serializedName": "ignoreCase", + "doc": "A value indicating whether to ignore case. If true, all words are converted to\nlower case first. Default is false.", + "type": { + "$id": "3683", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.StopwordsTokenFilter.ignoreCase", + "serializationOptions": { + "$id": "3684", + "json": { + "$id": "3685", + "name": "ignoreCase" + } + } + }, + { + "$id": "3686", + "kind": "property", + "name": "removeTrailingStopWords", + "serializedName": "removeTrailing", + "doc": "A value indicating whether to ignore the last search term if it's a stop word.\nDefault is true.", + "type": { + "$id": "3687", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.StopwordsTokenFilter.removeTrailing", + "serializationOptions": { + "$id": "3688", + "json": { + "$id": "3689", + "name": "removeTrailing" + } + } + }, + { + "$id": "3690", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3691", + "kind": "constant", + "valueType": { + "$id": "3692", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.StopwordsTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.StopwordsTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3693", + "json": { + "$id": "3694", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.SynonymTokenFilter": { + "$id": "3695", + "kind": "model", + "name": "SynonymTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SynonymTokenFilter", + "usage": "Input,Output,Json", + "doc": "Matches single or multi-word synonyms in a token stream. This token filter is\nimplemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.SynonymTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3696", + "kind": "property", + "name": "synonyms", + "serializedName": "synonyms", + "doc": "A list of synonyms in following one of two formats: 1. incredible,\nunbelievable, fabulous => amazing - all terms on the left side of => symbol\nwill be replaced with all terms on its right side; 2. incredible, unbelievable,\nfabulous, amazing - comma separated list of equivalent words. Set the expand\noption to change how this list is interpreted.", + "type": { + "$id": "3697", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3698", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SynonymTokenFilter.synonyms", + "serializationOptions": { + "$id": "3699", + "json": { + "$id": "3700", + "name": "synonyms" + } + } + }, + { + "$id": "3701", + "kind": "property", + "name": "ignoreCase", + "serializedName": "ignoreCase", + "doc": "A value indicating whether to case-fold input for matching. Default is false.", + "type": { + "$id": "3702", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SynonymTokenFilter.ignoreCase", + "serializationOptions": { + "$id": "3703", + "json": { + "$id": "3704", + "name": "ignoreCase" + } + } + }, + { + "$id": "3705", + "kind": "property", + "name": "expand", + "serializedName": "expand", + "doc": "A value indicating whether all words in the list of synonyms (if => notation is\nnot used) will map to one another. If true, all words in the list of synonyms\n(if => notation is not used) will map to one another. The following list:\nincredible, unbelievable, fabulous, amazing is equivalent to: incredible,\nunbelievable, fabulous, amazing => incredible, unbelievable, fabulous, amazing.\nIf false, the following list: incredible, unbelievable, fabulous, amazing will\nbe equivalent to: incredible, unbelievable, fabulous, amazing => incredible.\nDefault is true.", + "type": { + "$id": "3706", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SynonymTokenFilter.expand", + "serializationOptions": { + "$id": "3707", + "json": { + "$id": "3708", + "name": "expand" + } + } + }, + { + "$id": "3709", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3710", + "kind": "constant", + "valueType": { + "$id": "3711", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.SynonymTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SynonymTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3712", + "json": { + "$id": "3713", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.TruncateTokenFilter": { + "$id": "3714", + "kind": "model", + "name": "TruncateTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.TruncateTokenFilter", + "usage": "Input,Output,Json", + "doc": "Truncates the terms to a specific length. This token filter is implemented\nusing Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.TruncateTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3715", + "kind": "property", + "name": "length", + "serializedName": "length", + "doc": "The length at which terms will be truncated. Default and maximum is 300.", + "type": { + "$id": "3716", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.TruncateTokenFilter.length", + "serializationOptions": { + "$id": "3717", + "json": { + "$id": "3718", + "name": "length" + } + } + }, + { + "$id": "3719", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3720", + "kind": "constant", + "valueType": { + "$id": "3721", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.TruncateTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.TruncateTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3722", + "json": { + "$id": "3723", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.UniqueTokenFilter": { + "$id": "3724", + "kind": "model", + "name": "UniqueTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.UniqueTokenFilter", + "usage": "Input,Output,Json", + "doc": "Filters out tokens with same text as the previous token. This token filter is\nimplemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.UniqueTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3725", + "kind": "property", + "name": "onlyOnSamePosition", + "serializedName": "onlyOnSamePosition", + "doc": "A value indicating whether to remove duplicates only at the same position.\nDefault is false.", + "type": { + "$id": "3726", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.UniqueTokenFilter.onlyOnSamePosition", + "serializationOptions": { + "$id": "3727", + "json": { + "$id": "3728", + "name": "onlyOnSamePosition" + } + } + }, + { + "$id": "3729", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3730", + "kind": "constant", + "valueType": { + "$id": "3731", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.UniqueTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.UniqueTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3732", + "json": { + "$id": "3733", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.WordDelimiterTokenFilter": { + "$id": "3734", + "kind": "model", + "name": "WordDelimiterTokenFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.WordDelimiterTokenFilter", + "usage": "Input,Output,Json", + "doc": "Splits words into subwords and performs optional transformations on subword\ngroups. This token filter is implemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.WordDelimiterTokenFilter", + "decorators": [], + "baseModel": { + "$ref": "3392" + }, + "properties": [ + { + "$id": "3735", + "kind": "property", + "name": "generateWordParts", + "serializedName": "generateWordParts", + "doc": "A value indicating whether to generate part words. If set, causes parts of\nwords to be generated; for example \"AzureSearch\" becomes \"Azure\" \"Search\".\nDefault is true.", + "type": { + "$id": "3736", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WordDelimiterTokenFilter.generateWordParts", + "serializationOptions": { + "$id": "3737", + "json": { + "$id": "3738", + "name": "generateWordParts" + } + } + }, + { + "$id": "3739", + "kind": "property", + "name": "generateNumberParts", + "serializedName": "generateNumberParts", + "doc": "A value indicating whether to generate number subwords. Default is true.", + "type": { + "$id": "3740", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WordDelimiterTokenFilter.generateNumberParts", + "serializationOptions": { + "$id": "3741", + "json": { + "$id": "3742", + "name": "generateNumberParts" + } + } + }, + { + "$id": "3743", + "kind": "property", + "name": "catenateWords", + "serializedName": "catenateWords", + "doc": "A value indicating whether maximum runs of word parts will be catenated. For\nexample, if this is set to true, \"Azure-Search\" becomes \"AzureSearch\". Default\nis false.", + "type": { + "$id": "3744", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WordDelimiterTokenFilter.catenateWords", + "serializationOptions": { + "$id": "3745", + "json": { + "$id": "3746", + "name": "catenateWords" + } + } + }, + { + "$id": "3747", + "kind": "property", + "name": "catenateNumbers", + "serializedName": "catenateNumbers", + "doc": "A value indicating whether maximum runs of number parts will be catenated. For\nexample, if this is set to true, \"1-2\" becomes \"12\". Default is false.", + "type": { + "$id": "3748", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WordDelimiterTokenFilter.catenateNumbers", + "serializationOptions": { + "$id": "3749", + "json": { + "$id": "3750", + "name": "catenateNumbers" + } + } + }, + { + "$id": "3751", + "kind": "property", + "name": "catenateAll", + "serializedName": "catenateAll", + "doc": "A value indicating whether all subword parts will be catenated. For example, if\nthis is set to true, \"Azure-Search-1\" becomes \"AzureSearch1\". Default is false.", + "type": { + "$id": "3752", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WordDelimiterTokenFilter.catenateAll", + "serializationOptions": { + "$id": "3753", + "json": { + "$id": "3754", + "name": "catenateAll" + } + } + }, + { + "$id": "3755", + "kind": "property", + "name": "splitOnCaseChange", + "serializedName": "splitOnCaseChange", + "doc": "A value indicating whether to split words on caseChange. For example, if this\nis set to true, \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true.", + "type": { + "$id": "3756", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WordDelimiterTokenFilter.splitOnCaseChange", + "serializationOptions": { + "$id": "3757", + "json": { + "$id": "3758", + "name": "splitOnCaseChange" + } + } + }, + { + "$id": "3759", + "kind": "property", + "name": "preserveOriginal", + "serializedName": "preserveOriginal", + "doc": "A value indicating whether original words will be preserved and added to the\nsubword list. Default is false.", + "type": { + "$id": "3760", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WordDelimiterTokenFilter.preserveOriginal", + "serializationOptions": { + "$id": "3761", + "json": { + "$id": "3762", + "name": "preserveOriginal" + } + } + }, + { + "$id": "3763", + "kind": "property", + "name": "splitOnNumerics", + "serializedName": "splitOnNumerics", + "doc": "A value indicating whether to split on numbers. For example, if this is set to\ntrue, \"Azure1Search\" becomes \"Azure\" \"1\" \"Search\". Default is true.", + "type": { + "$id": "3764", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WordDelimiterTokenFilter.splitOnNumerics", + "serializationOptions": { + "$id": "3765", + "json": { + "$id": "3766", + "name": "splitOnNumerics" + } + } + }, + { + "$id": "3767", + "kind": "property", + "name": "stemEnglishPossessive", + "serializedName": "stemEnglishPossessive", + "doc": "A value indicating whether to remove trailing \"'s\" for each subword. Default is\ntrue.", + "type": { + "$id": "3768", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WordDelimiterTokenFilter.stemEnglishPossessive", + "serializationOptions": { + "$id": "3769", + "json": { + "$id": "3770", + "name": "stemEnglishPossessive" + } + } + }, + { + "$id": "3771", + "kind": "property", + "name": "protectedWords", + "serializedName": "protectedWords", + "doc": "A list of tokens to protect from being delimited.", + "type": { + "$id": "3772", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3773", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WordDelimiterTokenFilter.protectedWords", + "serializationOptions": { + "$id": "3774", + "json": { + "$id": "3775", + "name": "protectedWords" + } + } + }, + { + "$id": "3776", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of token filter.", + "type": { + "$id": "3777", + "kind": "constant", + "valueType": { + "$id": "3778", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.WordDelimiterTokenFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WordDelimiterTokenFilter.@odata.type", + "serializationOptions": { + "$id": "3779", + "json": { + "$id": "3780", + "name": "@odata.type" + } + } + } + ] + } + } + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.tokenFilters", + "serializationOptions": { + "$id": "3781", + "json": { + "$id": "3782", + "name": "tokenFilters" + } + } + }, + { + "$id": "3783", + "kind": "property", + "name": "charFilters", + "serializedName": "charFilters", + "doc": "The character filters for the index.", + "type": { + "$id": "3784", + "kind": "array", + "name": "ArrayCharFilter", + "valueType": { + "$id": "3785", + "kind": "model", + "name": "CharFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.CharFilter", + "usage": "Input,Output,Json", + "doc": "Base type for character filters.", + "decorators": [], + "discriminatorProperty": { + "$id": "3786", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "The discriminator for derived types.", + "type": { + "$id": "3787", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CharFilter.@odata.type", + "serializationOptions": { + "$id": "3788", + "json": { + "$id": "3789", + "name": "@odata.type" + } + } + }, + "properties": [ + { + "$ref": "3786" + }, + { + "$id": "3790", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the char filter. It must only contain letters, digits, spaces,\ndashes or underscores, can only start and end with alphanumeric characters, and\nis limited to 128 characters.", + "type": { + "$id": "3791", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CharFilter.name", + "serializationOptions": { + "$id": "3792", + "json": { + "$id": "3793", + "name": "name" + } + } + } + ], + "discriminatedSubtypes": { + "$id": "3794", + "#Microsoft.Azure.Search.MappingCharFilter": { + "$id": "3795", + "kind": "model", + "name": "MappingCharFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.MappingCharFilter", + "usage": "Input,Output,Json", + "doc": "A character filter that applies mappings defined with the mappings option.\nMatching is greedy (longest pattern matching at a given point wins).\nReplacement is allowed to be the empty string. This character filter is\nimplemented using Apache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.MappingCharFilter", + "decorators": [], + "baseModel": { + "$ref": "3785" + }, + "properties": [ + { + "$id": "3796", + "kind": "property", + "name": "mappings", + "serializedName": "mappings", + "doc": "A list of mappings of the following format: \"a=>b\" (all occurrences of the\ncharacter \"a\" will be replaced with character \"b\").", + "type": { + "$id": "3797", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "3798", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MappingCharFilter.mappings", + "serializationOptions": { + "$id": "3799", + "json": { + "$id": "3800", + "name": "mappings" + } + } + }, + { + "$id": "3801", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of char filter.", + "type": { + "$id": "3802", + "kind": "constant", + "valueType": { + "$id": "3803", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.MappingCharFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MappingCharFilter.@odata.type", + "serializationOptions": { + "$id": "3804", + "json": { + "$id": "3805", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.PatternReplaceCharFilter": { + "$id": "3806", + "kind": "model", + "name": "PatternReplaceCharFilter", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.PatternReplaceCharFilter", + "usage": "Input,Output,Json", + "doc": "A character filter that replaces characters in the input string. It uses a\nregular expression to identify character sequences to preserve and a\nreplacement pattern to identify characters to replace. For example, given the\ninput text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the\nresult would be \"aa#bb aa#bb\". This character filter is implemented using\nApache Lucene.", + "discriminatorValue": "#Microsoft.Azure.Search.PatternReplaceCharFilter", + "decorators": [], + "baseModel": { + "$ref": "3785" + }, + "properties": [ + { + "$id": "3807", + "kind": "property", + "name": "pattern", + "serializedName": "pattern", + "doc": "A regular expression pattern.", + "type": { + "$id": "3808", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternReplaceCharFilter.pattern", + "serializationOptions": { + "$id": "3809", + "json": { + "$id": "3810", + "name": "pattern" + } + } + }, + { + "$id": "3811", + "kind": "property", + "name": "replacement", + "serializedName": "replacement", + "doc": "The replacement text.", + "type": { + "$id": "3812", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternReplaceCharFilter.replacement", + "serializationOptions": { + "$id": "3813", + "json": { + "$id": "3814", + "name": "replacement" + } + } + }, + { + "$id": "3815", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of char filter.", + "type": { + "$id": "3816", + "kind": "constant", + "valueType": { + "$id": "3817", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.PatternReplaceCharFilter", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PatternReplaceCharFilter.@odata.type", + "serializationOptions": { + "$id": "3818", + "json": { + "$id": "3819", + "name": "@odata.type" + } + } + } + ] + } + } + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.charFilters", + "serializationOptions": { + "$id": "3820", + "json": { + "$id": "3821", + "name": "charFilters" + } + } + }, + { + "$id": "3822", + "kind": "property", + "name": "normalizers", + "serializedName": "normalizers", + "doc": "The normalizers for the index.", + "type": { + "$id": "3823", + "kind": "array", + "name": "ArrayLexicalNormalizer", + "valueType": { + "$id": "3824", + "kind": "model", + "name": "LexicalNormalizer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.LexicalNormalizer", + "usage": "Input,Output,Json", + "doc": "Base type for normalizers.", + "decorators": [], + "discriminatorProperty": { + "$id": "3825", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "The discriminator for derived types.", + "type": { + "$id": "3826", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LexicalNormalizer.@odata.type", + "serializationOptions": { + "$id": "3827", + "json": { + "$id": "3828", + "name": "@odata.type" + } + } + }, + "properties": [ + { + "$ref": "3825" + }, + { + "$id": "3829", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the char filter. It must only contain letters, digits, spaces,\ndashes or underscores, can only start and end with alphanumeric characters, and\nis limited to 128 characters.", + "type": { + "$id": "3830", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LexicalNormalizer.name", + "serializationOptions": { + "$id": "3831", + "json": { + "$id": "3832", + "name": "name" + } + } + } + ], + "discriminatedSubtypes": { + "$id": "3833", + "#Microsoft.Azure.Search.CustomNormalizer": { + "$id": "3834", + "kind": "model", + "name": "CustomNormalizer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.CustomNormalizer", + "usage": "Input,Output,Json", + "doc": "Allows you to configure normalization for filterable, sortable, and facetable\nfields, which by default operate with strict matching. This is a user-defined\nconfiguration consisting of at least one or more filters, which modify the\ntoken that is stored.", + "discriminatorValue": "#Microsoft.Azure.Search.CustomNormalizer", + "decorators": [], + "baseModel": { + "$ref": "3824" + }, + "properties": [ + { + "$id": "3835", + "kind": "property", + "name": "tokenFilters", + "serializedName": "tokenFilters", + "doc": "A list of token filters used to filter out or modify the input token. For\nexample, you can specify a lowercase filter that converts all characters to\nlowercase. The filters are run in the order in which they are listed.", + "type": { + "$id": "3836", + "kind": "array", + "name": "ArrayTokenFilterName", + "valueType": { + "$ref": "567" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomNormalizer.tokenFilters", + "serializationOptions": { + "$id": "3837", + "json": { + "$id": "3838", + "name": "tokenFilters" + } + } + }, + { + "$id": "3839", + "kind": "property", + "name": "charFilters", + "serializedName": "charFilters", + "doc": "A list of character filters used to prepare input text before it is processed.\nFor instance, they can replace certain characters or symbols. The filters are\nrun in the order in which they are listed.", + "type": { + "$id": "3840", + "kind": "array", + "name": "ArrayCharFilterName", + "valueType": { + "$ref": "637" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomNormalizer.charFilters", + "serializationOptions": { + "$id": "3841", + "json": { + "$id": "3842", + "name": "charFilters" + } + } + }, + { + "$id": "3843", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of normalizer.", + "type": { + "$id": "3844", + "kind": "constant", + "valueType": { + "$id": "3845", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.CustomNormalizer", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomNormalizer.@odata.type", + "serializationOptions": { + "$id": "3846", + "json": { + "$id": "3847", + "name": "@odata.type" + } + } + } + ] + } + } + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.normalizers", + "serializationOptions": { + "$id": "3848", + "json": { + "$id": "3849", + "name": "normalizers" + } + } + }, + { + "$id": "3850", + "kind": "property", + "name": "encryptionKey", + "serializedName": "encryptionKey", + "doc": "A description of an encryption key that you create in Azure Key Vault. This key\nis used to provide an additional level of encryption-at-rest for your data when\nyou want full assurance that no one, not even Microsoft, can decrypt your data.\nOnce you have encrypted your data, it will always remain encrypted. The search\nservice will ignore attempts to set this property to null. You can change this\nproperty as needed if you want to rotate your encryption key; Your data will be\nunaffected. Encryption with customer-managed keys is not available for free\nsearch services, and is only available for paid services created on or after\nJanuary 1, 2019.", + "type": { + "$id": "3851", + "kind": "model", + "name": "SearchResourceEncryptionKey", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchResourceEncryptionKey", + "usage": "Input,Output,Json", + "doc": "A customer-managed encryption key in Azure Key Vault. Keys that you create and\nmanage can be used to encrypt or decrypt data-at-rest, such as indexes and\nsynonym maps.", + "decorators": [], + "properties": [ + { + "$id": "3852", + "kind": "property", + "name": "keyName", + "serializedName": "keyVaultKeyName", + "doc": "The name of your Azure Key Vault key to be used to encrypt your data at rest.", + "type": { + "$id": "3853", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchResourceEncryptionKey.keyVaultKeyName", + "serializationOptions": { + "$id": "3854", + "json": { + "$id": "3855", + "name": "keyVaultKeyName" + } + } + }, + { + "$id": "3856", + "kind": "property", + "name": "keyVersion", + "serializedName": "keyVaultKeyVersion", + "doc": "The version of your Azure Key Vault key to be used to encrypt your data at rest.", + "type": { + "$id": "3857", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchResourceEncryptionKey.keyVaultKeyVersion", + "serializationOptions": { + "$id": "3858", + "json": { + "$id": "3859", + "name": "keyVaultKeyVersion" + } + } + }, + { + "$id": "3860", + "kind": "property", + "name": "vaultUri", + "serializedName": "keyVaultUri", + "doc": "The URI of your Azure Key Vault, also referred to as DNS name, that contains\nthe key to be used to encrypt your data at rest. An example URI might be\n`https://my-keyvault-name.vault.azure.net`.", + "type": { + "$id": "3861", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchResourceEncryptionKey.keyVaultUri", + "serializationOptions": { + "$id": "3862", + "json": { + "$id": "3863", + "name": "keyVaultUri" + } + } + }, + { + "$id": "3864", + "kind": "property", + "name": "accessCredentials", + "serializedName": "accessCredentials", + "doc": "Optional Azure Active Directory credentials used for accessing your Azure Key\nVault. Not required if using managed identity instead.", + "type": { + "$id": "3865", + "kind": "model", + "name": "AzureActiveDirectoryApplicationCredentials", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AzureActiveDirectoryApplicationCredentials", + "usage": "Input,Output,Json", + "doc": "Credentials of a registered application created for your search service, used\nfor authenticated access to the encryption keys stored in Azure Key Vault.", + "decorators": [], + "properties": [ + { + "$id": "3866", + "kind": "property", + "name": "applicationId", + "serializedName": "applicationId", + "doc": "An AAD Application ID that was granted the required access permissions to the\nAzure Key Vault that is to be used when encrypting your data at rest. The\nApplication ID should not be confused with the Object ID for your AAD\nApplication.", + "type": { + "$id": "3867", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureActiveDirectoryApplicationCredentials.applicationId", + "serializationOptions": { + "$id": "3868", + "json": { + "$id": "3869", + "name": "applicationId" + } + } + }, + { + "$id": "3870", + "kind": "property", + "name": "applicationSecret", + "serializedName": "applicationSecret", + "doc": "The authentication key of the specified AAD application.", + "type": { + "$id": "3871", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureActiveDirectoryApplicationCredentials.applicationSecret", + "serializationOptions": { + "$id": "3872", + "json": { + "$id": "3873", + "name": "applicationSecret" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchResourceEncryptionKey.accessCredentials", + "serializationOptions": { + "$id": "3874", + "json": { + "$id": "3875", + "name": "accessCredentials" + } + } + }, + { + "$id": "3876", + "kind": "property", + "name": "identity", + "serializedName": "identity", + "doc": "An explicit managed identity to use for this encryption key. If not specified\nand the access credentials property is null, the system-assigned managed\nidentity is used. On update to the resource, if the explicit identity is\nunspecified, it remains unchanged. If \"none\" is specified, the value of this\nproperty is cleared.", + "type": { + "$id": "3877", + "kind": "model", + "name": "SearchIndexerDataIdentity", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerDataIdentity", + "usage": "Input,Output,Json", + "doc": "Abstract base type for data identities.", + "decorators": [], + "discriminatorProperty": { + "$id": "3878", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of identity.", + "type": { + "$id": "3879", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataIdentity.@odata.type", + "serializationOptions": { + "$id": "3880", + "json": { + "$id": "3881", + "name": "@odata.type" + } + } + }, + "properties": [ + { + "$ref": "3878" + } + ], + "discriminatedSubtypes": { + "$id": "3882", + "#Microsoft.Azure.Search.DataNoneIdentity": { + "$id": "3883", + "kind": "model", + "name": "SearchIndexerDataNoneIdentity", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerDataNoneIdentity", + "usage": "Input,Output,Json", + "doc": "Clears the identity property of a datasource.", + "discriminatorValue": "#Microsoft.Azure.Search.DataNoneIdentity", + "decorators": [], + "baseModel": { + "$ref": "3877" + }, + "properties": [ + { + "$id": "3884", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "The discriminator for derived types.", + "type": { + "$id": "3885", + "kind": "constant", + "valueType": { + "$id": "3886", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.DataNoneIdentity", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataNoneIdentity.@odata.type", + "serializationOptions": { + "$id": "3887", + "json": { + "$id": "3888", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.DataUserAssignedIdentity": { + "$id": "3889", + "kind": "model", + "name": "SearchIndexerDataUserAssignedIdentity", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerDataUserAssignedIdentity", + "usage": "Input,Output,Json", + "doc": "Specifies the identity for a datasource to use.", + "discriminatorValue": "#Microsoft.Azure.Search.DataUserAssignedIdentity", + "decorators": [], + "baseModel": { + "$ref": "3877" + }, + "properties": [ + { + "$id": "3890", + "kind": "property", + "name": "resourceId", + "serializedName": "userAssignedIdentity", + "doc": "The fully qualified Azure resource Id of a user assigned managed identity\ntypically in the form\n\"/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId\"\nthat should have been assigned to the search service.", + "type": { + "$id": "3891", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataUserAssignedIdentity.userAssignedIdentity", + "serializationOptions": { + "$id": "3892", + "json": { + "$id": "3893", + "name": "userAssignedIdentity" + } + } + }, + { + "$id": "3894", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of identity.", + "type": { + "$id": "3895", + "kind": "constant", + "valueType": { + "$id": "3896", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.DataUserAssignedIdentity", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataUserAssignedIdentity.@odata.type", + "serializationOptions": { + "$id": "3897", + "json": { + "$id": "3898", + "name": "@odata.type" + } + } + } + ] + } + } + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchResourceEncryptionKey.identity", + "serializationOptions": { + "$id": "3899", + "json": { + "$id": "3900", + "name": "identity" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.encryptionKey", + "serializationOptions": { + "$id": "3901", + "json": { + "$id": "3902", + "name": "encryptionKey" + } + } + }, + { + "$id": "3903", + "kind": "property", + "name": "similarity", + "serializedName": "similarity", + "doc": "The type of similarity algorithm to be used when scoring and ranking the\ndocuments matching a search query. The similarity algorithm can only be defined\nat index creation time and cannot be modified on existing indexes. If null, the\nClassicSimilarity algorithm is used.", + "type": { + "$id": "3904", + "kind": "model", + "name": "SimilarityAlgorithm", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SimilarityAlgorithm", + "usage": "Input,Output,Json", + "doc": "Base type for similarity algorithms. Similarity algorithms are used to\ncalculate scores that tie queries to documents. The higher the score, the more\nrelevant the document is to that specific query. Those scores are used to rank\nthe search results.", + "decorators": [], + "discriminatorProperty": { + "$id": "3905", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "The discriminator for derived types.", + "type": { + "$id": "3906", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SimilarityAlgorithm.@odata.type", + "serializationOptions": { + "$id": "3907", + "json": { + "$id": "3908", + "name": "@odata.type" + } + } + }, + "properties": [ + { + "$ref": "3905" + } + ], + "discriminatedSubtypes": { + "$id": "3909", + "#Microsoft.Azure.Search.ClassicSimilarity": { + "$id": "3910", + "kind": "model", + "name": "ClassicSimilarityAlgorithm", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ClassicSimilarityAlgorithm", + "usage": "Input,Output,Json", + "doc": "Legacy similarity algorithm which uses the Lucene TFIDFSimilarity\nimplementation of TF-IDF. This variation of TF-IDF introduces static document\nlength normalization as well as coordinating factors that penalize documents\nthat only partially match the searched queries.", + "discriminatorValue": "#Microsoft.Azure.Search.ClassicSimilarity", + "decorators": [], + "baseModel": { + "$ref": "3904" + }, + "properties": [ + { + "$id": "3911", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "The discriminator for derived types.", + "type": { + "$id": "3912", + "kind": "constant", + "valueType": { + "$id": "3913", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.ClassicSimilarity", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ClassicSimilarityAlgorithm.@odata.type", + "serializationOptions": { + "$id": "3914", + "json": { + "$id": "3915", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.BM25Similarity": { + "$id": "3916", + "kind": "model", + "name": "BM25SimilarityAlgorithm", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.BM25SimilarityAlgorithm", + "usage": "Input,Output,Json", + "doc": "Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a\nTF-IDF-like algorithm that includes length normalization (controlled by the 'b'\nparameter) as well as term frequency saturation (controlled by the 'k1'\nparameter).", + "discriminatorValue": "#Microsoft.Azure.Search.BM25Similarity", + "decorators": [], + "baseModel": { + "$ref": "3904" + }, + "properties": [ + { + "$id": "3917", + "kind": "property", + "name": "k1", + "serializedName": "k1", + "doc": "This property controls the scaling function between the term frequency of each\nmatching terms and the final relevance score of a document-query pair. By\ndefault, a value of 1.2 is used. A value of 0.0 means the score does not scale\nwith an increase in term frequency.", + "type": { + "$id": "3918", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.BM25SimilarityAlgorithm.k1", + "serializationOptions": { + "$id": "3919", + "json": { + "$id": "3920", + "name": "k1" + } + } + }, + { + "$id": "3921", + "kind": "property", + "name": "b", + "serializedName": "b", + "doc": "This property controls how the length of a document affects the relevance\nscore. By default, a value of 0.75 is used. A value of 0.0 means no length\nnormalization is applied, while a value of 1.0 means the score is fully\nnormalized by the length of the document.", + "type": { + "$id": "3922", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.BM25SimilarityAlgorithm.b", + "serializationOptions": { + "$id": "3923", + "json": { + "$id": "3924", + "name": "b" + } + } + }, + { + "$id": "3925", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "The discriminator for derived types.", + "type": { + "$id": "3926", + "kind": "constant", + "valueType": { + "$id": "3927", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.BM25Similarity", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.BM25SimilarityAlgorithm.@odata.type", + "serializationOptions": { + "$id": "3928", + "json": { + "$id": "3929", + "name": "@odata.type" + } + } + } + ] + } + } + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.similarity", + "serializationOptions": { + "$id": "3930", + "json": { + "$id": "3931", + "name": "similarity" + } + } + }, + { + "$id": "3932", + "kind": "property", + "name": "semanticSearch", + "serializedName": "semantic", + "doc": "Defines parameters for a search index that influence semantic capabilities.", + "type": { + "$id": "3933", + "kind": "model", + "name": "SemanticSearch", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SemanticSearch", + "usage": "Input,Output,Json", + "doc": "Defines parameters for a search index that influence semantic capabilities.", + "decorators": [], + "properties": [ + { + "$id": "3934", + "kind": "property", + "name": "defaultConfigurationName", + "serializedName": "defaultConfiguration", + "doc": "Allows you to set the name of a default semantic configuration in your index,\nmaking it optional to pass it on as a query parameter every time.", + "type": { + "$id": "3935", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SemanticSearch.defaultConfiguration", + "serializationOptions": { + "$id": "3936", + "json": { + "$id": "3937", + "name": "defaultConfiguration" + } + } + }, + { + "$id": "3938", + "kind": "property", + "name": "configurations", + "serializedName": "configurations", + "doc": "The semantic configurations for the index.", + "type": { + "$id": "3939", + "kind": "array", + "name": "ArraySemanticConfiguration", + "valueType": { + "$id": "3940", + "kind": "model", + "name": "SemanticConfiguration", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SemanticConfiguration", + "usage": "Input,Output,Json", + "doc": "Defines a specific configuration to be used in the context of semantic\ncapabilities.", + "decorators": [], + "properties": [ + { + "$id": "3941", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the semantic configuration.", + "type": { + "$id": "3942", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SemanticConfiguration.name", + "serializationOptions": { + "$id": "3943", + "json": { + "$id": "3944", + "name": "name" + } + } + }, + { + "$id": "3945", + "kind": "property", + "name": "prioritizedFields", + "serializedName": "prioritizedFields", + "doc": "Describes the title, content, and keyword fields to be used for semantic\nranking, captions, highlights, and answers. At least one of the three sub\nproperties (titleField, prioritizedKeywordsFields and prioritizedContentFields)\nneed to be set.", + "type": { + "$id": "3946", + "kind": "model", + "name": "SemanticPrioritizedFields", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SemanticPrioritizedFields", + "usage": "Input,Output,Json", + "doc": "Describes the title, content, and keywords fields to be used for semantic\nranking, captions, highlights, and answers.", + "decorators": [], + "properties": [ + { + "$id": "3947", + "kind": "property", + "name": "titleField", + "serializedName": "titleField", + "doc": "Defines the title field to be used for semantic ranking, captions, highlights,\nand answers. If you don't have a title field in your index, leave this blank.", + "type": { + "$id": "3948", + "kind": "model", + "name": "SemanticField", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SemanticField", + "usage": "Input,Output,Json", + "doc": "A field that is used as part of the semantic configuration.", + "decorators": [], + "properties": [ + { + "$id": "3949", + "kind": "property", + "name": "fieldName", + "serializedName": "fieldName", + "doc": "File name", + "type": { + "$id": "3950", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SemanticField.fieldName", + "serializationOptions": { + "$id": "3951", + "json": { + "$id": "3952", + "name": "fieldName" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SemanticPrioritizedFields.titleField", + "serializationOptions": { + "$id": "3953", + "json": { + "$id": "3954", + "name": "titleField" + } + } + }, + { + "$id": "3955", + "kind": "property", + "name": "contentFields", + "serializedName": "prioritizedContentFields", + "doc": "Defines the content fields to be used for semantic ranking, captions,\nhighlights, and answers. For the best result, the selected fields should\ncontain text in natural language form. The order of the fields in the array\nrepresents their priority. Fields with lower priority may get truncated if the\ncontent is long.", + "type": { + "$id": "3956", + "kind": "array", + "name": "ArraySemanticField", + "valueType": { + "$ref": "3948" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SemanticPrioritizedFields.prioritizedContentFields", + "serializationOptions": { + "$id": "3957", + "json": { + "$id": "3958", + "name": "prioritizedContentFields" + } + } + }, + { + "$id": "3959", + "kind": "property", + "name": "keywordsFields", + "serializedName": "prioritizedKeywordsFields", + "doc": "Defines the keyword fields to be used for semantic ranking, captions,\nhighlights, and answers. For the best result, the selected fields should\ncontain a list of keywords. The order of the fields in the array represents\ntheir priority. Fields with lower priority may get truncated if the content is\nlong.", + "type": { + "$id": "3960", + "kind": "array", + "name": "ArraySemanticField", + "valueType": { + "$ref": "3948" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SemanticPrioritizedFields.prioritizedKeywordsFields", + "serializationOptions": { + "$id": "3961", + "json": { + "$id": "3962", + "name": "prioritizedKeywordsFields" + } + } + } + ] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SemanticConfiguration.prioritizedFields", + "serializationOptions": { + "$id": "3963", + "json": { + "$id": "3964", + "name": "prioritizedFields" + } + } + }, + { + "$id": "3965", + "kind": "property", + "name": "flightingOptIn", + "serializedName": "flightingOptIn", + "doc": "Determines how which semantic or query rewrite models to use during model flighting/upgrades.", + "type": { + "$id": "3966", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SemanticConfiguration.flightingOptIn", + "serializationOptions": { + "$id": "3967", + "json": { + "$id": "3968", + "name": "flightingOptIn" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SemanticSearch.configurations", + "serializationOptions": { + "$id": "3969", + "json": { + "$id": "3970", + "name": "configurations" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.semantic", + "serializationOptions": { + "$id": "3971", + "json": { + "$id": "3972", + "name": "semantic" + } + } + }, + { + "$id": "3973", + "kind": "property", + "name": "vectorSearch", + "serializedName": "vectorSearch", + "doc": "Contains configuration options related to vector search.", + "type": { + "$id": "3974", + "kind": "model", + "name": "VectorSearch", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.VectorSearch", + "usage": "Input,Output,Json", + "doc": "Contains configuration options related to vector search.", + "decorators": [], + "properties": [ + { + "$id": "3975", + "kind": "property", + "name": "profiles", + "serializedName": "profiles", + "doc": "Defines combinations of configurations to use with vector search.", + "type": { + "$id": "3976", + "kind": "array", + "name": "ArrayVectorSearchProfile", + "valueType": { + "$id": "3977", + "kind": "model", + "name": "VectorSearchProfile", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.VectorSearchProfile", + "usage": "Input,Output,Json", + "doc": "Defines a combination of configurations to use with vector search.", + "decorators": [], + "properties": [ + { + "$id": "3978", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name to associate with this particular vector search profile.", + "type": { + "$id": "3979", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearchProfile.name", + "serializationOptions": { + "$id": "3980", + "json": { + "$id": "3981", + "name": "name" + } + } + }, + { + "$id": "3982", + "kind": "property", + "name": "algorithmConfigurationName", + "serializedName": "algorithm", + "doc": "The name of the vector search algorithm configuration that specifies the\nalgorithm and optional parameters.", + "type": { + "$id": "3983", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearchProfile.algorithm", + "serializationOptions": { + "$id": "3984", + "json": { + "$id": "3985", + "name": "algorithm" + } + } + }, + { + "$id": "3986", + "kind": "property", + "name": "vectorizerName", + "serializedName": "vectorizer", + "doc": "The name of the vectorization being configured for use with vector search.", + "type": { + "$id": "3987", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearchProfile.vectorizer", + "serializationOptions": { + "$id": "3988", + "json": { + "$id": "3989", + "name": "vectorizer" + } + } + }, + { + "$id": "3990", + "kind": "property", + "name": "compressionName", + "serializedName": "compression", + "doc": "The name of the compression method configuration that specifies the compression\nmethod and optional parameters.", + "type": { + "$id": "3991", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearchProfile.compression", + "serializationOptions": { + "$id": "3992", + "json": { + "$id": "3993", + "name": "compression" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearch.profiles", + "serializationOptions": { + "$id": "3994", + "json": { + "$id": "3995", + "name": "profiles" + } + } + }, + { + "$id": "3996", + "kind": "property", + "name": "algorithms", + "serializedName": "algorithms", + "doc": "Contains configuration options specific to the algorithm used during indexing\nor querying.", + "type": { + "$id": "3997", + "kind": "array", + "name": "ArrayVectorSearchAlgorithmConfiguration", + "valueType": { + "$id": "3998", + "kind": "model", + "name": "VectorSearchAlgorithmConfiguration", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.VectorSearchAlgorithmConfiguration", + "usage": "Input,Output,Json", + "doc": "Contains configuration options specific to the algorithm used during indexing\nor querying.", + "decorators": [], + "discriminatorProperty": { + "$id": "3999", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "Type of VectorSearchAlgorithmConfiguration.", + "type": { + "$ref": "1109" + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearchAlgorithmConfiguration.kind", + "serializationOptions": { + "$id": "4000", + "json": { + "$id": "4001", + "name": "kind" + } + } + }, + "properties": [ + { + "$id": "4002", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name to associate with this particular configuration.", + "type": { + "$id": "4003", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearchAlgorithmConfiguration.name", + "serializationOptions": { + "$id": "4004", + "json": { + "$id": "4005", + "name": "name" + } + } + }, + { + "$ref": "3999" + } + ], + "discriminatedSubtypes": { + "$id": "4006", + "hnsw": { + "$id": "4007", + "kind": "model", + "name": "HnswAlgorithmConfiguration", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.HnswAlgorithmConfiguration", + "usage": "Input,Output,Json", + "doc": "Contains configuration options specific to the HNSW approximate nearest\nneighbors algorithm used during indexing and querying. The HNSW algorithm\noffers a tunable trade-off between search speed and accuracy.", + "discriminatorValue": "hnsw", + "decorators": [], + "baseModel": { + "$ref": "3998" + }, + "properties": [ + { + "$id": "4008", + "kind": "property", + "name": "parameters", + "serializedName": "hnswParameters", + "doc": "Contains the parameters specific to HNSW algorithm.", + "type": { + "$id": "4009", + "kind": "model", + "name": "HnswParameters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.HnswParameters", + "usage": "Input,Output,Json", + "doc": "Contains the parameters specific to the HNSW algorithm.", + "decorators": [], + "properties": [ + { + "$id": "4010", + "kind": "property", + "name": "m", + "serializedName": "m", + "doc": "The number of bi-directional links created for every new element during\nconstruction. Increasing this parameter value may improve recall and reduce\nretrieval times for datasets with high intrinsic dimensionality at the expense\nof increased memory consumption and longer indexing time.", + "type": { + "$id": "4011", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.HnswParameters.m", + "serializationOptions": { + "$id": "4012", + "json": { + "$id": "4013", + "name": "m" + } + } + }, + { + "$id": "4014", + "kind": "property", + "name": "efConstruction", + "serializedName": "efConstruction", + "doc": "The size of the dynamic list containing the nearest neighbors, which is used\nduring index time. Increasing this parameter may improve index quality, at the\nexpense of increased indexing time. At a certain point, increasing this\nparameter leads to diminishing returns.", + "type": { + "$id": "4015", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.HnswParameters.efConstruction", + "serializationOptions": { + "$id": "4016", + "json": { + "$id": "4017", + "name": "efConstruction" + } + } + }, + { + "$id": "4018", + "kind": "property", + "name": "efSearch", + "serializedName": "efSearch", + "doc": "The size of the dynamic list containing the nearest neighbors, which is used\nduring search time. Increasing this parameter may improve search results, at\nthe expense of slower search. At a certain point, increasing this parameter\nleads to diminishing returns.", + "type": { + "$id": "4019", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.HnswParameters.efSearch", + "serializationOptions": { + "$id": "4020", + "json": { + "$id": "4021", + "name": "efSearch" + } + } + }, + { + "$id": "4022", + "kind": "property", + "name": "metric", + "serializedName": "metric", + "doc": "The similarity metric to use for vector comparisons.", + "type": { + "$ref": "1115" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.HnswParameters.metric", + "serializationOptions": { + "$id": "4023", + "json": { + "$id": "4024", + "name": "metric" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.HnswAlgorithmConfiguration.hnswParameters", + "serializationOptions": { + "$id": "4025", + "json": { + "$id": "4026", + "name": "hnswParameters" + } + } + }, + { + "$id": "4027", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "The name of the kind of algorithm being configured for use with vector search.", + "type": { + "$id": "4028", + "kind": "constant", + "valueType": { + "$id": "4029", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "hnsw", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.HnswAlgorithmConfiguration.kind", + "serializationOptions": { + "$id": "4030", + "json": { + "$id": "4031", + "name": "kind" + } + } + } + ] + }, + "exhaustiveKnn": { + "$id": "4032", + "kind": "model", + "name": "ExhaustiveKnnAlgorithmConfiguration", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ExhaustiveKnnAlgorithmConfiguration", + "usage": "Input,Output,Json", + "doc": "Contains configuration options specific to the exhaustive KNN algorithm used\nduring querying, which will perform brute-force search across the entire vector\nindex.", + "discriminatorValue": "exhaustiveKnn", + "decorators": [], + "baseModel": { + "$ref": "3998" + }, + "properties": [ + { + "$id": "4033", + "kind": "property", + "name": "parameters", + "serializedName": "exhaustiveKnnParameters", + "doc": "Contains the parameters specific to exhaustive KNN algorithm.", + "type": { + "$id": "4034", + "kind": "model", + "name": "ExhaustiveKnnParameters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ExhaustiveKnnParameters", + "usage": "Input,Output,Json", + "doc": "Contains the parameters specific to exhaustive KNN algorithm.", + "decorators": [], + "properties": [ + { + "$id": "4035", + "kind": "property", + "name": "metric", + "serializedName": "metric", + "doc": "The similarity metric to use for vector comparisons.", + "type": { + "$ref": "1115" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ExhaustiveKnnParameters.metric", + "serializationOptions": { + "$id": "4036", + "json": { + "$id": "4037", + "name": "metric" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ExhaustiveKnnAlgorithmConfiguration.exhaustiveKnnParameters", + "serializationOptions": { + "$id": "4038", + "json": { + "$id": "4039", + "name": "exhaustiveKnnParameters" + } + } + }, + { + "$id": "4040", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "The name of the kind of algorithm being configured for use with vector search.", + "type": { + "$id": "4041", + "kind": "constant", + "valueType": { + "$id": "4042", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "exhaustiveKnn", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ExhaustiveKnnAlgorithmConfiguration.kind", + "serializationOptions": { + "$id": "4043", + "json": { + "$id": "4044", + "name": "kind" + } + } + } + ] + } + } + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearch.algorithms", + "serializationOptions": { + "$id": "4045", + "json": { + "$id": "4046", + "name": "algorithms" + } + } + }, + { + "$id": "4047", + "kind": "property", + "name": "vectorizers", + "serializedName": "vectorizers", + "doc": "Contains configuration options on how to vectorize text vector queries.", + "type": { + "$id": "4048", + "kind": "array", + "name": "ArrayVectorSearchVectorizer", + "valueType": { + "$id": "4049", + "kind": "model", + "name": "VectorSearchVectorizer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.VectorSearchVectorizer", + "usage": "Input,Output,Json", + "doc": "Specifies the vectorization method to be used during query time.", + "decorators": [], + "discriminatorProperty": { + "$id": "4050", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "Type of VectorSearchVectorizer.", + "type": { + "$ref": "1125" + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearchVectorizer.kind", + "serializationOptions": { + "$id": "4051", + "json": { + "$id": "4052", + "name": "kind" + } + } + }, + "properties": [ + { + "$id": "4053", + "kind": "property", + "name": "vectorizerName", + "serializedName": "name", + "doc": "The name to associate with this particular vectorization method.", + "type": { + "$id": "4054", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearchVectorizer.name", + "serializationOptions": { + "$id": "4055", + "json": { + "$id": "4056", + "name": "name" + } + } + }, + { + "$ref": "4050" + } + ], + "discriminatedSubtypes": { + "$id": "4057", + "azureOpenAI": { + "$id": "4058", + "kind": "model", + "name": "AzureOpenAIVectorizer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AzureOpenAIVectorizer", + "usage": "Input,Output,Json", + "doc": "Specifies the Azure OpenAI resource used to vectorize a query string.", + "discriminatorValue": "azureOpenAI", + "decorators": [], + "baseModel": { + "$ref": "4049" + }, + "properties": [ + { + "$id": "4059", + "kind": "property", + "name": "parameters", + "serializedName": "azureOpenAIParameters", + "doc": "Contains the parameters specific to Azure OpenAI embedding vectorization.", + "type": { + "$id": "4060", + "kind": "model", + "name": "AzureOpenAIVectorizerParameters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AzureOpenAIVectorizerParameters", + "usage": "Input,Output,Json", + "doc": "Specifies the parameters for connecting to the Azure OpenAI resource.", + "decorators": [], + "properties": [ + { + "$id": "4061", + "kind": "property", + "name": "resourceUrl", + "serializedName": "resourceUri", + "doc": "The resource URI of the Azure OpenAI resource.", + "type": { + "$id": "4062", + "kind": "url", + "name": "url", + "crossLanguageDefinitionId": "TypeSpec.url", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAIVectorizerParameters.resourceUri", + "serializationOptions": { + "$id": "4063", + "json": { + "$id": "4064", + "name": "resourceUri" + } + } + }, + { + "$id": "4065", + "kind": "property", + "name": "deploymentName", + "serializedName": "deploymentId", + "doc": "ID of the Azure OpenAI model deployment on the designated resource.", + "type": { + "$id": "4066", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAIVectorizerParameters.deploymentId", + "serializationOptions": { + "$id": "4067", + "json": { + "$id": "4068", + "name": "deploymentId" + } + } + }, + { + "$id": "4069", + "kind": "property", + "name": "apiKey", + "serializedName": "apiKey", + "doc": "API key of the designated Azure OpenAI resource.", + "type": { + "$id": "4070", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAIVectorizerParameters.apiKey", + "serializationOptions": { + "$id": "4071", + "json": { + "$id": "4072", + "name": "apiKey" + } + } + }, + { + "$id": "4073", + "kind": "property", + "name": "authIdentity", + "serializedName": "authIdentity", + "doc": "The user-assigned managed identity used for outbound connections.", + "type": { + "$ref": "3877" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAIVectorizerParameters.authIdentity", + "serializationOptions": { + "$id": "4074", + "json": { + "$id": "4075", + "name": "authIdentity" + } + } + }, + { + "$id": "4076", + "kind": "property", + "name": "modelName", + "serializedName": "modelName", + "doc": "The name of the embedding model that is deployed at the provided deploymentId\npath.", + "type": { + "$ref": "1135" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAIVectorizerParameters.modelName", + "serializationOptions": { + "$id": "4077", + "json": { + "$id": "4078", + "name": "modelName" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAIVectorizer.azureOpenAIParameters", + "serializationOptions": { + "$id": "4079", + "json": { + "$id": "4080", + "name": "azureOpenAIParameters" + } + } + }, + { + "$id": "4081", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "The name of the kind of vectorization method being configured for use with\nvector search.", + "type": { + "$id": "4082", + "kind": "constant", + "valueType": { + "$id": "4083", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "azureOpenAI", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAIVectorizer.kind", + "serializationOptions": { + "$id": "4084", + "json": { + "$id": "4085", + "name": "kind" + } + } + } + ] + }, + "customWebApi": { + "$id": "4086", + "kind": "model", + "name": "WebApiVectorizer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.WebApiVectorizer", + "usage": "Input,Output,Json", + "doc": "Specifies a user-defined vectorizer for generating the vector embedding of a\nquery string. Integration of an external vectorizer is achieved using the\ncustom Web API interface of a skillset.", + "discriminatorValue": "customWebApi", + "decorators": [], + "baseModel": { + "$ref": "4049" + }, + "properties": [ + { + "$id": "4087", + "kind": "property", + "name": "webApiParameters", + "serializedName": "customWebApiParameters", + "doc": "Specifies the properties of the user-defined vectorizer.", + "type": { + "$id": "4088", + "kind": "model", + "name": "WebApiVectorizerParameters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.WebApiVectorizerParameters", + "usage": "Input,Output,Json", + "doc": "Specifies the properties for connecting to a user-defined vectorizer.", + "decorators": [], + "properties": [ + { + "$id": "4089", + "kind": "property", + "name": "url", + "serializedName": "uri", + "doc": "The URI of the Web API providing the vectorizer.", + "type": { + "$id": "4090", + "kind": "url", + "name": "url", + "crossLanguageDefinitionId": "TypeSpec.url", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiVectorizerParameters.uri", + "serializationOptions": { + "$id": "4091", + "json": { + "$id": "4092", + "name": "uri" + } + } + }, + { + "$id": "4093", + "kind": "property", + "name": "httpHeaders", + "serializedName": "httpHeaders", + "doc": "The headers required to make the HTTP request.", + "type": { + "$id": "4094", + "kind": "dict", + "keyType": { + "$id": "4095", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "valueType": { + "$id": "4096", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiVectorizerParameters.httpHeaders", + "serializationOptions": { + "$id": "4097", + "json": { + "$id": "4098", + "name": "httpHeaders" + } + } + }, + { + "$id": "4099", + "kind": "property", + "name": "httpMethod", + "serializedName": "httpMethod", + "doc": "The method for the HTTP request.", + "type": { + "$id": "4100", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiVectorizerParameters.httpMethod", + "serializationOptions": { + "$id": "4101", + "json": { + "$id": "4102", + "name": "httpMethod" + } + } + }, + { + "$id": "4103", + "kind": "property", + "name": "timeout", + "serializedName": "timeout", + "doc": "The desired timeout for the request. Default is 30 seconds.", + "type": { + "$id": "4104", + "kind": "duration", + "name": "duration", + "encode": "ISO8601", + "wireType": { + "$id": "4105", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.duration", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiVectorizerParameters.timeout", + "serializationOptions": { + "$id": "4106", + "json": { + "$id": "4107", + "name": "timeout" + } + } + }, + { + "$id": "4108", + "kind": "property", + "name": "authResourceId", + "serializedName": "authResourceId", + "doc": "Applies to custom endpoints that connect to external code in an Azure function\nor some other application that provides the transformations. This value should\nbe the application ID created for the function or app when it was registered\nwith Azure Active Directory. When specified, the vectorization connects to the\nfunction or app using a managed ID (either system or user-assigned) of the\nsearch service and the access token of the function or app, using this value as\nthe resource id for creating the scope of the access token.", + "type": { + "$id": "4109", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiVectorizerParameters.authResourceId", + "serializationOptions": { + "$id": "4110", + "json": { + "$id": "4111", + "name": "authResourceId" + } + } + }, + { + "$id": "4112", + "kind": "property", + "name": "authIdentity", + "serializedName": "authIdentity", + "doc": "The user-assigned managed identity used for outbound connections. If an\nauthResourceId is provided and it's not specified, the system-assigned managed\nidentity is used. On updates to the indexer, if the identity is unspecified,\nthe value remains unchanged. If set to \"none\", the value of this property is\ncleared.", + "type": { + "$ref": "3877" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiVectorizerParameters.authIdentity", + "serializationOptions": { + "$id": "4113", + "json": { + "$id": "4114", + "name": "authIdentity" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiVectorizer.customWebApiParameters", + "serializationOptions": { + "$id": "4115", + "json": { + "$id": "4116", + "name": "customWebApiParameters" + } + } + }, + { + "$id": "4117", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "The name of the kind of vectorization method being configured for use with\nvector search.", + "type": { + "$id": "4118", + "kind": "constant", + "valueType": { + "$id": "4119", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "customWebApi", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiVectorizer.kind", + "serializationOptions": { + "$id": "4120", + "json": { + "$id": "4121", + "name": "kind" + } + } + } + ] + }, + "aiServicesVision": { + "$id": "4122", + "kind": "model", + "name": "AIServicesVisionVectorizer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AIServicesVisionVectorizer", + "usage": "Input,Output,Json", + "doc": "Clears the identity property of a datasource.", + "discriminatorValue": "aiServicesVision", + "decorators": [], + "baseModel": { + "$ref": "4049" + }, + "properties": [ + { + "$id": "4123", + "kind": "property", + "name": "AIServicesVisionParameters", + "serializedName": "AIServicesVisionParameters", + "doc": "Contains the parameters specific to AI Services Vision embedding vectorization.", + "type": { + "$id": "4124", + "kind": "model", + "name": "AIServicesVisionParameters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AIServicesVisionParameters", + "usage": "Input,Output,Json", + "doc": "Specifies the AI Services Vision parameters for vectorizing a query image or\ntext.", + "decorators": [], + "properties": [ + { + "$id": "4125", + "kind": "property", + "name": "modelVersion", + "serializedName": "modelVersion", + "doc": "The version of the model to use when calling the AI Services Vision service. It\nwill default to the latest available when not specified.", + "type": { + "$id": "4126", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AIServicesVisionParameters.modelVersion", + "serializationOptions": { + "$id": "4127", + "json": { + "$id": "4128", + "name": "modelVersion" + } + } + }, + { + "$id": "4129", + "kind": "property", + "name": "resourceUri", + "serializedName": "resourceUri", + "doc": "The resource URI of the AI Services resource.", + "type": { + "$id": "4130", + "kind": "url", + "name": "url", + "crossLanguageDefinitionId": "TypeSpec.url", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AIServicesVisionParameters.resourceUri", + "serializationOptions": { + "$id": "4131", + "json": { + "$id": "4132", + "name": "resourceUri" + } + } + }, + { + "$id": "4133", + "kind": "property", + "name": "apiKey", + "serializedName": "apiKey", + "doc": "API key of the designated AI Services resource.", + "type": { + "$id": "4134", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AIServicesVisionParameters.apiKey", + "serializationOptions": { + "$id": "4135", + "json": { + "$id": "4136", + "name": "apiKey" + } + } + }, + { + "$id": "4137", + "kind": "property", + "name": "authIdentity", + "serializedName": "authIdentity", + "doc": "The user-assigned managed identity used for outbound connections. If an\nauthResourceId is provided and it's not specified, the system-assigned managed\nidentity is used. On updates to the index, if the identity is unspecified, the\nvalue remains unchanged. If set to \"none\", the value of this property is\ncleared.", + "type": { + "$ref": "3877" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AIServicesVisionParameters.authIdentity", + "serializationOptions": { + "$id": "4138", + "json": { + "$id": "4139", + "name": "authIdentity" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AIServicesVisionVectorizer.AIServicesVisionParameters", + "serializationOptions": { + "$id": "4140", + "json": { + "$id": "4141", + "name": "AIServicesVisionParameters" + } + } + }, + { + "$id": "4142", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "The name of the kind of vectorization method being configured for use with\nvector search.", + "type": { + "$id": "4143", + "kind": "constant", + "valueType": { + "$id": "4144", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "aiServicesVision", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AIServicesVisionVectorizer.kind", + "serializationOptions": { + "$id": "4145", + "json": { + "$id": "4146", + "name": "kind" + } + } + } + ] + }, + "aml": { + "$id": "4147", + "kind": "model", + "name": "AzureMachineLearningVectorizer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AMLVectorizer", + "usage": "Input,Output,Json", + "doc": "Specifies an Azure Machine Learning endpoint deployed via the Azure AI Foundry\nModel Catalog for generating the vector embedding of a query string.", + "discriminatorValue": "aml", + "decorators": [], + "baseModel": { + "$ref": "4049" + }, + "properties": [ + { + "$id": "4148", + "kind": "property", + "name": "AMLParameters", + "serializedName": "amlParameters", + "doc": "Specifies the properties of the AML vectorizer.", + "type": { + "$id": "4149", + "kind": "model", + "name": "AzureMachineLearningParameters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AMLParameters", + "usage": "Input,Output,Json", + "doc": "Specifies the properties for connecting to an AML vectorizer.", + "decorators": [], + "properties": [ + { + "$id": "4150", + "kind": "property", + "name": "scoringUri", + "serializedName": "uri", + "doc": "(Required for no authentication or key authentication) The scoring URI of the\nAML service to which the JSON payload will be sent. Only the https URI scheme\nis allowed.", + "type": { + "$id": "4151", + "kind": "url", + "name": "url", + "crossLanguageDefinitionId": "TypeSpec.url", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AMLParameters.uri", + "serializationOptions": { + "$id": "4152", + "json": { + "$id": "4153", + "name": "uri" + } + } + }, + { + "$id": "4154", + "kind": "property", + "name": "authenticationKey", + "serializedName": "key", + "doc": "(Required for key authentication) The key for the AML service.", + "type": { + "$id": "4155", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AMLParameters.key", + "serializationOptions": { + "$id": "4156", + "json": { + "$id": "4157", + "name": "key" + } + } + }, + { + "$id": "4158", + "kind": "property", + "name": "resourceId", + "serializedName": "resourceId", + "doc": "(Required for token authentication). The Azure Resource Manager resource ID of\nthe AML service. It should be in the format\nsubscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}.", + "type": { + "$id": "4159", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AMLParameters.resourceId", + "serializationOptions": { + "$id": "4160", + "json": { + "$id": "4161", + "name": "resourceId" + } + } + }, + { + "$id": "4162", + "kind": "property", + "name": "timeout", + "serializedName": "timeout", + "doc": "(Optional) When specified, indicates the timeout for the http client making the\nAPI call.", + "type": { + "$id": "4163", + "kind": "duration", + "name": "duration", + "encode": "ISO8601", + "wireType": { + "$id": "4164", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.duration", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AMLParameters.timeout", + "serializationOptions": { + "$id": "4165", + "json": { + "$id": "4166", + "name": "timeout" + } + } + }, + { + "$id": "4167", + "kind": "property", + "name": "region", + "serializedName": "region", + "doc": "(Optional for token authentication). The region the AML service is deployed in.", + "type": { + "$id": "4168", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AMLParameters.region", + "serializationOptions": { + "$id": "4169", + "json": { + "$id": "4170", + "name": "region" + } + } + }, + { + "$id": "4171", + "kind": "property", + "name": "modelName", + "serializedName": "modelName", + "doc": "The name of the embedding model from the Azure AI Foundry Catalog that is\ndeployed at the provided endpoint.", + "type": { + "$ref": "1143" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AMLParameters.modelName", + "serializationOptions": { + "$id": "4172", + "json": { + "$id": "4173", + "name": "modelName" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AMLVectorizer.amlParameters", + "serializationOptions": { + "$id": "4174", + "json": { + "$id": "4175", + "name": "amlParameters" + } + } + }, + { + "$id": "4176", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "The name of the kind of vectorization method being configured for use with\nvector search.", + "type": { + "$id": "4177", + "kind": "constant", + "valueType": { + "$id": "4178", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "aml", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AMLVectorizer.kind", + "serializationOptions": { + "$id": "4179", + "json": { + "$id": "4180", + "name": "kind" + } + } + } + ] + } + } + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearch.vectorizers", + "serializationOptions": { + "$id": "4181", + "json": { + "$id": "4182", + "name": "vectorizers" + } + } + }, + { + "$id": "4183", + "kind": "property", + "name": "compressions", + "serializedName": "compressions", + "doc": "Contains configuration options specific to the compression method used during\nindexing or querying.", + "type": { + "$id": "4184", + "kind": "array", + "name": "ArrayVectorSearchCompression", + "valueType": { + "$id": "4185", + "kind": "model", + "name": "VectorSearchCompression", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.VectorSearchCompression", + "usage": "Input,Output,Json", + "doc": "Contains configuration options specific to the compression method used during\nindexing or querying.", + "decorators": [], + "discriminatorProperty": { + "$id": "4186", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "Type of VectorSearchCompression.", + "type": { + "$ref": "1163" + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearchCompression.kind", + "serializationOptions": { + "$id": "4187", + "json": { + "$id": "4188", + "name": "kind" + } + } + }, + "properties": [ + { + "$id": "4189", + "kind": "property", + "name": "compressionName", + "serializedName": "name", + "doc": "The name to associate with this particular configuration.", + "type": { + "$id": "4190", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearchCompression.name", + "serializationOptions": { + "$id": "4191", + "json": { + "$id": "4192", + "name": "name" + } + } + }, + { + "$id": "4193", + "kind": "property", + "name": "rerankWithOriginalVectors", + "serializedName": "rerankWithOriginalVectors", + "doc": "If set to true, once the ordered set of results calculated using compressed\nvectors are obtained, they will be reranked again by recalculating the\nfull-precision similarity scores. This will improve recall at the expense of\nlatency.", + "type": { + "$id": "4194", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearchCompression.rerankWithOriginalVectors", + "serializationOptions": { + "$id": "4195", + "json": { + "$id": "4196", + "name": "rerankWithOriginalVectors" + } + } + }, + { + "$id": "4197", + "kind": "property", + "name": "defaultOversampling", + "serializedName": "defaultOversampling", + "doc": "Default oversampling factor. Oversampling will internally request more\ndocuments (specified by this multiplier) in the initial search. This increases\nthe set of results that will be reranked using recomputed similarity scores\nfrom full-precision vectors. Minimum value is 1, meaning no oversampling (1x).\nThis parameter can only be set when rerankWithOriginalVectors is true. Higher\nvalues improve recall at the expense of latency.", + "type": { + "$id": "4198", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearchCompression.defaultOversampling", + "serializationOptions": { + "$id": "4199", + "json": { + "$id": "4200", + "name": "defaultOversampling" + } + } + }, + { + "$id": "4201", + "kind": "property", + "name": "rescoringOptions", + "serializedName": "rescoringOptions", + "doc": "Contains the options for rescoring.", + "type": { + "$id": "4202", + "kind": "model", + "name": "RescoringOptions", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.RescoringOptions", + "usage": "Input,Output,Json", + "doc": "Contains the options for rescoring.", + "decorators": [], + "properties": [ + { + "$id": "4203", + "kind": "property", + "name": "enableRescoring", + "serializedName": "enableRescoring", + "doc": "If set to true, after the initial search on the compressed vectors, the\nsimilarity scores are recalculated using the full-precision vectors. This will\nimprove recall at the expense of latency.", + "type": { + "$id": "4204", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.RescoringOptions.enableRescoring", + "serializationOptions": { + "$id": "4205", + "json": { + "$id": "4206", + "name": "enableRescoring" + } + } + }, + { + "$id": "4207", + "kind": "property", + "name": "defaultOversampling", + "serializedName": "defaultOversampling", + "doc": "Default oversampling factor. Oversampling retrieves a greater set of potential\ndocuments to offset the resolution loss due to quantization. This increases the\nset of results that will be rescored on full-precision vectors. Minimum value\nis 1, meaning no oversampling (1x). This parameter can only be set when 'enableRescoring'\nis true. Higher values improve recall at the expense of latency.", + "type": { + "$id": "4208", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.RescoringOptions.defaultOversampling", + "serializationOptions": { + "$id": "4209", + "json": { + "$id": "4210", + "name": "defaultOversampling" + } + } + }, + { + "$id": "4211", + "kind": "property", + "name": "rescoreStorageMethod", + "serializedName": "rescoreStorageMethod", + "doc": "Controls the storage method for original vectors. This setting is immutable.", + "type": { + "$ref": "1157" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.RescoringOptions.rescoreStorageMethod", + "serializationOptions": { + "$id": "4212", + "json": { + "$id": "4213", + "name": "rescoreStorageMethod" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearchCompression.rescoringOptions", + "serializationOptions": { + "$id": "4214", + "json": { + "$id": "4215", + "name": "rescoringOptions" + } + } + }, + { + "$id": "4216", + "kind": "property", + "name": "truncationDimension", + "serializedName": "truncationDimension", + "doc": "The number of dimensions to truncate the vectors to. Truncating the vectors\nreduces the size of the vectors and the amount of data that needs to be\ntransferred during search. This can save storage cost and improve search\nperformance at the expense of recall. It should be only used for embeddings\ntrained with Matryoshka Representation Learning (MRL) such as OpenAI\ntext-embedding-3-large (small). The default value is null, which means no\ntruncation.", + "type": { + "$id": "4217", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearchCompression.truncationDimension", + "serializationOptions": { + "$id": "4218", + "json": { + "$id": "4219", + "name": "truncationDimension" + } + } + }, + { + "$ref": "4186" + } + ], + "discriminatedSubtypes": { + "$id": "4220", + "scalarQuantization": { + "$id": "4221", + "kind": "model", + "name": "ScalarQuantizationCompression", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ScalarQuantizationCompression", + "usage": "Input,Output,Json", + "doc": "Contains configuration options specific to the scalar quantization compression\nmethod used during indexing and querying.", + "discriminatorValue": "scalarQuantization", + "decorators": [], + "baseModel": { + "$ref": "4185" + }, + "properties": [ + { + "$id": "4222", + "kind": "property", + "name": "parameters", + "serializedName": "scalarQuantizationParameters", + "doc": "Contains the parameters specific to Scalar Quantization.", + "type": { + "$id": "4223", + "kind": "model", + "name": "ScalarQuantizationParameters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ScalarQuantizationParameters", + "usage": "Input,Output,Json", + "doc": "Contains the parameters specific to Scalar Quantization.", + "decorators": [], + "properties": [ + { + "$id": "4224", + "kind": "property", + "name": "quantizedDataType", + "serializedName": "quantizedDataType", + "doc": "The quantized data type of compressed vector values.", + "type": { + "$ref": "1169" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ScalarQuantizationParameters.quantizedDataType", + "serializationOptions": { + "$id": "4225", + "json": { + "$id": "4226", + "name": "quantizedDataType" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ScalarQuantizationCompression.scalarQuantizationParameters", + "serializationOptions": { + "$id": "4227", + "json": { + "$id": "4228", + "name": "scalarQuantizationParameters" + } + } + }, + { + "$id": "4229", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "The name of the kind of compression method being configured for use with vector\nsearch.", + "type": { + "$id": "4230", + "kind": "constant", + "valueType": { + "$id": "4231", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "scalarQuantization", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ScalarQuantizationCompression.kind", + "serializationOptions": { + "$id": "4232", + "json": { + "$id": "4233", + "name": "kind" + } + } + } + ] + }, + "binaryQuantization": { + "$id": "4234", + "kind": "model", + "name": "BinaryQuantizationCompression", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.BinaryQuantizationCompression", + "usage": "Input,Output,Json", + "doc": "Contains configuration options specific to the binary quantization compression\nmethod used during indexing and querying.", + "discriminatorValue": "binaryQuantization", + "decorators": [], + "baseModel": { + "$ref": "4185" + }, + "properties": [ + { + "$id": "4235", + "kind": "property", + "name": "kind", + "serializedName": "kind", + "doc": "The name of the kind of compression method being configured for use with vector\nsearch.", + "type": { + "$id": "4236", + "kind": "constant", + "valueType": { + "$id": "4237", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "binaryQuantization", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.BinaryQuantizationCompression.kind", + "serializationOptions": { + "$id": "4238", + "json": { + "$id": "4239", + "name": "kind" + } + } + } + ] + } + } + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VectorSearch.compressions", + "serializationOptions": { + "$id": "4240", + "json": { + "$id": "4241", + "name": "compressions" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.vectorSearch", + "serializationOptions": { + "$id": "4242", + "json": { + "$id": "4243", + "name": "vectorSearch" + } + } + }, + { + "$id": "4244", + "kind": "property", + "name": "eTag", + "serializedName": "@odata.etag", + "doc": "The ETag of the index.", + "type": { + "$id": "4245", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndex.eTag", + "serializationOptions": { + "$id": "4246", + "json": { + "$id": "4247", + "name": "@odata.etag" + } + } + } + ] + }, + { + "$ref": "2927" + }, + { + "$ref": "2999" + }, + { + "$ref": "3005" + }, + { + "$ref": "3016" + }, + { + "$ref": "3033" + }, + { + "$ref": "3035" + }, + { + "$ref": "3051" + }, + { + "$ref": "3053" + }, + { + "$ref": "3066" + }, + { + "$ref": "3068" + }, + { + "$ref": "3088" + }, + { + "$ref": "3090" + }, + { + "$ref": "3114" + }, + { + "$ref": "3128" + }, + { + "$ref": "3146" + }, + { + "$ref": "3156" + }, + { + "$ref": "3173" + }, + { + "$ref": "3195" + }, + { + "$ref": "3210" + }, + { + "$ref": "3225" + }, + { + "$ref": "3235" + }, + { + "$ref": "3245" + }, + { + "$ref": "3263" + }, + { + "$ref": "3273" + }, + { + "$ref": "3290" + }, + { + "$ref": "3307" + }, + { + "$ref": "3325" + }, + { + "$ref": "3351" + }, + { + "$ref": "3368" + }, + { + "$ref": "3378" + }, + { + "$ref": "3392" + }, + { + "$ref": "3402" + }, + { + "$ref": "3412" + }, + { + "$ref": "3426" + }, + { + "$ref": "3445" + }, + { + "$ref": "3472" + }, + { + "$ref": "3489" + }, + { + "$ref": "3500" + }, + { + "$ref": "3515" + }, + { + "$ref": "3530" + }, + { + "$ref": "3544" + }, + { + "$ref": "3558" + }, + { + "$ref": "3572" + }, + { + "$ref": "3587" + }, + { + "$ref": "3601" + }, + { + "$ref": "3614" + }, + { + "$ref": "3644" + }, + { + "$ref": "3653" + }, + { + "$ref": "3662" + }, + { + "$ref": "3673" + }, + { + "$ref": "3695" + }, + { + "$ref": "3714" + }, + { + "$ref": "3724" + }, + { + "$ref": "3734" + }, + { + "$ref": "3785" + }, + { + "$ref": "3795" + }, + { + "$ref": "3806" + }, + { + "$ref": "3824" + }, + { + "$ref": "3834" + }, + { + "$ref": "3851" + }, + { + "$ref": "3865" + }, + { + "$ref": "3877" + }, + { + "$ref": "3883" + }, + { + "$ref": "3889" + }, + { + "$ref": "3904" + }, + { + "$ref": "3910" + }, + { + "$ref": "3916" + }, + { + "$ref": "3933" + }, + { + "$ref": "3940" + }, + { + "$ref": "3946" + }, + { + "$ref": "3948" + }, + { + "$ref": "3974" + }, + { + "$ref": "3977" + }, + { + "$ref": "3998" + }, + { + "$ref": "4007" + }, + { + "$ref": "4009" + }, + { + "$ref": "4032" + }, + { + "$ref": "4034" + }, + { + "$ref": "4049" + }, + { + "$ref": "4058" + }, + { + "$ref": "4060" + }, + { + "$ref": "4086" + }, + { + "$ref": "4088" + }, + { + "$ref": "4122" + }, + { + "$ref": "4124" + }, + { + "$ref": "4147" + }, + { + "$ref": "4149" + }, + { + "$ref": "4185" + }, + { + "$ref": "4202" + }, + { + "$ref": "4221" + }, + { + "$ref": "4223" + }, + { + "$ref": "4234" + }, + { + "$id": "4248", + "kind": "model", + "name": "ListIndexesResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ListIndexesResult", + "usage": "Output,Json", + "doc": "Response from a List Indexes request. If successful, it includes the full\ndefinitions of all indexes.", + "decorators": [], + "properties": [ + { + "$id": "4249", + "kind": "property", + "name": "indexes", + "serializedName": "value", + "doc": "The indexes in the Search service.", + "type": { + "$id": "4250", + "kind": "array", + "name": "ArraySearchIndex", + "valueType": { + "$ref": "2920" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ListIndexesResult.value", + "serializationOptions": { + "$id": "4251", + "json": { + "$id": "4252", + "name": "value" + } + } + } + ] + }, + { + "$id": "4253", + "kind": "model", + "name": "GetIndexStatisticsResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.GetIndexStatisticsResult", + "usage": "Output,Json", + "doc": "Statistics for a given index. Statistics are collected periodically and are not\nguaranteed to always be up-to-date.", + "decorators": [], + "properties": [ + { + "$id": "4254", + "kind": "property", + "name": "documentCount", + "serializedName": "documentCount", + "doc": "The number of documents in the index.", + "type": { + "$id": "4255", + "kind": "int64", + "name": "int64", + "crossLanguageDefinitionId": "TypeSpec.int64", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.GetIndexStatisticsResult.documentCount", + "serializationOptions": { + "$id": "4256", + "json": { + "$id": "4257", + "name": "documentCount" + } + } + }, + { + "$id": "4258", + "kind": "property", + "name": "storageSize", + "serializedName": "storageSize", + "doc": "The amount of storage in bytes consumed by the index.", + "type": { + "$id": "4259", + "kind": "int64", + "name": "int64", + "crossLanguageDefinitionId": "TypeSpec.int64", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.GetIndexStatisticsResult.storageSize", + "serializationOptions": { + "$id": "4260", + "json": { + "$id": "4261", + "name": "storageSize" + } + } + }, + { + "$id": "4262", + "kind": "property", + "name": "vectorIndexSize", + "serializedName": "vectorIndexSize", + "doc": "The amount of memory in bytes consumed by vectors in the index.", + "type": { + "$id": "4263", + "kind": "int64", + "name": "int64", + "crossLanguageDefinitionId": "TypeSpec.int64", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.GetIndexStatisticsResult.vectorIndexSize", + "serializationOptions": { + "$id": "4264", + "json": { + "$id": "4265", + "name": "vectorIndexSize" + } + } + } + ] + }, + { + "$id": "4266", + "kind": "model", + "name": "AnalyzeRequest", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AnalyzeRequest", + "usage": "Input,Json", + "doc": "Specifies some text and analysis components used to break that text into tokens.", + "decorators": [], + "properties": [ + { + "$id": "4267", + "kind": "property", + "name": "text", + "serializedName": "text", + "doc": "The text to break into tokens.", + "type": { + "$id": "4268", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AnalyzeRequest.text", + "serializationOptions": { + "$id": "4269", + "json": { + "$id": "4270", + "name": "text" + } + } + }, + { + "$id": "4271", + "kind": "property", + "name": "analyzer", + "serializedName": "analyzer", + "doc": "The name of the analyzer to use to break the given text. If this parameter is\nnot specified, you must specify a tokenizer instead. The tokenizer and analyzer\nparameters are mutually exclusive.", + "type": { + "$ref": "310" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AnalyzeRequest.analyzer", + "serializationOptions": { + "$id": "4272", + "json": { + "$id": "4273", + "name": "analyzer" + } + } + }, + { + "$id": "4274", + "kind": "property", + "name": "tokenizer", + "serializedName": "tokenizer", + "doc": "The name of the tokenizer to use to break the given text. If this parameter is\nnot specified, you must specify an analyzer instead. The tokenizer and analyzer\nparameters are mutually exclusive.", + "type": { + "$ref": "539" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AnalyzeRequest.tokenizer", + "serializationOptions": { + "$id": "4275", + "json": { + "$id": "4276", + "name": "tokenizer" + } + } + }, + { + "$id": "4277", + "kind": "property", + "name": "normalizer", + "serializedName": "normalizer", + "doc": "The name of the normalizer to use to normalize the given text.", + "type": { + "$ref": "498" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AnalyzeRequest.normalizer", + "serializationOptions": { + "$id": "4278", + "json": { + "$id": "4279", + "name": "normalizer" + } + } + }, + { + "$id": "4280", + "kind": "property", + "name": "tokenFilters", + "serializedName": "tokenFilters", + "doc": "An optional list of token filters to use when breaking the given text. This\nparameter can only be set when using the tokenizer parameter.", + "type": { + "$id": "4281", + "kind": "array", + "name": "ArrayTokenFilterName", + "valueType": { + "$ref": "567" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AnalyzeRequest.tokenFilters", + "serializationOptions": { + "$id": "4282", + "json": { + "$id": "4283", + "name": "tokenFilters" + } + } + }, + { + "$id": "4284", + "kind": "property", + "name": "charFilters", + "serializedName": "charFilters", + "doc": "An optional list of character filters to use when breaking the given text. This\nparameter can only be set when using the tokenizer parameter.", + "type": { + "$id": "4285", + "kind": "array", + "name": "ArrayCharFilterName", + "valueType": { + "$ref": "637" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AnalyzeRequest.charFilters", + "serializationOptions": { + "$id": "4286", + "json": { + "$id": "4287", + "name": "charFilters" + } + } + } + ] + }, + { + "$id": "4288", + "kind": "model", + "name": "AnalyzeResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AnalyzeResult", + "usage": "Output,Json", + "doc": "The result of testing an analyzer on text.", + "decorators": [], + "properties": [ + { + "$id": "4289", + "kind": "property", + "name": "tokens", + "serializedName": "tokens", + "doc": "The list of tokens returned by the analyzer specified in the request.", + "type": { + "$id": "4290", + "kind": "array", + "name": "ArrayAnalyzedTokenInfo", + "valueType": { + "$id": "4291", + "kind": "model", + "name": "AnalyzedTokenInfo", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AnalyzedTokenInfo", + "usage": "Output,Json", + "doc": "Information about a token returned by an analyzer.", + "decorators": [], + "properties": [ + { + "$id": "4292", + "kind": "property", + "name": "token", + "serializedName": "token", + "doc": "The token returned by the analyzer.", + "type": { + "$id": "4293", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AnalyzedTokenInfo.token", + "serializationOptions": { + "$id": "4294", + "json": { + "$id": "4295", + "name": "token" + } + } + }, + { + "$id": "4296", + "kind": "property", + "name": "startOffset", + "serializedName": "startOffset", + "doc": "The index of the first character of the token in the input text.", + "type": { + "$id": "4297", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AnalyzedTokenInfo.startOffset", + "serializationOptions": { + "$id": "4298", + "json": { + "$id": "4299", + "name": "startOffset" + } + } + }, + { + "$id": "4300", + "kind": "property", + "name": "endOffset", + "serializedName": "endOffset", + "doc": "The index of the last character of the token in the input text.", + "type": { + "$id": "4301", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AnalyzedTokenInfo.endOffset", + "serializationOptions": { + "$id": "4302", + "json": { + "$id": "4303", + "name": "endOffset" + } + } + }, + { + "$id": "4304", + "kind": "property", + "name": "position", + "serializedName": "position", + "doc": "The position of the token in the input text relative to other tokens. The first\ntoken in the input text has position 0, the next has position 1, and so on.\nDepending on the analyzer used, some tokens might have the same position, for\nexample if they are synonyms of each other.", + "type": { + "$id": "4305", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AnalyzedTokenInfo.position", + "serializationOptions": { + "$id": "4306", + "json": { + "$id": "4307", + "name": "position" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AnalyzeResult.tokens", + "serializationOptions": { + "$id": "4308", + "json": { + "$id": "4309", + "name": "tokens" + } + } + } + ] + }, + { + "$ref": "4291" + }, + { + "$id": "4310", + "kind": "model", + "name": "SynonymMap", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SynonymMap", + "usage": "Input,Output,Json", + "doc": "Represents a synonym map definition.", + "decorators": [], + "properties": [ + { + "$id": "4311", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the synonym map.", + "type": { + "$id": "4312", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SynonymMap.name", + "serializationOptions": { + "$id": "4313", + "json": { + "$id": "4314", + "name": "name" + } + } + }, + { + "$id": "4315", + "kind": "property", + "name": "format", + "serializedName": "format", + "doc": "The format of the synonym map. Only the 'solr' format is currently supported.", + "type": { + "$id": "4316", + "kind": "constant", + "valueType": { + "$ref": "1173" + }, + "value": "solr", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SynonymMap.format", + "serializationOptions": { + "$id": "4317", + "json": { + "$id": "4318", + "name": "format" + } + } + }, + { + "$id": "4319", + "kind": "property", + "name": "synonyms", + "serializedName": "synonyms", + "doc": "A series of synonym rules in the specified synonym map format. The rules must\nbe separated by newlines.", + "type": { + "$id": "4320", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SynonymMap.synonyms", + "serializationOptions": { + "$id": "4321", + "json": { + "$id": "4322", + "name": "synonyms" + } + } + }, + { + "$id": "4323", + "kind": "property", + "name": "encryptionKey", + "serializedName": "encryptionKey", + "doc": "A description of an encryption key that you create in Azure Key Vault. This key\nis used to provide an additional level of encryption-at-rest for your data when\nyou want full assurance that no one, not even Microsoft, can decrypt your data.\nOnce you have encrypted your data, it will always remain encrypted. The search\nservice will ignore attempts to set this property to null. You can change this\nproperty as needed if you want to rotate your encryption key; Your data will be\nunaffected. Encryption with customer-managed keys is not available for free\nsearch services, and is only available for paid services created on or after\nJanuary 1, 2019.", + "type": { + "$ref": "3851" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SynonymMap.encryptionKey", + "serializationOptions": { + "$id": "4324", + "json": { + "$id": "4325", + "name": "encryptionKey" + } + } + }, + { + "$id": "4326", + "kind": "property", + "name": "eTag", + "serializedName": "@odata.etag", + "doc": "The ETag of the synonym map.", + "type": { + "$id": "4327", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SynonymMap.eTag", + "serializationOptions": { + "$id": "4328", + "json": { + "$id": "4329", + "name": "@odata.etag" + } + } + } + ] + }, + { + "$id": "4330", + "kind": "model", + "name": "ListSynonymMapsResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ListSynonymMapsResult", + "usage": "Output,Json", + "doc": "Response from a List SynonymMaps request. If successful, it includes the full\ndefinitions of all synonym maps.", + "decorators": [], + "properties": [ + { + "$id": "4331", + "kind": "property", + "name": "synonymMaps", + "serializedName": "value", + "doc": "The synonym maps in the Search service.", + "type": { + "$id": "4332", + "kind": "array", + "name": "ArraySynonymMap", + "valueType": { + "$ref": "4310" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ListSynonymMapsResult.value", + "serializationOptions": { + "$id": "4333", + "json": { + "$id": "4334", + "name": "value" + } + } + } + ] + }, + { + "$id": "4335", + "kind": "model", + "name": "SearchIndexerSkillset", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerSkillset", + "usage": "Input,Output,Json", + "doc": "A list of skills.", + "decorators": [], + "properties": [ + { + "$id": "4336", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the skillset.", + "type": { + "$id": "4337", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerSkillset.name", + "serializationOptions": { + "$id": "4338", + "json": { + "$id": "4339", + "name": "name" + } + } + }, + { + "$id": "4340", + "kind": "property", + "name": "description", + "serializedName": "description", + "doc": "The description of the skillset.", + "type": { + "$id": "4341", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerSkillset.description", + "serializationOptions": { + "$id": "4342", + "json": { + "$id": "4343", + "name": "description" + } + } + }, + { + "$id": "4344", + "kind": "property", + "name": "skills", + "serializedName": "skills", + "doc": "A list of skills in the skillset.", + "type": { + "$id": "4345", + "kind": "array", + "name": "ArraySearchIndexerSkill", + "valueType": { + "$id": "4346", + "kind": "model", + "name": "SearchIndexerSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerSkill", + "usage": "Input,Output,Json", + "doc": "Base type for skills.", + "decorators": [], + "discriminatorProperty": { + "$id": "4347", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "The discriminator for derived types.", + "type": { + "$id": "4348", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerSkill.@odata.type", + "serializationOptions": { + "$id": "4349", + "json": { + "$id": "4350", + "name": "@odata.type" + } + } + }, + "properties": [ + { + "$ref": "4347" + }, + { + "$id": "4351", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the skill which uniquely identifies it within the skillset. A skill\nwith no name defined will be given a default name of its 1-based index in the\nskills array, prefixed with the character '#'.", + "type": { + "$id": "4352", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerSkill.name", + "serializationOptions": { + "$id": "4353", + "json": { + "$id": "4354", + "name": "name" + } + } + }, + { + "$id": "4355", + "kind": "property", + "name": "description", + "serializedName": "description", + "doc": "The description of the skill which describes the inputs, outputs, and usage of\nthe skill.", + "type": { + "$id": "4356", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerSkill.description", + "serializationOptions": { + "$id": "4357", + "json": { + "$id": "4358", + "name": "description" + } + } + }, + { + "$id": "4359", + "kind": "property", + "name": "context", + "serializedName": "context", + "doc": "Represents the level at which operations take place, such as the document root\nor document content (for example, /document or /document/content). The default\nis /document.", + "type": { + "$id": "4360", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerSkill.context", + "serializationOptions": { + "$id": "4361", + "json": { + "$id": "4362", + "name": "context" + } + } + }, + { + "$id": "4363", + "kind": "property", + "name": "inputs", + "serializedName": "inputs", + "doc": "Inputs of the skills could be a column in the source data set, or the output of\nan upstream skill.", + "type": { + "$id": "4364", + "kind": "array", + "name": "ArrayInputFieldMappingEntry", + "valueType": { + "$id": "4365", + "kind": "model", + "name": "InputFieldMappingEntry", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.InputFieldMappingEntry", + "usage": "Input,Output,Json", + "doc": "Input field mapping for a skill.", + "decorators": [], + "properties": [ + { + "$id": "4366", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the input.", + "type": { + "$id": "4367", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.InputFieldMappingEntry.name", + "serializationOptions": { + "$id": "4368", + "json": { + "$id": "4369", + "name": "name" + } + } + }, + { + "$id": "4370", + "kind": "property", + "name": "source", + "serializedName": "source", + "doc": "The source of the input.", + "type": { + "$id": "4371", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.InputFieldMappingEntry.source", + "serializationOptions": { + "$id": "4372", + "json": { + "$id": "4373", + "name": "source" + } + } + }, + { + "$id": "4374", + "kind": "property", + "name": "sourceContext", + "serializedName": "sourceContext", + "doc": "The source context used for selecting recursive inputs.", + "type": { + "$id": "4375", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.InputFieldMappingEntry.sourceContext", + "serializationOptions": { + "$id": "4376", + "json": { + "$id": "4377", + "name": "sourceContext" + } + } + }, + { + "$id": "4378", + "kind": "property", + "name": "inputs", + "serializedName": "inputs", + "doc": "The recursive inputs used when creating a complex type.", + "type": { + "$id": "4379", + "kind": "array", + "name": "ArrayInputFieldMappingEntry", + "valueType": { + "$ref": "4365" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.InputFieldMappingEntry.inputs", + "serializationOptions": { + "$id": "4380", + "json": { + "$id": "4381", + "name": "inputs" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerSkill.inputs", + "serializationOptions": { + "$id": "4382", + "json": { + "$id": "4383", + "name": "inputs" + } + } + }, + { + "$id": "4384", + "kind": "property", + "name": "outputs", + "serializedName": "outputs", + "doc": "The output of a skill is either a field in a search index, or a value that can\nbe consumed as an input by another skill.", + "type": { + "$id": "4385", + "kind": "array", + "name": "ArrayOutputFieldMappingEntry", + "valueType": { + "$id": "4386", + "kind": "model", + "name": "OutputFieldMappingEntry", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.OutputFieldMappingEntry", + "usage": "Input,Output,Json", + "doc": "Output field mapping for a skill.", + "decorators": [], + "properties": [ + { + "$id": "4387", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the output defined by the skill.", + "type": { + "$id": "4388", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.OutputFieldMappingEntry.name", + "serializationOptions": { + "$id": "4389", + "json": { + "$id": "4390", + "name": "name" + } + } + }, + { + "$id": "4391", + "kind": "property", + "name": "targetName", + "serializedName": "targetName", + "doc": "The target name of the output. It is optional and default to name.", + "type": { + "$id": "4392", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.OutputFieldMappingEntry.targetName", + "serializationOptions": { + "$id": "4393", + "json": { + "$id": "4394", + "name": "targetName" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerSkill.outputs", + "serializationOptions": { + "$id": "4395", + "json": { + "$id": "4396", + "name": "outputs" + } + } + } + ], + "discriminatedSubtypes": { + "$id": "4397", + "#Microsoft.Skills.Util.ConditionalSkill": { + "$id": "4398", + "kind": "model", + "name": "ConditionalSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ConditionalSkill", + "usage": "Input,Output,Json", + "doc": "A skill that enables scenarios that require a Boolean operation to determine\nthe data to assign to an output.", + "discriminatorValue": "#Microsoft.Skills.Util.ConditionalSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4399", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4400", + "kind": "constant", + "valueType": { + "$id": "4401", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Util.ConditionalSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ConditionalSkill.@odata.type", + "serializationOptions": { + "$id": "4402", + "json": { + "$id": "4403", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Text.KeyPhraseExtractionSkill": { + "$id": "4404", + "kind": "model", + "name": "KeyPhraseExtractionSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.KeyPhraseExtractionSkill", + "usage": "Input,Output,Json", + "doc": "A skill that uses text analytics for key phrase extraction.", + "discriminatorValue": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4405", + "kind": "property", + "name": "defaultLanguageCode", + "serializedName": "defaultLanguageCode", + "doc": "A value indicating which language code to use. Default is `en`.", + "type": { + "$ref": "1176" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.KeyPhraseExtractionSkill.defaultLanguageCode", + "serializationOptions": { + "$id": "4406", + "json": { + "$id": "4407", + "name": "defaultLanguageCode" + } + } + }, + { + "$id": "4408", + "kind": "property", + "name": "maxKeyPhraseCount", + "serializedName": "maxKeyPhraseCount", + "doc": "A number indicating how many key phrases to return. If absent, all identified\nkey phrases will be returned.", + "type": { + "$id": "4409", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.KeyPhraseExtractionSkill.maxKeyPhraseCount", + "serializationOptions": { + "$id": "4410", + "json": { + "$id": "4411", + "name": "maxKeyPhraseCount" + } + } + }, + { + "$id": "4412", + "kind": "property", + "name": "modelVersion", + "serializedName": "modelVersion", + "doc": "The version of the model to use when calling the Text Analytics service. It\nwill default to the latest available when not specified. We recommend you do\nnot specify this value unless absolutely necessary.", + "type": { + "$id": "4413", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.KeyPhraseExtractionSkill.modelVersion", + "serializationOptions": { + "$id": "4414", + "json": { + "$id": "4415", + "name": "modelVersion" + } + } + }, + { + "$id": "4416", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4417", + "kind": "constant", + "valueType": { + "$id": "4418", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.KeyPhraseExtractionSkill.@odata.type", + "serializationOptions": { + "$id": "4419", + "json": { + "$id": "4420", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Vision.OcrSkill": { + "$id": "4421", + "kind": "model", + "name": "OcrSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.OcrSkill", + "usage": "Input,Output,Json", + "doc": "A skill that extracts text from image files.", + "discriminatorValue": "#Microsoft.Skills.Vision.OcrSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4422", + "kind": "property", + "name": "defaultLanguageCode", + "serializedName": "defaultLanguageCode", + "doc": "A value indicating which language code to use. Default is `en`.", + "type": { + "$ref": "1210" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.OcrSkill.defaultLanguageCode", + "serializationOptions": { + "$id": "4423", + "json": { + "$id": "4424", + "name": "defaultLanguageCode" + } + } + }, + { + "$id": "4425", + "kind": "property", + "name": "shouldDetectOrientation", + "serializedName": "detectOrientation", + "doc": "A value indicating to turn orientation detection on or not. Default is false.", + "type": { + "$id": "4426", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.OcrSkill.detectOrientation", + "serializationOptions": { + "$id": "4427", + "json": { + "$id": "4428", + "name": "detectOrientation" + } + } + }, + { + "$id": "4429", + "kind": "property", + "name": "lineEnding", + "serializedName": "lineEnding", + "doc": "Defines the sequence of characters to use between the lines of text recognized\nby the OCR skill. The default value is \"space\".", + "type": { + "$ref": "1552" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.OcrSkill.lineEnding", + "serializationOptions": { + "$id": "4430", + "json": { + "$id": "4431", + "name": "lineEnding" + } + } + }, + { + "$id": "4432", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4433", + "kind": "constant", + "valueType": { + "$id": "4434", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Vision.OcrSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.OcrSkill.@odata.type", + "serializationOptions": { + "$id": "4435", + "json": { + "$id": "4436", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Vision.ImageAnalysisSkill": { + "$id": "4437", + "kind": "model", + "name": "ImageAnalysisSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ImageAnalysisSkill", + "usage": "Input,Output,Json", + "doc": "A skill that analyzes image files. It extracts a rich set of visual features\nbased on the image content.", + "discriminatorValue": "#Microsoft.Skills.Vision.ImageAnalysisSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4438", + "kind": "property", + "name": "defaultLanguageCode", + "serializedName": "defaultLanguageCode", + "doc": "A value indicating which language code to use. Default is `en`.", + "type": { + "$ref": "1562" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ImageAnalysisSkill.defaultLanguageCode", + "serializationOptions": { + "$id": "4439", + "json": { + "$id": "4440", + "name": "defaultLanguageCode" + } + } + }, + { + "$id": "4441", + "kind": "property", + "name": "visualFeatures", + "serializedName": "visualFeatures", + "doc": "A list of visual features.", + "type": { + "$id": "4442", + "kind": "array", + "name": "ArrayVisualFeature", + "valueType": { + "$ref": "1668" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ImageAnalysisSkill.visualFeatures", + "serializationOptions": { + "$id": "4443", + "json": { + "$id": "4444", + "name": "visualFeatures" + } + } + }, + { + "$id": "4445", + "kind": "property", + "name": "details", + "serializedName": "details", + "doc": "A string indicating which domain-specific details to return.", + "type": { + "$id": "4446", + "kind": "array", + "name": "ArrayImageDetail", + "valueType": { + "$ref": "1684" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ImageAnalysisSkill.details", + "serializationOptions": { + "$id": "4447", + "json": { + "$id": "4448", + "name": "details" + } + } + }, + { + "$id": "4449", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4450", + "kind": "constant", + "valueType": { + "$id": "4451", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Vision.ImageAnalysisSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ImageAnalysisSkill.@odata.type", + "serializationOptions": { + "$id": "4452", + "json": { + "$id": "4453", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Text.LanguageDetectionSkill": { + "$id": "4454", + "kind": "model", + "name": "LanguageDetectionSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.LanguageDetectionSkill", + "usage": "Input,Output,Json", + "doc": "A skill that detects the language of input text and reports a single language\ncode for every document submitted on the request. The language code is paired\nwith a score indicating the confidence of the analysis.", + "discriminatorValue": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4455", + "kind": "property", + "name": "defaultCountryHint", + "serializedName": "defaultCountryHint", + "doc": "A country code to use as a hint to the language detection model if it cannot\ndisambiguate the language.", + "type": { + "$id": "4456", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LanguageDetectionSkill.defaultCountryHint", + "serializationOptions": { + "$id": "4457", + "json": { + "$id": "4458", + "name": "defaultCountryHint" + } + } + }, + { + "$id": "4459", + "kind": "property", + "name": "modelVersion", + "serializedName": "modelVersion", + "doc": "The version of the model to use when calling the Text Analytics service. It\nwill default to the latest available when not specified. We recommend you do\nnot specify this value unless absolutely necessary.", + "type": { + "$id": "4460", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LanguageDetectionSkill.modelVersion", + "serializationOptions": { + "$id": "4461", + "json": { + "$id": "4462", + "name": "modelVersion" + } + } + }, + { + "$id": "4463", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4464", + "kind": "constant", + "valueType": { + "$id": "4465", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.LanguageDetectionSkill.@odata.type", + "serializationOptions": { + "$id": "4466", + "json": { + "$id": "4467", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Util.ShaperSkill": { + "$id": "4468", + "kind": "model", + "name": "ShaperSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ShaperSkill", + "usage": "Input,Output,Json", + "doc": "A skill for reshaping the outputs. It creates a complex type to support\ncomposite fields (also known as multipart fields).", + "discriminatorValue": "#Microsoft.Skills.Util.ShaperSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4469", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4470", + "kind": "constant", + "valueType": { + "$id": "4471", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Util.ShaperSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ShaperSkill.@odata.type", + "serializationOptions": { + "$id": "4472", + "json": { + "$id": "4473", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Text.MergeSkill": { + "$id": "4474", + "kind": "model", + "name": "MergeSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.MergeSkill", + "usage": "Input,Output,Json", + "doc": "A skill for merging two or more strings into a single unified string, with an\noptional user-defined delimiter separating each component part.", + "discriminatorValue": "#Microsoft.Skills.Text.MergeSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4475", + "kind": "property", + "name": "insertPreTag", + "serializedName": "insertPreTag", + "doc": "The tag indicates the start of the merged text. By default, the tag is an empty\nspace.", + "type": { + "$id": "4476", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MergeSkill.insertPreTag", + "serializationOptions": { + "$id": "4477", + "json": { + "$id": "4478", + "name": "insertPreTag" + } + } + }, + { + "$id": "4479", + "kind": "property", + "name": "insertPostTag", + "serializedName": "insertPostTag", + "doc": "The tag indicates the end of the merged text. By default, the tag is an empty\nspace.", + "type": { + "$id": "4480", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MergeSkill.insertPostTag", + "serializationOptions": { + "$id": "4481", + "json": { + "$id": "4482", + "name": "insertPostTag" + } + } + }, + { + "$id": "4483", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4484", + "kind": "constant", + "valueType": { + "$id": "4485", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Text.MergeSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.MergeSkill.@odata.type", + "serializationOptions": { + "$id": "4486", + "json": { + "$id": "4487", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Text.EntityRecognitionSkill": { + "$id": "4488", + "kind": "model", + "name": "EntityRecognitionSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.EntityRecognitionSkill", + "usage": "Input,Output,Json", + "doc": "This skill is deprecated. Use the V3.EntityRecognitionSkill instead.", + "discriminatorValue": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4489", + "kind": "property", + "name": "categories", + "serializedName": "categories", + "doc": "A list of entity categories that should be extracted.", + "type": { + "$id": "4490", + "kind": "array", + "name": "ArrayEntityCategory", + "valueType": { + "$ref": "1690" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EntityRecognitionSkill.categories", + "serializationOptions": { + "$id": "4491", + "json": { + "$id": "4492", + "name": "categories" + } + } + }, + { + "$id": "4493", + "kind": "property", + "name": "defaultLanguageCode", + "serializedName": "defaultLanguageCode", + "doc": "A value indicating which language code to use. Default is `en`.", + "type": { + "$ref": "1706" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EntityRecognitionSkill.defaultLanguageCode", + "serializationOptions": { + "$id": "4494", + "json": { + "$id": "4495", + "name": "defaultLanguageCode" + } + } + }, + { + "$id": "4496", + "kind": "property", + "name": "includeTypelessEntities", + "serializedName": "includeTypelessEntities", + "doc": "Determines whether or not to include entities which are well known but don't\nconform to a pre-defined type. If this configuration is not set (default), set\nto null or set to false, entities which don't conform to one of the pre-defined\ntypes will not be surfaced.", + "type": { + "$id": "4497", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EntityRecognitionSkill.includeTypelessEntities", + "serializationOptions": { + "$id": "4498", + "json": { + "$id": "4499", + "name": "includeTypelessEntities" + } + } + }, + { + "$id": "4500", + "kind": "property", + "name": "minimumPrecision", + "serializedName": "minimumPrecision", + "doc": "A value between 0 and 1 that be used to only include entities whose confidence\nscore is greater than the value specified. If not set (default), or if\nexplicitly set to null, all entities will be included.", + "type": { + "$id": "4501", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EntityRecognitionSkill.minimumPrecision", + "serializationOptions": { + "$id": "4502", + "json": { + "$id": "4503", + "name": "minimumPrecision" + } + } + }, + { + "$id": "4504", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4505", + "kind": "constant", + "valueType": { + "$id": "4506", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EntityRecognitionSkill.@odata.type", + "serializationOptions": { + "$id": "4507", + "json": { + "$id": "4508", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Text.SentimentSkill": { + "$id": "4509", + "kind": "model", + "name": "SentimentSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SentimentSkill", + "usage": "Input,Output,Json", + "doc": "This skill is deprecated. Use the V3.SentimentSkill instead.", + "discriminatorValue": "#Microsoft.Skills.Text.SentimentSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4510", + "kind": "property", + "name": "defaultLanguageCode", + "serializedName": "defaultLanguageCode", + "doc": "A value indicating which language code to use. Default is `en`.", + "type": { + "$ref": "1754" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SentimentSkill.defaultLanguageCode", + "serializationOptions": { + "$id": "4511", + "json": { + "$id": "4512", + "name": "defaultLanguageCode" + } + } + }, + { + "$id": "4513", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4514", + "kind": "constant", + "valueType": { + "$id": "4515", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Text.SentimentSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SentimentSkill.@odata.type", + "serializationOptions": { + "$id": "4516", + "json": { + "$id": "4517", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Text.V3.SentimentSkill": { + "$id": "4518", + "kind": "model", + "name": "SentimentSkillV3", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SentimentSkillV3", + "usage": "Input,Output,Json", + "doc": "Using the Text Analytics API, evaluates unstructured text and for each record,\nprovides sentiment labels (such as \"negative\", \"neutral\" and \"positive\") based\non the highest confidence score found by the service at a sentence and\ndocument-level.", + "discriminatorValue": "#Microsoft.Skills.Text.V3.SentimentSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4519", + "kind": "property", + "name": "defaultLanguageCode", + "serializedName": "defaultLanguageCode", + "doc": "A value indicating which language code to use. Default is `en`.", + "type": { + "$id": "4520", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SentimentSkillV3.defaultLanguageCode", + "serializationOptions": { + "$id": "4521", + "json": { + "$id": "4522", + "name": "defaultLanguageCode" + } + } + }, + { + "$id": "4523", + "kind": "property", + "name": "includeOpinionMining", + "serializedName": "includeOpinionMining", + "doc": "If set to true, the skill output will include information from Text Analytics\nfor opinion mining, namely targets (nouns or verbs) and their associated\nassessment (adjective) in the text. Default is false.", + "type": { + "$id": "4524", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SentimentSkillV3.includeOpinionMining", + "serializationOptions": { + "$id": "4525", + "json": { + "$id": "4526", + "name": "includeOpinionMining" + } + } + }, + { + "$id": "4527", + "kind": "property", + "name": "modelVersion", + "serializedName": "modelVersion", + "doc": "The version of the model to use when calling the Text Analytics service. It\nwill default to the latest available when not specified. We recommend you do\nnot specify this value unless absolutely necessary.", + "type": { + "$id": "4528", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SentimentSkillV3.modelVersion", + "serializationOptions": { + "$id": "4529", + "json": { + "$id": "4530", + "name": "modelVersion" + } + } + }, + { + "$id": "4531", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4532", + "kind": "constant", + "valueType": { + "$id": "4533", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Text.V3.SentimentSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SentimentSkillV3.@odata.type", + "serializationOptions": { + "$id": "4534", + "json": { + "$id": "4535", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Text.V3.EntityLinkingSkill": { + "$id": "4536", + "kind": "model", + "name": "EntityLinkingSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.EntityLinkingSkill", + "usage": "Input,Output,Json", + "doc": "Using the Text Analytics API, extracts linked entities from text.", + "discriminatorValue": "#Microsoft.Skills.Text.V3.EntityLinkingSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4537", + "kind": "property", + "name": "defaultLanguageCode", + "serializedName": "defaultLanguageCode", + "doc": "A value indicating which language code to use. Default is `en`.", + "type": { + "$id": "4538", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EntityLinkingSkill.defaultLanguageCode", + "serializationOptions": { + "$id": "4539", + "json": { + "$id": "4540", + "name": "defaultLanguageCode" + } + } + }, + { + "$id": "4541", + "kind": "property", + "name": "minimumPrecision", + "serializedName": "minimumPrecision", + "doc": "A value between 0 and 1 that be used to only include entities whose confidence\nscore is greater than the value specified. If not set (default), or if\nexplicitly set to null, all entities will be included.", + "type": { + "$id": "4542", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EntityLinkingSkill.minimumPrecision", + "serializationOptions": { + "$id": "4543", + "json": { + "$id": "4544", + "name": "minimumPrecision" + } + } + }, + { + "$id": "4545", + "kind": "property", + "name": "modelVersion", + "serializedName": "modelVersion", + "doc": "The version of the model to use when calling the Text Analytics service. It\nwill default to the latest available when not specified. We recommend you do\nnot specify this value unless absolutely necessary.", + "type": { + "$id": "4546", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EntityLinkingSkill.modelVersion", + "serializationOptions": { + "$id": "4547", + "json": { + "$id": "4548", + "name": "modelVersion" + } + } + }, + { + "$id": "4549", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4550", + "kind": "constant", + "valueType": { + "$id": "4551", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Text.V3.EntityLinkingSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EntityLinkingSkill.@odata.type", + "serializationOptions": { + "$id": "4552", + "json": { + "$id": "4553", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Text.V3.EntityRecognitionSkill": { + "$id": "4554", + "kind": "model", + "name": "EntityRecognitionSkillV3", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.EntityRecognitionSkillV3", + "usage": "Input,Output,Json", + "doc": "Using the Text Analytics API, extracts entities of different types from text.", + "discriminatorValue": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4555", + "kind": "property", + "name": "categories", + "serializedName": "categories", + "doc": "A list of entity categories that should be extracted.", + "type": { + "$id": "4556", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "4557", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EntityRecognitionSkillV3.categories", + "serializationOptions": { + "$id": "4558", + "json": { + "$id": "4559", + "name": "categories" + } + } + }, + { + "$id": "4560", + "kind": "property", + "name": "defaultLanguageCode", + "serializedName": "defaultLanguageCode", + "doc": "A value indicating which language code to use. Default is `en`.", + "type": { + "$id": "4561", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EntityRecognitionSkillV3.defaultLanguageCode", + "serializationOptions": { + "$id": "4562", + "json": { + "$id": "4563", + "name": "defaultLanguageCode" + } + } + }, + { + "$id": "4564", + "kind": "property", + "name": "minimumPrecision", + "serializedName": "minimumPrecision", + "doc": "A value between 0 and 1 that be used to only include entities whose confidence\nscore is greater than the value specified. If not set (default), or if\nexplicitly set to null, all entities will be included.", + "type": { + "$id": "4565", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EntityRecognitionSkillV3.minimumPrecision", + "serializationOptions": { + "$id": "4566", + "json": { + "$id": "4567", + "name": "minimumPrecision" + } + } + }, + { + "$id": "4568", + "kind": "property", + "name": "modelVersion", + "serializedName": "modelVersion", + "doc": "The version of the model to use when calling the Text Analytics API. It will\ndefault to the latest available when not specified. We recommend you do not\nspecify this value unless absolutely necessary.", + "type": { + "$id": "4569", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EntityRecognitionSkillV3.modelVersion", + "serializationOptions": { + "$id": "4570", + "json": { + "$id": "4571", + "name": "modelVersion" + } + } + }, + { + "$id": "4572", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4573", + "kind": "constant", + "valueType": { + "$id": "4574", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Text.V3.EntityRecognitionSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.EntityRecognitionSkillV3.@odata.type", + "serializationOptions": { + "$id": "4575", + "json": { + "$id": "4576", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Text.PIIDetectionSkill": { + "$id": "4577", + "kind": "model", + "name": "PIIDetectionSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.PIIDetectionSkill", + "usage": "Input,Output,Json", + "doc": "Using the Text Analytics API, extracts personal information from an input text\nand gives you the option of masking it.", + "discriminatorValue": "#Microsoft.Skills.Text.PIIDetectionSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4578", + "kind": "property", + "name": "defaultLanguageCode", + "serializedName": "defaultLanguageCode", + "doc": "A value indicating which language code to use. Default is `en`.", + "type": { + "$id": "4579", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PIIDetectionSkill.defaultLanguageCode", + "serializationOptions": { + "$id": "4580", + "json": { + "$id": "4581", + "name": "defaultLanguageCode" + } + } + }, + { + "$id": "4582", + "kind": "property", + "name": "minimumPrecision", + "serializedName": "minimumPrecision", + "doc": "A value between 0 and 1 that be used to only include entities whose confidence\nscore is greater than the value specified. If not set (default), or if\nexplicitly set to null, all entities will be included.", + "type": { + "$id": "4583", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PIIDetectionSkill.minimumPrecision", + "serializationOptions": { + "$id": "4584", + "json": { + "$id": "4585", + "name": "minimumPrecision" + } + } + }, + { + "$id": "4586", + "kind": "property", + "name": "maskingMode", + "serializedName": "maskingMode", + "doc": "A parameter that provides various ways to mask the personal information\ndetected in the input text. Default is 'none'.", + "type": { + "$ref": "1786" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PIIDetectionSkill.maskingMode", + "serializationOptions": { + "$id": "4587", + "json": { + "$id": "4588", + "name": "maskingMode" + } + } + }, + { + "$id": "4589", + "kind": "property", + "name": "mask", + "serializedName": "maskingCharacter", + "doc": "The character used to mask the text if the maskingMode parameter is set to\nreplace. Default is '*'.", + "type": { + "$id": "4590", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PIIDetectionSkill.maskingCharacter", + "serializationOptions": { + "$id": "4591", + "json": { + "$id": "4592", + "name": "maskingCharacter" + } + } + }, + { + "$id": "4593", + "kind": "property", + "name": "modelVersion", + "serializedName": "modelVersion", + "doc": "The version of the model to use when calling the Text Analytics service. It\nwill default to the latest available when not specified. We recommend you do\nnot specify this value unless absolutely necessary.", + "type": { + "$id": "4594", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PIIDetectionSkill.modelVersion", + "serializationOptions": { + "$id": "4595", + "json": { + "$id": "4596", + "name": "modelVersion" + } + } + }, + { + "$id": "4597", + "kind": "property", + "name": "piiCategories", + "serializedName": "piiCategories", + "doc": "A list of PII entity categories that should be extracted and masked.", + "type": { + "$id": "4598", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "4599", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PIIDetectionSkill.piiCategories", + "serializationOptions": { + "$id": "4600", + "json": { + "$id": "4601", + "name": "piiCategories" + } + } + }, + { + "$id": "4602", + "kind": "property", + "name": "domain", + "serializedName": "domain", + "doc": "If specified, will set the PII domain to include only a subset of the entity\ncategories. Possible values include: 'phi', 'none'. Default is 'none'.", + "type": { + "$id": "4603", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PIIDetectionSkill.domain", + "serializationOptions": { + "$id": "4604", + "json": { + "$id": "4605", + "name": "domain" + } + } + }, + { + "$id": "4606", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4607", + "kind": "constant", + "valueType": { + "$id": "4608", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Text.PIIDetectionSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.PIIDetectionSkill.@odata.type", + "serializationOptions": { + "$id": "4609", + "json": { + "$id": "4610", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Text.SplitSkill": { + "$id": "4611", + "kind": "model", + "name": "SplitSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SplitSkill", + "usage": "Input,Output,Json", + "doc": "A skill to split a string into chunks of text.", + "discriminatorValue": "#Microsoft.Skills.Text.SplitSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4612", + "kind": "property", + "name": "defaultLanguageCode", + "serializedName": "defaultLanguageCode", + "doc": "A value indicating which language code to use. Default is `en`.", + "type": { + "$ref": "1792" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SplitSkill.defaultLanguageCode", + "serializationOptions": { + "$id": "4613", + "json": { + "$id": "4614", + "name": "defaultLanguageCode" + } + } + }, + { + "$id": "4615", + "kind": "property", + "name": "textSplitMode", + "serializedName": "textSplitMode", + "doc": "A value indicating which split mode to perform.", + "type": { + "$ref": "1860" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SplitSkill.textSplitMode", + "serializationOptions": { + "$id": "4616", + "json": { + "$id": "4617", + "name": "textSplitMode" + } + } + }, + { + "$id": "4618", + "kind": "property", + "name": "maximumPageLength", + "serializedName": "maximumPageLength", + "doc": "The desired maximum page length. Default is 10000.", + "type": { + "$id": "4619", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SplitSkill.maximumPageLength", + "serializationOptions": { + "$id": "4620", + "json": { + "$id": "4621", + "name": "maximumPageLength" + } + } + }, + { + "$id": "4622", + "kind": "property", + "name": "pageOverlapLength", + "serializedName": "pageOverlapLength", + "doc": "Only applicable when textSplitMode is set to 'pages'. If specified, n+1th chunk\nwill start with this number of characters/tokens from the end of the nth chunk.", + "type": { + "$id": "4623", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SplitSkill.pageOverlapLength", + "serializationOptions": { + "$id": "4624", + "json": { + "$id": "4625", + "name": "pageOverlapLength" + } + } + }, + { + "$id": "4626", + "kind": "property", + "name": "maximumPagesToTake", + "serializedName": "maximumPagesToTake", + "doc": "Only applicable when textSplitMode is set to 'pages'. If specified, the\nSplitSkill will discontinue splitting after processing the first 'maximumPagesToTake'\npages, in order to improve performance when only a few\ninitial pages are needed from each document.", + "type": { + "$id": "4627", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SplitSkill.maximumPagesToTake", + "serializationOptions": { + "$id": "4628", + "json": { + "$id": "4629", + "name": "maximumPagesToTake" + } + } + }, + { + "$id": "4630", + "kind": "property", + "name": "unit", + "serializedName": "unit", + "doc": "Only applies if textSplitMode is set to pages. There are two possible values.\nThe choice of the values will decide the length (maximumPageLength and\npageOverlapLength) measurement. The default is 'characters', which means the\nlength will be measured by character.", + "type": { + "$ref": "1866" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SplitSkill.unit", + "serializationOptions": { + "$id": "4631", + "json": { + "$id": "4632", + "name": "unit" + } + } + }, + { + "$id": "4633", + "kind": "property", + "name": "azureOpenAITokenizerParameters", + "serializedName": "azureOpenAITokenizerParameters", + "doc": "Only applies if the unit is set to azureOpenAITokens. If specified, the\nsplitSkill will use these parameters when performing the tokenization. The\nparameters are a valid 'encoderModelName' and an optional 'allowedSpecialTokens' property.", + "type": { + "$id": "4634", + "kind": "model", + "name": "AzureOpenAITokenizerParameters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AzureOpenAITokenizerParameters", + "usage": "Input,Output,Json", + "doc": "Azure OpenAI Tokenizer parameters.", + "decorators": [], + "properties": [ + { + "$id": "4635", + "kind": "property", + "name": "encoderModelName", + "serializedName": "encoderModelName", + "doc": "Only applies if the unit is set to azureOpenAITokens. Options include\n'R50k_base', 'P50k_base', 'P50k_edit' and 'CL100k_base'. The default value is 'CL100k_base'.", + "type": { + "$ref": "1872" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAITokenizerParameters.encoderModelName", + "serializationOptions": { + "$id": "4636", + "json": { + "$id": "4637", + "name": "encoderModelName" + } + } + }, + { + "$id": "4638", + "kind": "property", + "name": "allowedSpecialTokens", + "serializedName": "allowedSpecialTokens", + "doc": "(Optional) Only applies if the unit is set to azureOpenAITokens. This parameter\ndefines a collection of special tokens that are permitted within the\ntokenization process.", + "type": { + "$id": "4639", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "4640", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAITokenizerParameters.allowedSpecialTokens", + "serializationOptions": { + "$id": "4641", + "json": { + "$id": "4642", + "name": "allowedSpecialTokens" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SplitSkill.azureOpenAITokenizerParameters", + "serializationOptions": { + "$id": "4643", + "json": { + "$id": "4644", + "name": "azureOpenAITokenizerParameters" + } + } + }, + { + "$id": "4645", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4646", + "kind": "constant", + "valueType": { + "$id": "4647", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Text.SplitSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SplitSkill.@odata.type", + "serializationOptions": { + "$id": "4648", + "json": { + "$id": "4649", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Text.CustomEntityLookupSkill": { + "$id": "4650", + "kind": "model", + "name": "CustomEntityLookupSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.CustomEntityLookupSkill", + "usage": "Input,Output,Json", + "doc": "A skill looks for text from a custom, user-defined list of words and phrases.", + "discriminatorValue": "#Microsoft.Skills.Text.CustomEntityLookupSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4651", + "kind": "property", + "name": "defaultLanguageCode", + "serializedName": "defaultLanguageCode", + "doc": "A value indicating which language code to use. Default is `en`.", + "type": { + "$ref": "1882" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntityLookupSkill.defaultLanguageCode", + "serializationOptions": { + "$id": "4652", + "json": { + "$id": "4653", + "name": "defaultLanguageCode" + } + } + }, + { + "$id": "4654", + "kind": "property", + "name": "entitiesDefinitionUri", + "serializedName": "entitiesDefinitionUri", + "doc": "Path to a JSON or CSV file containing all the target text to match against.\nThis entity definition is read at the beginning of an indexer run. Any updates\nto this file during an indexer run will not take effect until subsequent runs.\nThis config must be accessible over HTTPS.", + "type": { + "$id": "4655", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntityLookupSkill.entitiesDefinitionUri", + "serializationOptions": { + "$id": "4656", + "json": { + "$id": "4657", + "name": "entitiesDefinitionUri" + } + } + }, + { + "$id": "4658", + "kind": "property", + "name": "inlineEntitiesDefinition", + "serializedName": "inlineEntitiesDefinition", + "doc": "The inline CustomEntity definition.", + "type": { + "$id": "4659", + "kind": "array", + "name": "ArrayCustomEntity", + "valueType": { + "$id": "4660", + "kind": "model", + "name": "CustomEntity", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.CustomEntity", + "usage": "Input,Output,Json", + "doc": "An object that contains information about the matches that were found, and\nrelated metadata.", + "decorators": [], + "properties": [ + { + "$id": "4661", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The top-level entity descriptor. Matches in the skill output will be grouped by\nthis name, and it should represent the \"normalized\" form of the text being\nfound.", + "type": { + "$id": "4662", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntity.name", + "serializationOptions": { + "$id": "4663", + "json": { + "$id": "4664", + "name": "name" + } + } + }, + { + "$id": "4665", + "kind": "property", + "name": "description", + "serializedName": "description", + "doc": "This field can be used as a passthrough for custom metadata about the matched\ntext(s). The value of this field will appear with every match of its entity in\nthe skill output.", + "type": { + "$id": "4666", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntity.description", + "serializationOptions": { + "$id": "4667", + "json": { + "$id": "4668", + "name": "description" + } + } + }, + { + "$id": "4669", + "kind": "property", + "name": "type", + "serializedName": "type", + "doc": "This field can be used as a passthrough for custom metadata about the matched\ntext(s). The value of this field will appear with every match of its entity in\nthe skill output.", + "type": { + "$id": "4670", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntity.type", + "serializationOptions": { + "$id": "4671", + "json": { + "$id": "4672", + "name": "type" + } + } + }, + { + "$id": "4673", + "kind": "property", + "name": "subtype", + "serializedName": "subtype", + "doc": "This field can be used as a passthrough for custom metadata about the matched\ntext(s). The value of this field will appear with every match of its entity in\nthe skill output.", + "type": { + "$id": "4674", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntity.subtype", + "serializationOptions": { + "$id": "4675", + "json": { + "$id": "4676", + "name": "subtype" + } + } + }, + { + "$id": "4677", + "kind": "property", + "name": "id", + "serializedName": "id", + "doc": "This field can be used as a passthrough for custom metadata about the matched\ntext(s). The value of this field will appear with every match of its entity in\nthe skill output.", + "type": { + "$id": "4678", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntity.id", + "serializationOptions": { + "$id": "4679", + "json": { + "$id": "4680", + "name": "id" + } + } + }, + { + "$id": "4681", + "kind": "property", + "name": "caseSensitive", + "serializedName": "caseSensitive", + "doc": "Defaults to false. Boolean value denoting whether comparisons with the entity\nname should be sensitive to character casing. Sample case insensitive matches\nof \"Microsoft\" could be: microsoft, microSoft, MICROSOFT.", + "type": { + "$id": "4682", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntity.caseSensitive", + "serializationOptions": { + "$id": "4683", + "json": { + "$id": "4684", + "name": "caseSensitive" + } + } + }, + { + "$id": "4685", + "kind": "property", + "name": "accentSensitive", + "serializedName": "accentSensitive", + "doc": "Defaults to false. Boolean value denoting whether comparisons with the entity\nname should be sensitive to accent.", + "type": { + "$id": "4686", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntity.accentSensitive", + "serializationOptions": { + "$id": "4687", + "json": { + "$id": "4688", + "name": "accentSensitive" + } + } + }, + { + "$id": "4689", + "kind": "property", + "name": "fuzzyEditDistance", + "serializedName": "fuzzyEditDistance", + "doc": "Defaults to 0. Maximum value of 5. Denotes the acceptable number of divergent\ncharacters that would still constitute a match with the entity name. The\nsmallest possible fuzziness for any given match is returned. For instance, if\nthe edit distance is set to 3, \"Windows10\" would still match \"Windows\",\n\"Windows10\" and \"Windows 7\". When case sensitivity is set to false, case\ndifferences do NOT count towards fuzziness tolerance, but otherwise do.", + "type": { + "$id": "4690", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntity.fuzzyEditDistance", + "serializationOptions": { + "$id": "4691", + "json": { + "$id": "4692", + "name": "fuzzyEditDistance" + } + } + }, + { + "$id": "4693", + "kind": "property", + "name": "defaultCaseSensitive", + "serializedName": "defaultCaseSensitive", + "doc": "Changes the default case sensitivity value for this entity. It be used to\nchange the default value of all aliases caseSensitive values.", + "type": { + "$id": "4694", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntity.defaultCaseSensitive", + "serializationOptions": { + "$id": "4695", + "json": { + "$id": "4696", + "name": "defaultCaseSensitive" + } + } + }, + { + "$id": "4697", + "kind": "property", + "name": "defaultAccentSensitive", + "serializedName": "defaultAccentSensitive", + "doc": "Changes the default accent sensitivity value for this entity. It be used to\nchange the default value of all aliases accentSensitive values.", + "type": { + "$id": "4698", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntity.defaultAccentSensitive", + "serializationOptions": { + "$id": "4699", + "json": { + "$id": "4700", + "name": "defaultAccentSensitive" + } + } + }, + { + "$id": "4701", + "kind": "property", + "name": "defaultFuzzyEditDistance", + "serializedName": "defaultFuzzyEditDistance", + "doc": "Changes the default fuzzy edit distance value for this entity. It can be used\nto change the default value of all aliases fuzzyEditDistance values.", + "type": { + "$id": "4702", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntity.defaultFuzzyEditDistance", + "serializationOptions": { + "$id": "4703", + "json": { + "$id": "4704", + "name": "defaultFuzzyEditDistance" + } + } + }, + { + "$id": "4705", + "kind": "property", + "name": "aliases", + "serializedName": "aliases", + "doc": "An array of complex objects that can be used to specify alternative spellings\nor synonyms to the root entity name.", + "type": { + "$id": "4706", + "kind": "array", + "name": "ArrayCustomEntityAlias", + "valueType": { + "$id": "4707", + "kind": "model", + "name": "CustomEntityAlias", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.CustomEntityAlias", + "usage": "Input,Output,Json", + "doc": "A complex object that can be used to specify alternative spellings or synonyms\nto the root entity name.", + "decorators": [], + "properties": [ + { + "$id": "4708", + "kind": "property", + "name": "text", + "serializedName": "text", + "doc": "The text of the alias.", + "type": { + "$id": "4709", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntityAlias.text", + "serializationOptions": { + "$id": "4710", + "json": { + "$id": "4711", + "name": "text" + } + } + }, + { + "$id": "4712", + "kind": "property", + "name": "caseSensitive", + "serializedName": "caseSensitive", + "doc": "Determine if the alias is case sensitive.", + "type": { + "$id": "4713", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntityAlias.caseSensitive", + "serializationOptions": { + "$id": "4714", + "json": { + "$id": "4715", + "name": "caseSensitive" + } + } + }, + { + "$id": "4716", + "kind": "property", + "name": "accentSensitive", + "serializedName": "accentSensitive", + "doc": "Determine if the alias is accent sensitive.", + "type": { + "$id": "4717", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntityAlias.accentSensitive", + "serializationOptions": { + "$id": "4718", + "json": { + "$id": "4719", + "name": "accentSensitive" + } + } + }, + { + "$id": "4720", + "kind": "property", + "name": "fuzzyEditDistance", + "serializedName": "fuzzyEditDistance", + "doc": "Determine the fuzzy edit distance of the alias.", + "type": { + "$id": "4721", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntityAlias.fuzzyEditDistance", + "serializationOptions": { + "$id": "4722", + "json": { + "$id": "4723", + "name": "fuzzyEditDistance" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntity.aliases", + "serializationOptions": { + "$id": "4724", + "json": { + "$id": "4725", + "name": "aliases" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntityLookupSkill.inlineEntitiesDefinition", + "serializationOptions": { + "$id": "4726", + "json": { + "$id": "4727", + "name": "inlineEntitiesDefinition" + } + } + }, + { + "$id": "4728", + "kind": "property", + "name": "globalDefaultCaseSensitive", + "serializedName": "globalDefaultCaseSensitive", + "doc": "A global flag for CaseSensitive. If CaseSensitive is not set in CustomEntity,\nthis value will be the default value.", + "type": { + "$id": "4729", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntityLookupSkill.globalDefaultCaseSensitive", + "serializationOptions": { + "$id": "4730", + "json": { + "$id": "4731", + "name": "globalDefaultCaseSensitive" + } + } + }, + { + "$id": "4732", + "kind": "property", + "name": "globalDefaultAccentSensitive", + "serializedName": "globalDefaultAccentSensitive", + "doc": "A global flag for AccentSensitive. If AccentSensitive is not set in\nCustomEntity, this value will be the default value.", + "type": { + "$id": "4733", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntityLookupSkill.globalDefaultAccentSensitive", + "serializationOptions": { + "$id": "4734", + "json": { + "$id": "4735", + "name": "globalDefaultAccentSensitive" + } + } + }, + { + "$id": "4736", + "kind": "property", + "name": "globalDefaultFuzzyEditDistance", + "serializedName": "globalDefaultFuzzyEditDistance", + "doc": "A global flag for FuzzyEditDistance. If FuzzyEditDistance is not set in\nCustomEntity, this value will be the default value.", + "type": { + "$id": "4737", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntityLookupSkill.globalDefaultFuzzyEditDistance", + "serializationOptions": { + "$id": "4738", + "json": { + "$id": "4739", + "name": "globalDefaultFuzzyEditDistance" + } + } + }, + { + "$id": "4740", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4741", + "kind": "constant", + "valueType": { + "$id": "4742", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Text.CustomEntityLookupSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CustomEntityLookupSkill.@odata.type", + "serializationOptions": { + "$id": "4743", + "json": { + "$id": "4744", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Text.TranslationSkill": { + "$id": "4745", + "kind": "model", + "name": "TextTranslationSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.TextTranslationSkill", + "usage": "Input,Output,Json", + "doc": "A skill to translate text from one language to another.", + "discriminatorValue": "#Microsoft.Skills.Text.TranslationSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4746", + "kind": "property", + "name": "defaultToLanguageCode", + "serializedName": "defaultToLanguageCode", + "doc": "The language code to translate documents into for documents that don't specify\nthe to language explicitly.", + "type": { + "$ref": "1902" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.TextTranslationSkill.defaultToLanguageCode", + "serializationOptions": { + "$id": "4747", + "json": { + "$id": "4748", + "name": "defaultToLanguageCode" + } + } + }, + { + "$id": "4749", + "kind": "property", + "name": "defaultFromLanguageCode", + "serializedName": "defaultFromLanguageCode", + "doc": "The language code to translate documents from for documents that don't specify\nthe from language explicitly.", + "type": { + "$ref": "1902" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.TextTranslationSkill.defaultFromLanguageCode", + "serializationOptions": { + "$id": "4750", + "json": { + "$id": "4751", + "name": "defaultFromLanguageCode" + } + } + }, + { + "$id": "4752", + "kind": "property", + "name": "suggestedFrom", + "serializedName": "suggestedFrom", + "doc": "The language code to translate documents from when neither the fromLanguageCode\ninput nor the defaultFromLanguageCode parameter are provided, and the automatic\nlanguage detection is unsuccessful. Default is `en`.", + "type": { + "$ref": "1902" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.TextTranslationSkill.suggestedFrom", + "serializationOptions": { + "$id": "4753", + "json": { + "$id": "4754", + "name": "suggestedFrom" + } + } + }, + { + "$id": "4755", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4756", + "kind": "constant", + "valueType": { + "$id": "4757", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Text.TranslationSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.TextTranslationSkill.@odata.type", + "serializationOptions": { + "$id": "4758", + "json": { + "$id": "4759", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Util.DocumentExtractionSkill": { + "$id": "4760", + "kind": "model", + "name": "DocumentExtractionSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.DocumentExtractionSkill", + "usage": "Input,Output,Json", + "doc": "A skill that extracts content from a file within the enrichment pipeline.", + "discriminatorValue": "#Microsoft.Skills.Util.DocumentExtractionSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4761", + "kind": "property", + "name": "parsingMode", + "serializedName": "parsingMode", + "doc": "The parsingMode for the skill. Will be set to 'default' if not defined.", + "type": { + "$id": "4762", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DocumentExtractionSkill.parsingMode", + "serializationOptions": { + "$id": "4763", + "json": { + "$id": "4764", + "name": "parsingMode" + } + } + }, + { + "$id": "4765", + "kind": "property", + "name": "dataToExtract", + "serializedName": "dataToExtract", + "doc": "The type of data to be extracted for the skill. Will be set to 'contentAndMetadata' if not defined.", + "type": { + "$id": "4766", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DocumentExtractionSkill.dataToExtract", + "serializationOptions": { + "$id": "4767", + "json": { + "$id": "4768", + "name": "dataToExtract" + } + } + }, + { + "$id": "4769", + "kind": "property", + "name": "configuration", + "serializedName": "configuration", + "doc": "A dictionary of configurations for the skill.", + "type": { + "$id": "4770", + "kind": "dict", + "keyType": { + "$id": "4771", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "valueType": { + "$id": "4772", + "kind": "unknown", + "name": "unknown", + "crossLanguageDefinitionId": "", + "decorators": [] + }, + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DocumentExtractionSkill.configuration", + "serializationOptions": { + "$id": "4773", + "json": { + "$id": "4774", + "name": "configuration" + } + } + }, + { + "$id": "4775", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4776", + "kind": "constant", + "valueType": { + "$id": "4777", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Util.DocumentExtractionSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DocumentExtractionSkill.@odata.type", + "serializationOptions": { + "$id": "4778", + "json": { + "$id": "4779", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill": { + "$id": "4780", + "kind": "model", + "name": "DocumentIntelligenceLayoutSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.DocumentIntelligenceLayoutSkill", + "usage": "Input,Output,Json", + "doc": "A skill that extracts content and layout information (as markdown), via Azure\nAI Services, from files within the enrichment pipeline.", + "discriminatorValue": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4781", + "kind": "property", + "name": "outputMode", + "serializedName": "outputMode", + "doc": "Controls the cardinality of the output produced by the skill. Default is 'oneToMany'.", + "type": { + "$ref": "2048" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DocumentIntelligenceLayoutSkill.outputMode", + "serializationOptions": { + "$id": "4782", + "json": { + "$id": "4783", + "name": "outputMode" + } + } + }, + { + "$id": "4784", + "kind": "property", + "name": "markdownHeaderDepth", + "serializedName": "markdownHeaderDepth", + "doc": "The depth of headers in the markdown output. Default is h6.", + "type": { + "$ref": "2052" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DocumentIntelligenceLayoutSkill.markdownHeaderDepth", + "serializationOptions": { + "$id": "4785", + "json": { + "$id": "4786", + "name": "markdownHeaderDepth" + } + } + }, + { + "$id": "4787", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4788", + "kind": "constant", + "valueType": { + "$id": "4789", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DocumentIntelligenceLayoutSkill.@odata.type", + "serializationOptions": { + "$id": "4790", + "json": { + "$id": "4791", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Custom.WebApiSkill": { + "$id": "4792", + "kind": "model", + "name": "WebApiSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.WebApiSkill", + "usage": "Input,Output,Json", + "doc": "A skill that can call a Web API endpoint, allowing you to extend a skillset by\nhaving it call your custom code.", + "discriminatorValue": "#Microsoft.Skills.Custom.WebApiSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4793", + "kind": "property", + "name": "uri", + "serializedName": "uri", + "doc": "The url for the Web API.", + "type": { + "$id": "4794", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiSkill.uri", + "serializationOptions": { + "$id": "4795", + "json": { + "$id": "4796", + "name": "uri" + } + } + }, + { + "$id": "4797", + "kind": "property", + "name": "httpHeaders", + "serializedName": "httpHeaders", + "doc": "The headers required to make the http request.", + "type": { + "$id": "4798", + "kind": "dict", + "keyType": { + "$id": "4799", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "valueType": { + "$id": "4800", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiSkill.httpHeaders", + "serializationOptions": { + "$id": "4801", + "json": { + "$id": "4802", + "name": "httpHeaders" + } + } + }, + { + "$id": "4803", + "kind": "property", + "name": "httpMethod", + "serializedName": "httpMethod", + "doc": "The method for the http request.", + "type": { + "$id": "4804", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiSkill.httpMethod", + "serializationOptions": { + "$id": "4805", + "json": { + "$id": "4806", + "name": "httpMethod" + } + } + }, + { + "$id": "4807", + "kind": "property", + "name": "timeout", + "serializedName": "timeout", + "doc": "The desired timeout for the request. Default is 30 seconds.", + "type": { + "$id": "4808", + "kind": "duration", + "name": "duration", + "encode": "ISO8601", + "wireType": { + "$id": "4809", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.duration", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiSkill.timeout", + "serializationOptions": { + "$id": "4810", + "json": { + "$id": "4811", + "name": "timeout" + } + } + }, + { + "$id": "4812", + "kind": "property", + "name": "batchSize", + "serializedName": "batchSize", + "doc": "The desired batch size which indicates number of documents.", + "type": { + "$id": "4813", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiSkill.batchSize", + "serializationOptions": { + "$id": "4814", + "json": { + "$id": "4815", + "name": "batchSize" + } + } + }, + { + "$id": "4816", + "kind": "property", + "name": "degreeOfParallelism", + "serializedName": "degreeOfParallelism", + "doc": "If set, the number of parallel calls that can be made to the Web API.", + "type": { + "$id": "4817", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiSkill.degreeOfParallelism", + "serializationOptions": { + "$id": "4818", + "json": { + "$id": "4819", + "name": "degreeOfParallelism" + } + } + }, + { + "$id": "4820", + "kind": "property", + "name": "authResourceId", + "serializedName": "authResourceId", + "doc": "Applies to custom skills that connect to external code in an Azure function or\nsome other application that provides the transformations. This value should be\nthe application ID created for the function or app when it was registered with\nAzure Active Directory. When specified, the custom skill connects to the\nfunction or app using a managed ID (either system or user-assigned) of the\nsearch service and the access token of the function or app, using this value as\nthe resource id for creating the scope of the access token.", + "type": { + "$id": "4821", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiSkill.authResourceId", + "serializationOptions": { + "$id": "4822", + "json": { + "$id": "4823", + "name": "authResourceId" + } + } + }, + { + "$id": "4824", + "kind": "property", + "name": "authIdentity", + "serializedName": "authIdentity", + "doc": "The user-assigned managed identity used for outbound connections. If an\nauthResourceId is provided and it's not specified, the system-assigned managed\nidentity is used. On updates to the indexer, if the identity is unspecified,\nthe value remains unchanged. If set to \"none\", the value of this property is\ncleared.", + "type": { + "$ref": "3877" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiSkill.authIdentity", + "serializationOptions": { + "$id": "4825", + "json": { + "$id": "4826", + "name": "authIdentity" + } + } + }, + { + "$id": "4827", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4828", + "kind": "constant", + "valueType": { + "$id": "4829", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Custom.WebApiSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.WebApiSkill.@odata.type", + "serializationOptions": { + "$id": "4830", + "json": { + "$id": "4831", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Custom.AmlSkill": { + "$id": "4832", + "kind": "model", + "name": "AzureMachineLearningSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AzureMachineLearningSkill", + "usage": "Input,Output,Json", + "doc": "The AML skill allows you to extend AI enrichment with a custom Azure Machine\nLearning (AML) model. Once an AML model is trained and deployed, an AML skill\nintegrates it into AI enrichment.", + "discriminatorValue": "#Microsoft.Skills.Custom.AmlSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4833", + "kind": "property", + "name": "scoringUri", + "serializedName": "uri", + "doc": "(Required for no authentication or key authentication) The scoring URI of the\nAML service to which the JSON payload will be sent. Only the https URI scheme\nis allowed.", + "type": { + "$id": "4834", + "kind": "url", + "name": "url", + "crossLanguageDefinitionId": "TypeSpec.url", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureMachineLearningSkill.uri", + "serializationOptions": { + "$id": "4835", + "json": { + "$id": "4836", + "name": "uri" + } + } + }, + { + "$id": "4837", + "kind": "property", + "name": "authenticationKey", + "serializedName": "key", + "doc": "(Required for key authentication) The key for the AML service.", + "type": { + "$id": "4838", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureMachineLearningSkill.key", + "serializationOptions": { + "$id": "4839", + "json": { + "$id": "4840", + "name": "key" + } + } + }, + { + "$id": "4841", + "kind": "property", + "name": "resourceId", + "serializedName": "resourceId", + "doc": "(Required for token authentication). The Azure Resource Manager resource ID of\nthe AML service. It should be in the format\nsubscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}.", + "type": { + "$id": "4842", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureMachineLearningSkill.resourceId", + "serializationOptions": { + "$id": "4843", + "json": { + "$id": "4844", + "name": "resourceId" + } + } + }, + { + "$id": "4845", + "kind": "property", + "name": "timeout", + "serializedName": "timeout", + "doc": "(Optional) When specified, indicates the timeout for the http client making the\nAPI call.", + "type": { + "$id": "4846", + "kind": "duration", + "name": "duration", + "encode": "ISO8601", + "wireType": { + "$id": "4847", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.duration", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureMachineLearningSkill.timeout", + "serializationOptions": { + "$id": "4848", + "json": { + "$id": "4849", + "name": "timeout" + } + } + }, + { + "$id": "4850", + "kind": "property", + "name": "region", + "serializedName": "region", + "doc": "(Optional for token authentication). The region the AML service is deployed in.", + "type": { + "$id": "4851", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureMachineLearningSkill.region", + "serializationOptions": { + "$id": "4852", + "json": { + "$id": "4853", + "name": "region" + } + } + }, + { + "$id": "4854", + "kind": "property", + "name": "degreeOfParallelism", + "serializedName": "degreeOfParallelism", + "doc": "(Optional) When specified, indicates the number of calls the indexer will make\nin parallel to the endpoint you have provided. You can decrease this value if\nyour endpoint is failing under too high of a request load, or raise it if your\nendpoint is able to accept more requests and you would like an increase in the\nperformance of the indexer. If not set, a default value of 5 is used. The\ndegreeOfParallelism can be set to a maximum of 10 and a minimum of 1.", + "type": { + "$id": "4855", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureMachineLearningSkill.degreeOfParallelism", + "serializationOptions": { + "$id": "4856", + "json": { + "$id": "4857", + "name": "degreeOfParallelism" + } + } + }, + { + "$id": "4858", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4859", + "kind": "constant", + "valueType": { + "$id": "4860", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Custom.AmlSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureMachineLearningSkill.@odata.type", + "serializationOptions": { + "$id": "4861", + "json": { + "$id": "4862", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill": { + "$id": "4863", + "kind": "model", + "name": "AzureOpenAIEmbeddingSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AzureOpenAIEmbeddingSkill", + "usage": "Input,Output,Json", + "doc": "Allows you to generate a vector embedding for a given text input using the\nAzure OpenAI resource.", + "discriminatorValue": "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4864", + "kind": "property", + "name": "resourceUrl", + "serializedName": "resourceUri", + "doc": "The resource URI of the Azure OpenAI resource.", + "type": { + "$id": "4865", + "kind": "url", + "name": "url", + "crossLanguageDefinitionId": "TypeSpec.url", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAIEmbeddingSkill.resourceUri", + "serializationOptions": { + "$id": "4866", + "json": { + "$id": "4867", + "name": "resourceUri" + } + } + }, + { + "$id": "4868", + "kind": "property", + "name": "deploymentName", + "serializedName": "deploymentId", + "doc": "ID of the Azure OpenAI model deployment on the designated resource.", + "type": { + "$id": "4869", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAIEmbeddingSkill.deploymentId", + "serializationOptions": { + "$id": "4870", + "json": { + "$id": "4871", + "name": "deploymentId" + } + } + }, + { + "$id": "4872", + "kind": "property", + "name": "apiKey", + "serializedName": "apiKey", + "doc": "API key of the designated Azure OpenAI resource.", + "type": { + "$id": "4873", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAIEmbeddingSkill.apiKey", + "serializationOptions": { + "$id": "4874", + "json": { + "$id": "4875", + "name": "apiKey" + } + } + }, + { + "$id": "4876", + "kind": "property", + "name": "authIdentity", + "serializedName": "authIdentity", + "doc": "The user-assigned managed identity used for outbound connections.", + "type": { + "$ref": "3877" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAIEmbeddingSkill.authIdentity", + "serializationOptions": { + "$id": "4877", + "json": { + "$id": "4878", + "name": "authIdentity" + } + } + }, + { + "$id": "4879", + "kind": "property", + "name": "modelName", + "serializedName": "modelName", + "doc": "The name of the embedding model that is deployed at the provided deploymentId\npath.", + "type": { + "$ref": "1135" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAIEmbeddingSkill.modelName", + "serializationOptions": { + "$id": "4880", + "json": { + "$id": "4881", + "name": "modelName" + } + } + }, + { + "$id": "4882", + "kind": "property", + "name": "dimensions", + "serializedName": "dimensions", + "doc": "The number of dimensions the resulting output embeddings should have. Only\nsupported in text-embedding-3 and later models.", + "type": { + "$id": "4883", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAIEmbeddingSkill.dimensions", + "serializationOptions": { + "$id": "4884", + "json": { + "$id": "4885", + "name": "dimensions" + } + } + }, + { + "$id": "4886", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4887", + "kind": "constant", + "valueType": { + "$id": "4888", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AzureOpenAIEmbeddingSkill.@odata.type", + "serializationOptions": { + "$id": "4889", + "json": { + "$id": "4890", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Skills.Vision.VectorizeSkill": { + "$id": "4891", + "kind": "model", + "name": "VisionVectorizeSkill", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.VisionVectorizeSkill", + "usage": "Input,Output,Json", + "doc": "Allows you to generate a vector embedding for a given image or text input using\nthe Azure AI Services Vision Vectorize API.", + "discriminatorValue": "#Microsoft.Skills.Vision.VectorizeSkill", + "decorators": [], + "baseModel": { + "$ref": "4346" + }, + "properties": [ + { + "$id": "4892", + "kind": "property", + "name": "modelVersion", + "serializedName": "modelVersion", + "doc": "The version of the model to use when calling the AI Services Vision service. It\nwill default to the latest available when not specified.", + "type": { + "$id": "4893", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VisionVectorizeSkill.modelVersion", + "serializationOptions": { + "$id": "4894", + "json": { + "$id": "4895", + "name": "modelVersion" + } + } + }, + { + "$id": "4896", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of skill.", + "type": { + "$id": "4897", + "kind": "constant", + "valueType": { + "$id": "4898", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Skills.Vision.VectorizeSkill", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.VisionVectorizeSkill.@odata.type", + "serializationOptions": { + "$id": "4899", + "json": { + "$id": "4900", + "name": "@odata.type" + } + } + } + ] + } + } + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerSkillset.skills", + "serializationOptions": { + "$id": "4901", + "json": { + "$id": "4902", + "name": "skills" + } + } + }, + { + "$id": "4903", + "kind": "property", + "name": "cognitiveServicesAccount", + "serializedName": "cognitiveServices", + "doc": "Details about the Azure AI service to be used when running skills.", + "type": { + "$id": "4904", + "kind": "model", + "name": "CognitiveServicesAccount", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.CognitiveServicesAccount", + "usage": "Input,Output,Json", + "doc": "Base type for describing any Azure AI service resource attached to a skillset.", + "decorators": [], + "discriminatorProperty": { + "$id": "4905", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "The discriminator for derived types.", + "type": { + "$id": "4906", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CognitiveServicesAccount.@odata.type", + "serializationOptions": { + "$id": "4907", + "json": { + "$id": "4908", + "name": "@odata.type" + } + } + }, + "properties": [ + { + "$ref": "4905" + }, + { + "$id": "4909", + "kind": "property", + "name": "description", + "serializedName": "description", + "doc": "Description of the Azure AI service resource attached to a skillset.", + "type": { + "$id": "4910", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CognitiveServicesAccount.description", + "serializationOptions": { + "$id": "4911", + "json": { + "$id": "4912", + "name": "description" + } + } + } + ], + "discriminatedSubtypes": { + "$id": "4913", + "#Microsoft.Azure.Search.DefaultCognitiveServices": { + "$id": "4914", + "kind": "model", + "name": "DefaultCognitiveServicesAccount", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.DefaultCognitiveServicesAccount", + "usage": "Input,Output,Json", + "doc": "An empty object that represents the default Azure AI service resource for a\nskillset.", + "discriminatorValue": "#Microsoft.Azure.Search.DefaultCognitiveServices", + "decorators": [], + "baseModel": { + "$ref": "4904" + }, + "properties": [ + { + "$id": "4915", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of Azure AI service resource attached to a\nskillset.", + "type": { + "$id": "4916", + "kind": "constant", + "valueType": { + "$id": "4917", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.DefaultCognitiveServices", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DefaultCognitiveServicesAccount.@odata.type", + "serializationOptions": { + "$id": "4918", + "json": { + "$id": "4919", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.CognitiveServicesByKey": { + "$id": "4920", + "kind": "model", + "name": "CognitiveServicesAccountKey", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.CognitiveServicesAccountKey", + "usage": "Input,Output,Json", + "doc": "The multi-region account key of an Azure AI service resource that's attached to\na skillset.", + "discriminatorValue": "#Microsoft.Azure.Search.CognitiveServicesByKey", + "decorators": [], + "baseModel": { + "$ref": "4904" + }, + "properties": [ + { + "$id": "4921", + "kind": "property", + "name": "key", + "serializedName": "key", + "doc": "The key used to provision the Azure AI service resource attached to a skillset.", + "type": { + "$id": "4922", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CognitiveServicesAccountKey.key", + "serializationOptions": { + "$id": "4923", + "json": { + "$id": "4924", + "name": "key" + } + } + }, + { + "$id": "4925", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of Azure AI service resource attached to a\nskillset.", + "type": { + "$id": "4926", + "kind": "constant", + "valueType": { + "$id": "4927", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.CognitiveServicesByKey", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.CognitiveServicesAccountKey.@odata.type", + "serializationOptions": { + "$id": "4928", + "json": { + "$id": "4929", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.AIServicesByKey": { + "$id": "4930", + "kind": "model", + "name": "AIServicesAccountKey", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AIServicesAccountKey", + "usage": "Input,Output,Json", + "doc": "The account key of an Azure AI service resource that's attached to a skillset,\nto be used with the resource's subdomain.", + "discriminatorValue": "#Microsoft.Azure.Search.AIServicesByKey", + "decorators": [], + "baseModel": { + "$ref": "4904" + }, + "properties": [ + { + "$id": "4931", + "kind": "property", + "name": "key", + "serializedName": "key", + "doc": "The key used to provision the Azure AI service resource attached to a skillset.", + "type": { + "$id": "4932", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AIServicesAccountKey.key", + "serializationOptions": { + "$id": "4933", + "json": { + "$id": "4934", + "name": "key" + } + } + }, + { + "$id": "4935", + "kind": "property", + "name": "subdomainUrl", + "serializedName": "subdomainUrl", + "doc": "The subdomain url for the corresponding AI Service.", + "type": { + "$id": "4936", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AIServicesAccountKey.subdomainUrl", + "serializationOptions": { + "$id": "4937", + "json": { + "$id": "4938", + "name": "subdomainUrl" + } + } + }, + { + "$id": "4939", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of Azure AI service resource attached to a\nskillset.", + "type": { + "$id": "4940", + "kind": "constant", + "valueType": { + "$id": "4941", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.AIServicesByKey", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AIServicesAccountKey.@odata.type", + "serializationOptions": { + "$id": "4942", + "json": { + "$id": "4943", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.AIServicesByIdentity": { + "$id": "4944", + "kind": "model", + "name": "AIServicesAccountIdentity", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.AIServicesAccountIdentity", + "usage": "Input,Output,Json", + "doc": "The multi-region account of an Azure AI service resource that's attached to a\nskillset.", + "discriminatorValue": "#Microsoft.Azure.Search.AIServicesByIdentity", + "decorators": [], + "baseModel": { + "$ref": "4904" + }, + "properties": [ + { + "$id": "4945", + "kind": "property", + "name": "identity", + "serializedName": "identity", + "doc": "The user-assigned managed identity used for connections to AI Service. If not\nspecified, the system-assigned managed identity is used. On updates to the\nskillset, if the identity is unspecified, the value remains unchanged. If set\nto \"none\", the value of this property is cleared.", + "type": { + "$ref": "3877" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AIServicesAccountIdentity.identity", + "serializationOptions": { + "$id": "4946", + "json": { + "$id": "4947", + "name": "identity" + } + } + }, + { + "$id": "4948", + "kind": "property", + "name": "subdomainUrl", + "serializedName": "subdomainUrl", + "doc": "The subdomain url for the corresponding AI Service.", + "type": { + "$id": "4949", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AIServicesAccountIdentity.subdomainUrl", + "serializationOptions": { + "$id": "4950", + "json": { + "$id": "4951", + "name": "subdomainUrl" + } + } + }, + { + "$id": "4952", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of Azure AI service resource attached to a\nskillset.", + "type": { + "$id": "4953", + "kind": "constant", + "valueType": { + "$id": "4954", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.AIServicesByIdentity", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.AIServicesAccountIdentity.@odata.type", + "serializationOptions": { + "$id": "4955", + "json": { + "$id": "4956", + "name": "@odata.type" + } + } + } + ] + } + } + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerSkillset.cognitiveServices", + "serializationOptions": { + "$id": "4957", + "json": { + "$id": "4958", + "name": "cognitiveServices" + } + } + }, + { + "$id": "4959", + "kind": "property", + "name": "knowledgeStore", + "serializedName": "knowledgeStore", + "doc": "Definition of additional projections to Azure blob, table, or files, of\nenriched data.", + "type": { + "$id": "4960", + "kind": "model", + "name": "SearchIndexerKnowledgeStore", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStore", + "usage": "Input,Output,Json", + "doc": "Definition of additional projections to azure blob, table, or files, of\nenriched data.", + "decorators": [], + "properties": [ + { + "$id": "4961", + "kind": "property", + "name": "storageConnectionString", + "serializedName": "storageConnectionString", + "doc": "The connection string to the storage account projections will be stored in.", + "type": { + "$id": "4962", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStore.storageConnectionString", + "serializationOptions": { + "$id": "4963", + "json": { + "$id": "4964", + "name": "storageConnectionString" + } + } + }, + { + "$id": "4965", + "kind": "property", + "name": "projections", + "serializedName": "projections", + "doc": "A list of additional projections to perform during indexing.", + "type": { + "$id": "4966", + "kind": "array", + "name": "ArraySearchIndexerKnowledgeStoreProjection", + "valueType": { + "$id": "4967", + "kind": "model", + "name": "SearchIndexerKnowledgeStoreProjection", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreProjection", + "usage": "Input,Output,Json", + "doc": "Container object for various projection selectors.", + "decorators": [], + "properties": [ + { + "$id": "4968", + "kind": "property", + "name": "tables", + "serializedName": "tables", + "doc": "Projections to Azure Table storage.", + "type": { + "$id": "4969", + "kind": "array", + "name": "ArraySearchIndexerKnowledgeStoreTableProjectionSelector", + "valueType": { + "$id": "4970", + "kind": "model", + "name": "SearchIndexerKnowledgeStoreTableProjectionSelector", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreTableProjectionSelector", + "usage": "Input,Output,Json", + "doc": "Description for what data to store in Azure Tables.", + "decorators": [], + "baseModel": { + "$id": "4971", + "kind": "model", + "name": "SearchIndexerKnowledgeStoreProjectionSelector", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreProjectionSelector", + "usage": "Input,Output,Json", + "doc": "Abstract class to share properties between concrete selectors.", + "decorators": [], + "properties": [ + { + "$id": "4972", + "kind": "property", + "name": "referenceKeyName", + "serializedName": "referenceKeyName", + "doc": "Name of reference key to different projection.", + "type": { + "$id": "4973", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreProjectionSelector.referenceKeyName", + "serializationOptions": { + "$id": "4974", + "json": { + "$id": "4975", + "name": "referenceKeyName" + } + } + }, + { + "$id": "4976", + "kind": "property", + "name": "generatedKeyName", + "serializedName": "generatedKeyName", + "doc": "Name of generated key to store projection under.", + "type": { + "$id": "4977", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreProjectionSelector.generatedKeyName", + "serializationOptions": { + "$id": "4978", + "json": { + "$id": "4979", + "name": "generatedKeyName" + } + } + }, + { + "$id": "4980", + "kind": "property", + "name": "source", + "serializedName": "source", + "doc": "Source data to project.", + "type": { + "$id": "4981", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreProjectionSelector.source", + "serializationOptions": { + "$id": "4982", + "json": { + "$id": "4983", + "name": "source" + } + } + }, + { + "$id": "4984", + "kind": "property", + "name": "sourceContext", + "serializedName": "sourceContext", + "doc": "Source context for complex projections.", + "type": { + "$id": "4985", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreProjectionSelector.sourceContext", + "serializationOptions": { + "$id": "4986", + "json": { + "$id": "4987", + "name": "sourceContext" + } + } + }, + { + "$id": "4988", + "kind": "property", + "name": "inputs", + "serializedName": "inputs", + "doc": "Nested inputs for complex projections.", + "type": { + "$id": "4989", + "kind": "array", + "name": "ArrayInputFieldMappingEntry", + "valueType": { + "$ref": "4365" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreProjectionSelector.inputs", + "serializationOptions": { + "$id": "4990", + "json": { + "$id": "4991", + "name": "inputs" + } + } + } + ] + }, + "properties": [ + { + "$id": "4992", + "kind": "property", + "name": "tableName", + "serializedName": "tableName", + "doc": "Name of the Azure table to store projected data in.", + "type": { + "$id": "4993", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreTableProjectionSelector.tableName", + "serializationOptions": { + "$id": "4994", + "json": { + "$id": "4995", + "name": "tableName" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreProjection.tables", + "serializationOptions": { + "$id": "4996", + "json": { + "$id": "4997", + "name": "tables" + } + } + }, + { + "$id": "4998", + "kind": "property", + "name": "objects", + "serializedName": "objects", + "doc": "Projections to Azure Blob storage.", + "type": { + "$id": "4999", + "kind": "array", + "name": "ArraySearchIndexerKnowledgeStoreObjectProjectionSelector", + "valueType": { + "$id": "5000", + "kind": "model", + "name": "SearchIndexerKnowledgeStoreObjectProjectionSelector", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreObjectProjectionSelector", + "usage": "Input,Output,Json", + "doc": "Projection definition for what data to store in Azure Blob.", + "decorators": [], + "baseModel": { + "$id": "5001", + "kind": "model", + "name": "SearchIndexerKnowledgeStoreBlobProjectionSelector", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreBlobProjectionSelector", + "usage": "Input,Output,Json", + "doc": "Abstract class to share properties between concrete selectors.", + "decorators": [], + "baseModel": { + "$ref": "4971" + }, + "properties": [ + { + "$id": "5002", + "kind": "property", + "name": "storageContainer", + "serializedName": "storageContainer", + "doc": "Blob container to store projections in.", + "type": { + "$id": "5003", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreBlobProjectionSelector.storageContainer", + "serializationOptions": { + "$id": "5004", + "json": { + "$id": "5005", + "name": "storageContainer" + } + } + } + ] + }, + "properties": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreProjection.objects", + "serializationOptions": { + "$id": "5006", + "json": { + "$id": "5007", + "name": "objects" + } + } + }, + { + "$id": "5008", + "kind": "property", + "name": "files", + "serializedName": "files", + "doc": "Projections to Azure File storage.", + "type": { + "$id": "5009", + "kind": "array", + "name": "ArraySearchIndexerKnowledgeStoreFileProjectionSelector", + "valueType": { + "$id": "5010", + "kind": "model", + "name": "SearchIndexerKnowledgeStoreFileProjectionSelector", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreFileProjectionSelector", + "usage": "Input,Output,Json", + "doc": "Projection definition for what data to store in Azure Files.", + "decorators": [], + "baseModel": { + "$ref": "5001" + }, + "properties": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreProjection.files", + "serializationOptions": { + "$id": "5011", + "json": { + "$id": "5012", + "name": "files" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStore.projections", + "serializationOptions": { + "$id": "5013", + "json": { + "$id": "5014", + "name": "projections" + } + } + }, + { + "$id": "5015", + "kind": "property", + "name": "identity", + "serializedName": "identity", + "doc": "The user-assigned managed identity used for connections to Azure Storage when\nwriting knowledge store projections. If the connection string indicates an\nidentity (ResourceId) and it's not specified, the system-assigned managed\nidentity is used. On updates to the indexer, if the identity is unspecified,\nthe value remains unchanged. If set to \"none\", the value of this property is\ncleared.", + "type": { + "$ref": "3877" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStore.identity", + "serializationOptions": { + "$id": "5016", + "json": { + "$id": "5017", + "name": "identity" + } + } + }, + { + "$id": "5018", + "kind": "property", + "name": "parameters", + "serializedName": "parameters", + "doc": "A dictionary of knowledge store-specific configuration properties. Each name is\nthe name of a specific property. Each value must be of a primitive type.", + "type": { + "$id": "5019", + "kind": "model", + "name": "SearchIndexerKnowledgeStoreParameters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreParameters", + "usage": "Input,Output,Json", + "doc": "A dictionary of knowledge store-specific configuration properties. Each name is\nthe name of a specific property. Each value must be of a primitive type.", + "decorators": [], + "additionalProperties": { + "$id": "5020", + "kind": "unknown", + "name": "unknown", + "crossLanguageDefinitionId": "", + "decorators": [] + }, + "properties": [ + { + "$id": "5021", + "kind": "property", + "name": "synthesizeGeneratedKeyName", + "serializedName": "synthesizeGeneratedKeyName", + "doc": "Whether or not projections should synthesize a generated key name if one isn't\nalready present.", + "type": { + "$id": "5022", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStoreParameters.synthesizeGeneratedKeyName", + "serializationOptions": { + "$id": "5023", + "json": { + "$id": "5024", + "name": "synthesizeGeneratedKeyName" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerKnowledgeStore.parameters", + "serializationOptions": { + "$id": "5025", + "json": { + "$id": "5026", + "name": "parameters" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerSkillset.knowledgeStore", + "serializationOptions": { + "$id": "5027", + "json": { + "$id": "5028", + "name": "knowledgeStore" + } + } + }, + { + "$id": "5029", + "kind": "property", + "name": "indexProjection", + "serializedName": "indexProjections", + "doc": "Definition of additional projections to secondary search index(es).", + "type": { + "$id": "5030", + "kind": "model", + "name": "SearchIndexerIndexProjection", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerIndexProjection", + "usage": "Input,Output,Json", + "doc": "Definition of additional projections to secondary search indexes.", + "decorators": [], + "properties": [ + { + "$id": "5031", + "kind": "property", + "name": "selectors", + "serializedName": "selectors", + "doc": "A list of projections to be performed to secondary search indexes.", + "type": { + "$id": "5032", + "kind": "array", + "name": "ArraySearchIndexerIndexProjectionSelector", + "valueType": { + "$id": "5033", + "kind": "model", + "name": "SearchIndexerIndexProjectionSelector", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerIndexProjectionSelector", + "usage": "Input,Output,Json", + "doc": "Description for what data to store in the designated search index.", + "decorators": [], + "properties": [ + { + "$id": "5034", + "kind": "property", + "name": "targetIndexName", + "serializedName": "targetIndexName", + "doc": "Name of the search index to project to. Must have a key field with the 'keyword' analyzer set.", + "type": { + "$id": "5035", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerIndexProjectionSelector.targetIndexName", + "serializationOptions": { + "$id": "5036", + "json": { + "$id": "5037", + "name": "targetIndexName" + } + } + }, + { + "$id": "5038", + "kind": "property", + "name": "parentKeyFieldName", + "serializedName": "parentKeyFieldName", + "doc": "Name of the field in the search index to map the parent document's key value\nto. Must be a string field that is filterable and not the key field.", + "type": { + "$id": "5039", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerIndexProjectionSelector.parentKeyFieldName", + "serializationOptions": { + "$id": "5040", + "json": { + "$id": "5041", + "name": "parentKeyFieldName" + } + } + }, + { + "$id": "5042", + "kind": "property", + "name": "sourceContext", + "serializedName": "sourceContext", + "doc": "Source context for the projections. Represents the cardinality at which the\ndocument will be split into multiple sub documents.", + "type": { + "$id": "5043", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerIndexProjectionSelector.sourceContext", + "serializationOptions": { + "$id": "5044", + "json": { + "$id": "5045", + "name": "sourceContext" + } + } + }, + { + "$id": "5046", + "kind": "property", + "name": "mappings", + "serializedName": "mappings", + "doc": "Mappings for the projection, or which source should be mapped to which field in\nthe target index.", + "type": { + "$id": "5047", + "kind": "array", + "name": "ArrayInputFieldMappingEntry", + "valueType": { + "$ref": "4365" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerIndexProjectionSelector.mappings", + "serializationOptions": { + "$id": "5048", + "json": { + "$id": "5049", + "name": "mappings" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerIndexProjection.selectors", + "serializationOptions": { + "$id": "5050", + "json": { + "$id": "5051", + "name": "selectors" + } + } + }, + { + "$id": "5052", + "kind": "property", + "name": "parameters", + "serializedName": "parameters", + "doc": "A dictionary of index projection-specific configuration properties. Each name\nis the name of a specific property. Each value must be of a primitive type.", + "type": { + "$id": "5053", + "kind": "model", + "name": "SearchIndexerIndexProjectionsParameters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerIndexProjectionsParameters", + "usage": "Input,Output,Json", + "doc": "A dictionary of index projection-specific configuration properties. Each name\nis the name of a specific property. Each value must be of a primitive type.", + "decorators": [], + "additionalProperties": { + "$id": "5054", + "kind": "unknown", + "name": "unknown", + "crossLanguageDefinitionId": "", + "decorators": [] + }, + "properties": [ + { + "$id": "5055", + "kind": "property", + "name": "projectionMode", + "serializedName": "projectionMode", + "doc": "Defines behavior of the index projections in relation to the rest of the\nindexer.", + "type": { + "$ref": "2066" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerIndexProjectionsParameters.projectionMode", + "serializationOptions": { + "$id": "5056", + "json": { + "$id": "5057", + "name": "projectionMode" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerIndexProjection.parameters", + "serializationOptions": { + "$id": "5058", + "json": { + "$id": "5059", + "name": "parameters" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerSkillset.indexProjections", + "serializationOptions": { + "$id": "5060", + "json": { + "$id": "5061", + "name": "indexProjections" + } + } + }, + { + "$id": "5062", + "kind": "property", + "name": "eTag", + "serializedName": "@odata.etag", + "doc": "The ETag of the skillset.", + "type": { + "$id": "5063", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerSkillset.eTag", + "serializationOptions": { + "$id": "5064", + "json": { + "$id": "5065", + "name": "@odata.etag" + } + } + }, + { + "$id": "5066", + "kind": "property", + "name": "encryptionKey", + "serializedName": "encryptionKey", + "doc": "A description of an encryption key that you create in Azure Key Vault. This key\nis used to provide an additional level of encryption-at-rest for your skillset\ndefinition when you want full assurance that no one, not even Microsoft, can\ndecrypt your skillset definition. Once you have encrypted your skillset\ndefinition, it will always remain encrypted. The search service will ignore\nattempts to set this property to null. You can change this property as needed\nif you want to rotate your encryption key; Your skillset definition will be\nunaffected. Encryption with customer-managed keys is not available for free\nsearch services, and is only available for paid services created on or after\nJanuary 1, 2019.", + "type": { + "$ref": "3851" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerSkillset.encryptionKey", + "serializationOptions": { + "$id": "5067", + "json": { + "$id": "5068", + "name": "encryptionKey" + } + } + } + ] + }, + { + "$ref": "4346" + }, + { + "$ref": "4365" + }, + { + "$ref": "4386" + }, + { + "$ref": "4398" + }, + { + "$ref": "4404" + }, + { + "$ref": "4421" + }, + { + "$ref": "4437" + }, + { + "$ref": "4454" + }, + { + "$ref": "4468" + }, + { + "$ref": "4474" + }, + { + "$ref": "4488" + }, + { + "$ref": "4509" + }, + { + "$ref": "4518" + }, + { + "$ref": "4536" + }, + { + "$ref": "4554" + }, + { + "$ref": "4577" + }, + { + "$ref": "4611" + }, + { + "$ref": "4634" + }, + { + "$ref": "4650" + }, + { + "$ref": "4660" + }, + { + "$ref": "4707" + }, + { + "$ref": "4745" + }, + { + "$ref": "4760" + }, + { + "$ref": "4780" + }, + { + "$ref": "4792" + }, + { + "$ref": "4832" + }, + { + "$ref": "4863" + }, + { + "$ref": "4891" + }, + { + "$ref": "4904" + }, + { + "$ref": "4914" + }, + { + "$ref": "4920" + }, + { + "$ref": "4930" + }, + { + "$ref": "4944" + }, + { + "$ref": "4960" + }, + { + "$ref": "4967" + }, + { + "$ref": "4970" + }, + { + "$ref": "4971" + }, + { + "$ref": "5000" + }, + { + "$ref": "5001" + }, + { + "$ref": "5010" + }, + { + "$ref": "5019" + }, + { + "$ref": "5030" + }, + { + "$ref": "5033" + }, + { + "$ref": "5053" + }, + { + "$id": "5069", + "kind": "model", + "name": "ListSkillsetsResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ListSkillsetsResult", + "usage": "Output,Json", + "doc": "Response from a list skillset request. If successful, it includes the full\ndefinitions of all skillsets.", + "decorators": [], + "properties": [ + { + "$id": "5070", + "kind": "property", + "name": "skillsets", + "serializedName": "value", + "doc": "The skillsets defined in the Search service.", + "type": { + "$id": "5071", + "kind": "array", + "name": "ArraySearchIndexerSkillset", + "valueType": { + "$ref": "4335" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ListSkillsetsResult.value", + "serializationOptions": { + "$id": "5072", + "json": { + "$id": "5073", + "name": "value" + } + } + } + ] + }, + { + "$id": "5074", + "kind": "model", + "name": "SkillNames", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SkillNames", + "usage": "Input,Json", + "doc": "The type of the skill names.", + "decorators": [], + "properties": [ + { + "$id": "5075", + "kind": "property", + "name": "skillNameList", + "serializedName": "skillNames", + "doc": "the names of skills to be reset.", + "type": { + "$id": "5076", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "5077", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SkillNames.skillNames", + "serializationOptions": { + "$id": "5078", + "json": { + "$id": "5079", + "name": "skillNames" + } + } + } + ] + }, + { + "$id": "5080", + "kind": "model", + "name": "DocumentKeysOrIds", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.DocumentKeysOrIds", + "usage": "Input,Json", + "doc": "The type of the keysOrIds.", + "decorators": [], + "properties": [ + { + "$id": "5081", + "kind": "property", + "name": "documentKeys", + "serializedName": "documentKeys", + "doc": "document keys to be reset", + "type": { + "$id": "5082", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "5083", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DocumentKeysOrIds.documentKeys", + "serializationOptions": { + "$id": "5084", + "json": { + "$id": "5085", + "name": "documentKeys" + } + } + }, + { + "$id": "5086", + "kind": "property", + "name": "datasourceDocumentIds", + "serializedName": "datasourceDocumentIds", + "doc": "datasource document identifiers to be reset", + "type": { + "$id": "5087", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "5088", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DocumentKeysOrIds.datasourceDocumentIds", + "serializationOptions": { + "$id": "5089", + "json": { + "$id": "5090", + "name": "datasourceDocumentIds" + } + } + } + ] + }, + { + "$id": "5091", + "kind": "model", + "name": "SearchIndexer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexer", + "usage": "Input,Output,Json", + "doc": "Represents an indexer.", + "decorators": [], + "properties": [ + { + "$id": "5092", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the indexer.", + "type": { + "$id": "5093", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexer.name", + "serializationOptions": { + "$id": "5094", + "json": { + "$id": "5095", + "name": "name" + } + } + }, + { + "$id": "5096", + "kind": "property", + "name": "description", + "serializedName": "description", + "doc": "The description of the indexer.", + "type": { + "$id": "5097", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexer.description", + "serializationOptions": { + "$id": "5098", + "json": { + "$id": "5099", + "name": "description" + } + } + }, + { + "$id": "5100", + "kind": "property", + "name": "dataSourceName", + "serializedName": "dataSourceName", + "doc": "The name of the datasource from which this indexer reads data.", + "type": { + "$id": "5101", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexer.dataSourceName", + "serializationOptions": { + "$id": "5102", + "json": { + "$id": "5103", + "name": "dataSourceName" + } + } + }, + { + "$id": "5104", + "kind": "property", + "name": "skillsetName", + "serializedName": "skillsetName", + "doc": "The name of the skillset executing with this indexer.", + "type": { + "$id": "5105", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexer.skillsetName", + "serializationOptions": { + "$id": "5106", + "json": { + "$id": "5107", + "name": "skillsetName" + } + } + }, + { + "$id": "5108", + "kind": "property", + "name": "targetIndexName", + "serializedName": "targetIndexName", + "doc": "The name of the index to which this indexer writes data.", + "type": { + "$id": "5109", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexer.targetIndexName", + "serializationOptions": { + "$id": "5110", + "json": { + "$id": "5111", + "name": "targetIndexName" + } + } + }, + { + "$id": "5112", + "kind": "property", + "name": "schedule", + "serializedName": "schedule", + "doc": "The schedule for this indexer.", + "type": { + "$id": "5113", + "kind": "model", + "name": "IndexingSchedule", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.IndexingSchedule", + "usage": "Input,Output,Json", + "doc": "Represents a schedule for indexer execution.", + "decorators": [], + "properties": [ + { + "$id": "5114", + "kind": "property", + "name": "interval", + "serializedName": "interval", + "doc": "The interval of time between indexer executions.", + "type": { + "$id": "5115", + "kind": "duration", + "name": "duration", + "encode": "ISO8601", + "wireType": { + "$id": "5116", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.duration", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingSchedule.interval", + "serializationOptions": { + "$id": "5117", + "json": { + "$id": "5118", + "name": "interval" + } + } + }, + { + "$id": "5119", + "kind": "property", + "name": "startTime", + "serializedName": "startTime", + "doc": "The time when an indexer should start running.", + "type": { + "$id": "5120", + "kind": "utcDateTime", + "name": "utcDateTime", + "encode": "rfc3339", + "wireType": { + "$id": "5121", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.utcDateTime", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingSchedule.startTime", + "serializationOptions": { + "$id": "5122", + "json": { + "$id": "5123", + "name": "startTime" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexer.schedule", + "serializationOptions": { + "$id": "5124", + "json": { + "$id": "5125", + "name": "schedule" + } + } + }, + { + "$id": "5126", + "kind": "property", + "name": "parameters", + "serializedName": "parameters", + "doc": "Parameters for indexer execution.", + "type": { + "$id": "5127", + "kind": "model", + "name": "IndexingParameters", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.IndexingParameters", + "usage": "Input,Output,Json", + "doc": "Represents parameters for indexer execution.", + "decorators": [], + "properties": [ + { + "$id": "5128", + "kind": "property", + "name": "batchSize", + "serializedName": "batchSize", + "doc": "The number of items that are read from the data source and indexed as a single\nbatch in order to improve performance. The default depends on the data source\ntype.", + "type": { + "$id": "5129", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParameters.batchSize", + "serializationOptions": { + "$id": "5130", + "json": { + "$id": "5131", + "name": "batchSize" + } + } + }, + { + "$id": "5132", + "kind": "property", + "name": "maxFailedItems", + "serializedName": "maxFailedItems", + "doc": "The maximum number of items that can fail indexing for indexer execution to\nstill be considered successful. -1 means no limit. Default is 0.", + "type": { + "$id": "5133", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParameters.maxFailedItems", + "serializationOptions": { + "$id": "5134", + "json": { + "$id": "5135", + "name": "maxFailedItems" + } + } + }, + { + "$id": "5136", + "kind": "property", + "name": "maxFailedItemsPerBatch", + "serializedName": "maxFailedItemsPerBatch", + "doc": "The maximum number of items in a single batch that can fail indexing for the\nbatch to still be considered successful. -1 means no limit. Default is 0.", + "type": { + "$id": "5137", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParameters.maxFailedItemsPerBatch", + "serializationOptions": { + "$id": "5138", + "json": { + "$id": "5139", + "name": "maxFailedItemsPerBatch" + } + } + }, + { + "$id": "5140", + "kind": "property", + "name": "configuration", + "serializedName": "configuration", + "doc": "A dictionary of indexer-specific configuration properties. Each name is the\nname of a specific property. Each value must be of a primitive type.", + "type": { + "$id": "5141", + "kind": "model", + "name": "IndexingParametersConfiguration", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration", + "usage": "Input,Output,Json", + "doc": "A dictionary of indexer-specific configuration properties. Each name is the\nname of a specific property. Each value must be of a primitive type.", + "decorators": [], + "additionalProperties": { + "$id": "5142", + "kind": "unknown", + "name": "unknown", + "crossLanguageDefinitionId": "", + "decorators": [] + }, + "properties": [ + { + "$id": "5143", + "kind": "property", + "name": "parsingMode", + "serializedName": "parsingMode", + "doc": "Represents the parsing mode for indexing from an Azure blob data source.", + "type": { + "$ref": "2072" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.parsingMode", + "serializationOptions": { + "$id": "5144", + "json": { + "$id": "5145", + "name": "parsingMode" + } + } + }, + { + "$id": "5146", + "kind": "property", + "name": "excludedFileNameExtensions", + "serializedName": "excludedFileNameExtensions", + "doc": "Comma-delimited list of filename extensions to ignore when processing from\nAzure blob storage. For example, you could exclude \".png, .mp4\" to skip over\nthose files during indexing.", + "type": { + "$id": "5147", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.excludedFileNameExtensions", + "serializationOptions": { + "$id": "5148", + "json": { + "$id": "5149", + "name": "excludedFileNameExtensions" + } + } + }, + { + "$id": "5150", + "kind": "property", + "name": "indexedFileNameExtensions", + "serializedName": "indexedFileNameExtensions", + "doc": "Comma-delimited list of filename extensions to select when processing from\nAzure blob storage. For example, you could focus indexing on specific\napplication files \".docx, .pptx, .msg\" to specifically include those file\ntypes.", + "type": { + "$id": "5151", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.indexedFileNameExtensions", + "serializationOptions": { + "$id": "5152", + "json": { + "$id": "5153", + "name": "indexedFileNameExtensions" + } + } + }, + { + "$id": "5154", + "kind": "property", + "name": "failOnUnsupportedContentType", + "serializedName": "failOnUnsupportedContentType", + "doc": "For Azure blobs, set to false if you want to continue indexing when an\nunsupported content type is encountered, and you don't know all the content\ntypes (file extensions) in advance.", + "type": { + "$id": "5155", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.failOnUnsupportedContentType", + "serializationOptions": { + "$id": "5156", + "json": { + "$id": "5157", + "name": "failOnUnsupportedContentType" + } + } + }, + { + "$id": "5158", + "kind": "property", + "name": "failOnUnprocessableDocument", + "serializedName": "failOnUnprocessableDocument", + "doc": "For Azure blobs, set to false if you want to continue indexing if a document\nfails indexing.", + "type": { + "$id": "5159", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.failOnUnprocessableDocument", + "serializationOptions": { + "$id": "5160", + "json": { + "$id": "5161", + "name": "failOnUnprocessableDocument" + } + } + }, + { + "$id": "5162", + "kind": "property", + "name": "indexStorageMetadataOnlyForOversizedDocuments", + "serializedName": "indexStorageMetadataOnlyForOversizedDocuments", + "doc": "For Azure blobs, set this property to true to still index storage metadata for\nblob content that is too large to process. Oversized blobs are treated as\nerrors by default. For limits on blob size, see\nhttps://learn.microsoft.com/azure/search/search-limits-quotas-capacity.", + "type": { + "$id": "5163", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.indexStorageMetadataOnlyForOversizedDocuments", + "serializationOptions": { + "$id": "5164", + "json": { + "$id": "5165", + "name": "indexStorageMetadataOnlyForOversizedDocuments" + } + } + }, + { + "$id": "5166", + "kind": "property", + "name": "delimitedTextHeaders", + "serializedName": "delimitedTextHeaders", + "doc": "For CSV blobs, specifies a comma-delimited list of column headers, useful for\nmapping source fields to destination fields in an index.", + "type": { + "$id": "5167", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.delimitedTextHeaders", + "serializationOptions": { + "$id": "5168", + "json": { + "$id": "5169", + "name": "delimitedTextHeaders" + } + } + }, + { + "$id": "5170", + "kind": "property", + "name": "delimitedTextDelimiter", + "serializedName": "delimitedTextDelimiter", + "doc": "For CSV blobs, specifies the end-of-line single-character delimiter for CSV\nfiles where each line starts a new document (for example, \"|\").", + "type": { + "$id": "5171", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.delimitedTextDelimiter", + "serializationOptions": { + "$id": "5172", + "json": { + "$id": "5173", + "name": "delimitedTextDelimiter" + } + } + }, + { + "$id": "5174", + "kind": "property", + "name": "firstLineContainsHeaders", + "serializedName": "firstLineContainsHeaders", + "doc": "For CSV blobs, indicates that the first (non-blank) line of each blob contains\nheaders.", + "type": { + "$id": "5175", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.firstLineContainsHeaders", + "serializationOptions": { + "$id": "5176", + "json": { + "$id": "5177", + "name": "firstLineContainsHeaders" + } + } + }, + { + "$id": "5178", + "kind": "property", + "name": "markdownParsingSubmode", + "serializedName": "markdownParsingSubmode", + "doc": "Specifies the submode that will determine whether a markdown file will be\nparsed into exactly one search document or multiple search documents. Default\nis `oneToMany`.", + "type": { + "$ref": "2088" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.markdownParsingSubmode", + "serializationOptions": { + "$id": "5179", + "json": { + "$id": "5180", + "name": "markdownParsingSubmode" + } + } + }, + { + "$id": "5181", + "kind": "property", + "name": "markdownHeaderDepth", + "serializedName": "markdownHeaderDepth", + "doc": "Specifies the max header depth that will be considered while grouping markdown\ncontent. Default is `h6`.", + "type": { + "$ref": "2094" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.markdownHeaderDepth", + "serializationOptions": { + "$id": "5182", + "json": { + "$id": "5183", + "name": "markdownHeaderDepth" + } + } + }, + { + "$id": "5184", + "kind": "property", + "name": "documentRoot", + "serializedName": "documentRoot", + "doc": "For JSON arrays, given a structured or semi-structured document, you can\nspecify a path to the array using this property.", + "type": { + "$id": "5185", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.documentRoot", + "serializationOptions": { + "$id": "5186", + "json": { + "$id": "5187", + "name": "documentRoot" + } + } + }, + { + "$id": "5188", + "kind": "property", + "name": "dataToExtract", + "serializedName": "dataToExtract", + "doc": "Specifies the data to extract from Azure blob storage and tells the indexer\nwhich data to extract from image content when \"imageAction\" is set to a value\nother than \"none\". This applies to embedded image content in a .PDF or other\napplication, or image files such as .jpg and .png, in Azure blobs.", + "type": { + "$ref": "2108" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.dataToExtract", + "serializationOptions": { + "$id": "5189", + "json": { + "$id": "5190", + "name": "dataToExtract" + } + } + }, + { + "$id": "5191", + "kind": "property", + "name": "imageAction", + "serializedName": "imageAction", + "doc": "Determines how to process embedded images and image files in Azure blob\nstorage. Setting the \"imageAction\" configuration to any value other than\n\"none\" requires that a skillset also be attached to that indexer.", + "type": { + "$ref": "2116" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.imageAction", + "serializationOptions": { + "$id": "5192", + "json": { + "$id": "5193", + "name": "imageAction" + } + } + }, + { + "$id": "5194", + "kind": "property", + "name": "allowSkillsetToReadFileData", + "serializedName": "allowSkillsetToReadFileData", + "doc": "If true, will create a path //document//file_data that is an object\nrepresenting the original file data downloaded from your blob data source.\nThis allows you to pass the original file data to a custom skill for processing\nwithin the enrichment pipeline, or to the Document Extraction skill.", + "type": { + "$id": "5195", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.allowSkillsetToReadFileData", + "serializationOptions": { + "$id": "5196", + "json": { + "$id": "5197", + "name": "allowSkillsetToReadFileData" + } + } + }, + { + "$id": "5198", + "kind": "property", + "name": "pdfTextRotationAlgorithm", + "serializedName": "pdfTextRotationAlgorithm", + "doc": "Determines algorithm for text extraction from PDF files in Azure blob storage.", + "type": { + "$ref": "2124" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.pdfTextRotationAlgorithm", + "serializationOptions": { + "$id": "5199", + "json": { + "$id": "5200", + "name": "pdfTextRotationAlgorithm" + } + } + }, + { + "$id": "5201", + "kind": "property", + "name": "executionEnvironment", + "serializedName": "executionEnvironment", + "doc": "Specifies the environment in which the indexer should execute.", + "type": { + "$ref": "2130" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.executionEnvironment", + "serializationOptions": { + "$id": "5202", + "json": { + "$id": "5203", + "name": "executionEnvironment" + } + } + }, + { + "$id": "5204", + "kind": "property", + "name": "queryTimeout", + "serializedName": "queryTimeout", + "doc": "Increases the timeout beyond the 5-minute default for Azure SQL database data\nsources, specified in the format \"hh:mm:ss\".", + "type": { + "$id": "5205", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParametersConfiguration.queryTimeout", + "serializationOptions": { + "$id": "5206", + "json": { + "$id": "5207", + "name": "queryTimeout" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexingParameters.configuration", + "serializationOptions": { + "$id": "5208", + "json": { + "$id": "5209", + "name": "configuration" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexer.parameters", + "serializationOptions": { + "$id": "5210", + "json": { + "$id": "5211", + "name": "parameters" + } + } + }, + { + "$id": "5212", + "kind": "property", + "name": "fieldMappings", + "serializedName": "fieldMappings", + "doc": "Defines mappings between fields in the data source and corresponding target\nfields in the index.", + "type": { + "$id": "5213", + "kind": "array", + "name": "ArrayFieldMapping", + "valueType": { + "$id": "5214", + "kind": "model", + "name": "FieldMapping", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.FieldMapping", + "usage": "Input,Output,Json", + "doc": "Defines a mapping between a field in a data source and a target field in an\nindex.", + "decorators": [], + "properties": [ + { + "$id": "5215", + "kind": "property", + "name": "sourceFieldName", + "serializedName": "sourceFieldName", + "doc": "The name of the field in the data source.", + "type": { + "$id": "5216", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.FieldMapping.sourceFieldName", + "serializationOptions": { + "$id": "5217", + "json": { + "$id": "5218", + "name": "sourceFieldName" + } + } + }, + { + "$id": "5219", + "kind": "property", + "name": "targetFieldName", + "serializedName": "targetFieldName", + "doc": "The name of the target field in the index. Same as the source field name by\ndefault.", + "type": { + "$id": "5220", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.FieldMapping.targetFieldName", + "serializationOptions": { + "$id": "5221", + "json": { + "$id": "5222", + "name": "targetFieldName" + } + } + }, + { + "$id": "5223", + "kind": "property", + "name": "mappingFunction", + "serializedName": "mappingFunction", + "doc": "A function to apply to each source field value before indexing.", + "type": { + "$id": "5224", + "kind": "model", + "name": "FieldMappingFunction", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.FieldMappingFunction", + "usage": "Input,Output,Json", + "doc": "Represents a function that transforms a value from a data source before\nindexing.", + "decorators": [], + "properties": [ + { + "$id": "5225", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the field mapping function.", + "type": { + "$id": "5226", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.FieldMappingFunction.name", + "serializationOptions": { + "$id": "5227", + "json": { + "$id": "5228", + "name": "name" + } + } + }, + { + "$id": "5229", + "kind": "property", + "name": "parameters", + "serializedName": "parameters", + "doc": "A dictionary of parameter name/value pairs to pass to the function. Each value\nmust be of a primitive type.", + "type": { + "$id": "5230", + "kind": "dict", + "keyType": { + "$id": "5231", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "valueType": { + "$id": "5232", + "kind": "unknown", + "name": "unknown", + "crossLanguageDefinitionId": "", + "decorators": [] + }, + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.FieldMappingFunction.parameters", + "serializationOptions": { + "$id": "5233", + "json": { + "$id": "5234", + "name": "parameters" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.FieldMapping.mappingFunction", + "serializationOptions": { + "$id": "5235", + "json": { + "$id": "5236", + "name": "mappingFunction" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexer.fieldMappings", + "serializationOptions": { + "$id": "5237", + "json": { + "$id": "5238", + "name": "fieldMappings" + } + } + }, + { + "$id": "5239", + "kind": "property", + "name": "outputFieldMappings", + "serializedName": "outputFieldMappings", + "doc": "Output field mappings are applied after enrichment and immediately before\nindexing.", + "type": { + "$id": "5240", + "kind": "array", + "name": "ArrayFieldMapping", + "valueType": { + "$ref": "5214" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexer.outputFieldMappings", + "serializationOptions": { + "$id": "5241", + "json": { + "$id": "5242", + "name": "outputFieldMappings" + } + } + }, + { + "$id": "5243", + "kind": "property", + "name": "isDisabled", + "serializedName": "disabled", + "doc": "A value indicating whether the indexer is disabled. Default is false.", + "type": { + "$id": "5244", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexer.disabled", + "serializationOptions": { + "$id": "5245", + "json": { + "$id": "5246", + "name": "disabled" + } + } + }, + { + "$id": "5247", + "kind": "property", + "name": "eTag", + "serializedName": "@odata.etag", + "doc": "The ETag of the indexer.", + "type": { + "$id": "5248", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexer.eTag", + "serializationOptions": { + "$id": "5249", + "json": { + "$id": "5250", + "name": "@odata.etag" + } + } + }, + { + "$id": "5251", + "kind": "property", + "name": "encryptionKey", + "serializedName": "encryptionKey", + "doc": "A description of an encryption key that you create in Azure Key Vault. This key\nis used to provide an additional level of encryption-at-rest for your indexer\ndefinition (as well as indexer execution status) when you want full assurance\nthat no one, not even Microsoft, can decrypt them. Once you have encrypted your\nindexer definition, it will always remain encrypted. The search service will\nignore attempts to set this property to null. You can change this property as\nneeded if you want to rotate your encryption key; Your indexer definition (and\nindexer execution status) will be unaffected. Encryption with customer-managed\nkeys is not available for free search services, and is only available for paid\nservices created on or after January 1, 2019.", + "type": { + "$ref": "3851" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexer.encryptionKey", + "serializationOptions": { + "$id": "5252", + "json": { + "$id": "5253", + "name": "encryptionKey" + } + } + }, + { + "$id": "5254", + "kind": "property", + "name": "cache", + "serializedName": "cache", + "doc": "Adds caching to an enrichment pipeline to allow for incremental modification\nsteps without having to rebuild the index every time.", + "type": { + "$id": "5255", + "kind": "model", + "name": "SearchIndexerCache", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerCache", + "usage": "Input,Output,Json", + "doc": "The type of the cache.", + "decorators": [], + "properties": [ + { + "$id": "5256", + "kind": "property", + "name": "storageConnectionString", + "serializedName": "storageConnectionString", + "doc": "The connection string to the storage account where the cache data will be\npersisted.", + "type": { + "$id": "5257", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerCache.storageConnectionString", + "serializationOptions": { + "$id": "5258", + "json": { + "$id": "5259", + "name": "storageConnectionString" + } + } + }, + { + "$id": "5260", + "kind": "property", + "name": "enableReprocessing", + "serializedName": "enableReprocessing", + "doc": "Specifies whether incremental reprocessing is enabled.", + "type": { + "$id": "5261", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerCache.enableReprocessing", + "serializationOptions": { + "$id": "5262", + "json": { + "$id": "5263", + "name": "enableReprocessing" + } + } + }, + { + "$id": "5264", + "kind": "property", + "name": "identity", + "serializedName": "identity", + "doc": "The user-assigned managed identity used for connections to the enrichment\ncache. If the connection string indicates an identity (ResourceId) and it's\nnot specified, the system-assigned managed identity is used. On updates to the\nindexer, if the identity is unspecified, the value remains unchanged. If set to\n\"none\", the value of this property is cleared.", + "type": { + "$ref": "3877" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerCache.identity", + "serializationOptions": { + "$id": "5265", + "json": { + "$id": "5266", + "name": "identity" + } + } + }, + { + "$id": "5267", + "kind": "property", + "name": "id", + "serializedName": "id", + "doc": "A guid for the SearchIndexerCache.", + "type": { + "$id": "5268", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerCache.id", + "serializationOptions": { + "$id": "5269", + "json": { + "$id": "5270", + "name": "id" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexer.cache", + "serializationOptions": { + "$id": "5271", + "json": { + "$id": "5272", + "name": "cache" + } + } + } + ] + }, + { + "$ref": "5113" + }, + { + "$ref": "5127" + }, + { + "$ref": "5141" + }, + { + "$ref": "5214" + }, + { + "$ref": "5224" + }, + { + "$ref": "5255" + }, + { + "$id": "5273", + "kind": "model", + "name": "ListIndexersResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ListIndexersResult", + "usage": "Output,Json", + "doc": "Response from a List Indexers request. If successful, it includes the full\ndefinitions of all indexers.", + "decorators": [], + "properties": [ + { + "$id": "5274", + "kind": "property", + "name": "indexers", + "serializedName": "value", + "doc": "The indexers in the Search service.", + "type": { + "$id": "5275", + "kind": "array", + "name": "ArraySearchIndexer", + "valueType": { + "$ref": "5091" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ListIndexersResult.value", + "serializationOptions": { + "$id": "5276", + "json": { + "$id": "5277", + "name": "value" + } + } + } + ] + }, + { + "$id": "5278", + "kind": "model", + "name": "SearchIndexerStatus", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerStatus", + "usage": "Output,Json", + "doc": "Represents the current status and execution history of an indexer.", + "decorators": [], + "properties": [ + { + "$id": "5279", + "kind": "property", + "name": "status", + "serializedName": "status", + "doc": "Overall indexer status.", + "type": { + "$ref": "2136" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerStatus.status", + "serializationOptions": { + "$id": "5280", + "json": { + "$id": "5281", + "name": "status" + } + } + }, + { + "$id": "5282", + "kind": "property", + "name": "lastResult", + "serializedName": "lastResult", + "doc": "The result of the most recent or an in-progress indexer execution.", + "type": { + "$id": "5283", + "kind": "model", + "name": "IndexerExecutionResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.IndexerExecutionResult", + "usage": "Output,Json", + "doc": "Represents the result of an individual indexer execution.", + "decorators": [], + "properties": [ + { + "$id": "5284", + "kind": "property", + "name": "status", + "serializedName": "status", + "doc": "The outcome of this indexer execution.", + "type": { + "$ref": "2144" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerExecutionResult.status", + "serializationOptions": { + "$id": "5285", + "json": { + "$id": "5286", + "name": "status" + } + } + }, + { + "$id": "5287", + "kind": "property", + "name": "statusDetail", + "serializedName": "statusDetail", + "doc": "The outcome of this indexer execution.", + "type": { + "$ref": "2154" + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerExecutionResult.statusDetail", + "serializationOptions": { + "$id": "5288", + "json": { + "$id": "5289", + "name": "statusDetail" + } + } + }, + { + "$id": "5290", + "kind": "property", + "name": "currentState", + "serializedName": "currentState", + "doc": "All of the state that defines and dictates the indexer's current execution.", + "type": { + "$id": "5291", + "kind": "model", + "name": "IndexerCurrentState", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.IndexerCurrentState", + "usage": "Output,Json", + "doc": "Represents all of the state that defines and dictates the indexer's current\nexecution.", + "decorators": [], + "properties": [ + { + "$id": "5292", + "kind": "property", + "name": "mode", + "serializedName": "mode", + "doc": "The mode the indexer is running in.", + "type": { + "$ref": "2158" + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerCurrentState.mode", + "serializationOptions": { + "$id": "5293", + "json": { + "$id": "5294", + "name": "mode" + } + } + }, + { + "$id": "5295", + "kind": "property", + "name": "allDocsInitialChangeTrackingState", + "serializedName": "allDocsInitialChangeTrackingState", + "doc": "Change tracking state used when indexing starts on all documents in the\ndatasource.", + "type": { + "$id": "5296", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerCurrentState.allDocsInitialChangeTrackingState", + "serializationOptions": { + "$id": "5297", + "json": { + "$id": "5298", + "name": "allDocsInitialChangeTrackingState" + } + } + }, + { + "$id": "5299", + "kind": "property", + "name": "allDocsFinalChangeTrackingState", + "serializedName": "allDocsFinalChangeTrackingState", + "doc": "Change tracking state value when indexing finishes on all documents in the\ndatasource.", + "type": { + "$id": "5300", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerCurrentState.allDocsFinalChangeTrackingState", + "serializationOptions": { + "$id": "5301", + "json": { + "$id": "5302", + "name": "allDocsFinalChangeTrackingState" + } + } + }, + { + "$id": "5303", + "kind": "property", + "name": "resetDocsInitialChangeTrackingState", + "serializedName": "resetDocsInitialChangeTrackingState", + "doc": "Change tracking state used when indexing starts on select, reset documents in\nthe datasource.", + "type": { + "$id": "5304", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerCurrentState.resetDocsInitialChangeTrackingState", + "serializationOptions": { + "$id": "5305", + "json": { + "$id": "5306", + "name": "resetDocsInitialChangeTrackingState" + } + } + }, + { + "$id": "5307", + "kind": "property", + "name": "resetDocsFinalChangeTrackingState", + "serializedName": "resetDocsFinalChangeTrackingState", + "doc": "Change tracking state value when indexing finishes on select, reset documents\nin the datasource.", + "type": { + "$id": "5308", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerCurrentState.resetDocsFinalChangeTrackingState", + "serializationOptions": { + "$id": "5309", + "json": { + "$id": "5310", + "name": "resetDocsFinalChangeTrackingState" + } + } + }, + { + "$id": "5311", + "kind": "property", + "name": "resetDocumentKeys", + "serializedName": "resetDocumentKeys", + "doc": "The list of document keys that have been reset. The document key is the\ndocument's unique identifier for the data in the search index. The indexer will\nprioritize selectively re-ingesting these keys.", + "type": { + "$id": "5312", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "5313", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerCurrentState.resetDocumentKeys", + "serializationOptions": { + "$id": "5314", + "json": { + "$id": "5315", + "name": "resetDocumentKeys" + } + } + }, + { + "$id": "5316", + "kind": "property", + "name": "resetDatasourceDocumentIds", + "serializedName": "resetDatasourceDocumentIds", + "doc": "The list of datasource document ids that have been reset. The datasource\ndocument id is the unique identifier for the data in the datasource. The\nindexer will prioritize selectively re-ingesting these ids.", + "type": { + "$id": "5317", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "5318", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerCurrentState.resetDatasourceDocumentIds", + "serializationOptions": { + "$id": "5319", + "json": { + "$id": "5320", + "name": "resetDatasourceDocumentIds" + } + } + } + ] + }, + "optional": true, + "readOnly": true, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerExecutionResult.currentState", + "serializationOptions": { + "$id": "5321", + "json": { + "$id": "5322", + "name": "currentState" + } + } + }, + { + "$id": "5323", + "kind": "property", + "name": "errorMessage", + "serializedName": "errorMessage", + "doc": "The error message indicating the top-level error, if any.", + "type": { + "$id": "5324", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerExecutionResult.errorMessage", + "serializationOptions": { + "$id": "5325", + "json": { + "$id": "5326", + "name": "errorMessage" + } + } + }, + { + "$id": "5327", + "kind": "property", + "name": "startTime", + "serializedName": "startTime", + "doc": "The start time of this indexer execution.", + "type": { + "$id": "5328", + "kind": "utcDateTime", + "name": "utcDateTime", + "encode": "rfc3339", + "wireType": { + "$id": "5329", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.utcDateTime", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerExecutionResult.startTime", + "serializationOptions": { + "$id": "5330", + "json": { + "$id": "5331", + "name": "startTime" + } + } + }, + { + "$id": "5332", + "kind": "property", + "name": "endTime", + "serializedName": "endTime", + "doc": "The end time of this indexer execution, if the execution has already completed.", + "type": { + "$id": "5333", + "kind": "utcDateTime", + "name": "utcDateTime", + "encode": "rfc3339", + "wireType": { + "$id": "5334", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.utcDateTime", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerExecutionResult.endTime", + "serializationOptions": { + "$id": "5335", + "json": { + "$id": "5336", + "name": "endTime" + } + } + }, + { + "$id": "5337", + "kind": "property", + "name": "errors", + "serializedName": "errors", + "doc": "The item-level indexing errors.", + "type": { + "$id": "5338", + "kind": "array", + "name": "ArraySearchIndexerError", + "valueType": { + "$id": "5339", + "kind": "model", + "name": "SearchIndexerError", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerError", + "usage": "Output,Error,Json", + "doc": "Represents an item- or document-level indexing error.", + "decorators": [], + "properties": [ + { + "$id": "5340", + "kind": "property", + "name": "key", + "serializedName": "key", + "doc": "The key of the item for which indexing failed.", + "type": { + "$id": "5341", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerError.key", + "serializationOptions": { + "$id": "5342", + "json": { + "$id": "5343", + "name": "key" + } + } + }, + { + "$id": "5344", + "kind": "property", + "name": "errorMessage", + "serializedName": "errorMessage", + "doc": "The message describing the error that occurred while processing the item.", + "type": { + "$id": "5345", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerError.errorMessage", + "serializationOptions": { + "$id": "5346", + "json": { + "$id": "5347", + "name": "errorMessage" + } + } + }, + { + "$id": "5348", + "kind": "property", + "name": "statusCode", + "serializedName": "statusCode", + "doc": "The status code indicating why the indexing operation failed. Possible values\ninclude: 400 for a malformed input document, 404 for document not found, 409\nfor a version conflict, 422 when the index is temporarily unavailable, or 503\nfor when the service is too busy.", + "type": { + "$id": "5349", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerError.statusCode", + "serializationOptions": { + "$id": "5350", + "json": { + "$id": "5351", + "name": "statusCode" + } + } + }, + { + "$id": "5352", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the source at which the error originated. For example, this could\nrefer to a particular skill in the attached skillset. This may not be always\navailable.", + "type": { + "$id": "5353", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerError.name", + "serializationOptions": { + "$id": "5354", + "json": { + "$id": "5355", + "name": "name" + } + } + }, + { + "$id": "5356", + "kind": "property", + "name": "details", + "serializedName": "details", + "doc": "Additional, verbose details about the error to assist in debugging the indexer.\nThis may not be always available.", + "type": { + "$id": "5357", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerError.details", + "serializationOptions": { + "$id": "5358", + "json": { + "$id": "5359", + "name": "details" + } + } + }, + { + "$id": "5360", + "kind": "property", + "name": "documentationLink", + "serializedName": "documentationLink", + "doc": "A link to a troubleshooting guide for these classes of errors. This may not be\nalways available.", + "type": { + "$id": "5361", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerError.documentationLink", + "serializationOptions": { + "$id": "5362", + "json": { + "$id": "5363", + "name": "documentationLink" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerExecutionResult.errors", + "serializationOptions": { + "$id": "5364", + "json": { + "$id": "5365", + "name": "errors" + } + } + }, + { + "$id": "5366", + "kind": "property", + "name": "warnings", + "serializedName": "warnings", + "doc": "The item-level indexing warnings.", + "type": { + "$id": "5367", + "kind": "array", + "name": "ArraySearchIndexerWarning", + "valueType": { + "$id": "5368", + "kind": "model", + "name": "SearchIndexerWarning", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerWarning", + "usage": "Output,Json", + "doc": "Represents an item-level warning.", + "decorators": [], + "properties": [ + { + "$id": "5369", + "kind": "property", + "name": "key", + "serializedName": "key", + "doc": "The key of the item which generated a warning.", + "type": { + "$id": "5370", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerWarning.key", + "serializationOptions": { + "$id": "5371", + "json": { + "$id": "5372", + "name": "key" + } + } + }, + { + "$id": "5373", + "kind": "property", + "name": "message", + "serializedName": "message", + "doc": "The message describing the warning that occurred while processing the item.", + "type": { + "$id": "5374", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerWarning.message", + "serializationOptions": { + "$id": "5375", + "json": { + "$id": "5376", + "name": "message" + } + } + }, + { + "$id": "5377", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the source at which the warning originated. For example, this could\nrefer to a particular skill in the attached skillset. This may not be always\navailable.", + "type": { + "$id": "5378", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerWarning.name", + "serializationOptions": { + "$id": "5379", + "json": { + "$id": "5380", + "name": "name" + } + } + }, + { + "$id": "5381", + "kind": "property", + "name": "details", + "serializedName": "details", + "doc": "Additional, verbose details about the warning to assist in debugging the\nindexer. This may not be always available.", + "type": { + "$id": "5382", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerWarning.details", + "serializationOptions": { + "$id": "5383", + "json": { + "$id": "5384", + "name": "details" + } + } + }, + { + "$id": "5385", + "kind": "property", + "name": "documentationLink", + "serializedName": "documentationLink", + "doc": "A link to a troubleshooting guide for these classes of warnings. This may not\nbe always available.", + "type": { + "$id": "5386", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerWarning.documentationLink", + "serializationOptions": { + "$id": "5387", + "json": { + "$id": "5388", + "name": "documentationLink" + } + } + } + ] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerExecutionResult.warnings", + "serializationOptions": { + "$id": "5389", + "json": { + "$id": "5390", + "name": "warnings" + } + } + }, + { + "$id": "5391", + "kind": "property", + "name": "itemCount", + "serializedName": "itemsProcessed", + "doc": "The number of items that were processed during this indexer execution. This\nincludes both successfully processed items and items where indexing was\nattempted but failed.", + "type": { + "$id": "5392", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerExecutionResult.itemsProcessed", + "serializationOptions": { + "$id": "5393", + "json": { + "$id": "5394", + "name": "itemsProcessed" + } + } + }, + { + "$id": "5395", + "kind": "property", + "name": "failedItemCount", + "serializedName": "itemsFailed", + "doc": "The number of items that failed to be indexed during this indexer execution.", + "type": { + "$id": "5396", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerExecutionResult.itemsFailed", + "serializationOptions": { + "$id": "5397", + "json": { + "$id": "5398", + "name": "itemsFailed" + } + } + }, + { + "$id": "5399", + "kind": "property", + "name": "initialTrackingState", + "serializedName": "initialTrackingState", + "doc": "Change tracking state with which an indexer execution started.", + "type": { + "$id": "5400", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerExecutionResult.initialTrackingState", + "serializationOptions": { + "$id": "5401", + "json": { + "$id": "5402", + "name": "initialTrackingState" + } + } + }, + { + "$id": "5403", + "kind": "property", + "name": "finalTrackingState", + "serializedName": "finalTrackingState", + "doc": "Change tracking state with which an indexer execution finished.", + "type": { + "$id": "5404", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.IndexerExecutionResult.finalTrackingState", + "serializationOptions": { + "$id": "5405", + "json": { + "$id": "5406", + "name": "finalTrackingState" + } + } + } + ] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerStatus.lastResult", + "serializationOptions": { + "$id": "5407", + "json": { + "$id": "5408", + "name": "lastResult" + } + } + }, + { + "$id": "5409", + "kind": "property", + "name": "executionHistory", + "serializedName": "executionHistory", + "doc": "History of the recent indexer executions, sorted in reverse chronological order.", + "type": { + "$id": "5410", + "kind": "array", + "name": "ArrayIndexerExecutionResult", + "valueType": { + "$ref": "5283" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerStatus.executionHistory", + "serializationOptions": { + "$id": "5411", + "json": { + "$id": "5412", + "name": "executionHistory" + } + } + }, + { + "$id": "5413", + "kind": "property", + "name": "limits", + "serializedName": "limits", + "doc": "The execution limits for the indexer.", + "type": { + "$id": "5414", + "kind": "model", + "name": "SearchIndexerLimits", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerLimits", + "usage": "Output,Json", + "doc": "Represents the limits that can be applied to an indexer.", + "decorators": [], + "properties": [ + { + "$id": "5415", + "kind": "property", + "name": "maxRunTime", + "serializedName": "maxRunTime", + "doc": "The maximum duration that the indexer is permitted to run for one execution.", + "type": { + "$id": "5416", + "kind": "duration", + "name": "duration", + "encode": "ISO8601", + "wireType": { + "$id": "5417", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.duration", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerLimits.maxRunTime", + "serializationOptions": { + "$id": "5418", + "json": { + "$id": "5419", + "name": "maxRunTime" + } + } + }, + { + "$id": "5420", + "kind": "property", + "name": "maxDocumentExtractionSize", + "serializedName": "maxDocumentExtractionSize", + "doc": "The maximum size of a document, in bytes, which will be considered valid for\nindexing.", + "type": { + "$id": "5421", + "kind": "int64", + "name": "int64", + "crossLanguageDefinitionId": "TypeSpec.int64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerLimits.maxDocumentExtractionSize", + "serializationOptions": { + "$id": "5422", + "json": { + "$id": "5423", + "name": "maxDocumentExtractionSize" + } + } + }, + { + "$id": "5424", + "kind": "property", + "name": "maxDocumentContentCharactersToExtract", + "serializedName": "maxDocumentContentCharactersToExtract", + "doc": "The maximum number of characters that will be extracted from a document picked\nup for indexing.", + "type": { + "$id": "5425", + "kind": "int64", + "name": "int64", + "crossLanguageDefinitionId": "TypeSpec.int64", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerLimits.maxDocumentContentCharactersToExtract", + "serializationOptions": { + "$id": "5426", + "json": { + "$id": "5427", + "name": "maxDocumentContentCharactersToExtract" + } + } + } + ] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerStatus.limits", + "serializationOptions": { + "$id": "5428", + "json": { + "$id": "5429", + "name": "limits" + } + } + } + ] + }, + { + "$ref": "5283" + }, + { + "$ref": "5291" + }, + { + "$ref": "5339" + }, + { + "$ref": "5368" + }, + { + "$ref": "5414" + }, + { + "$id": "5430", + "kind": "model", + "name": "SearchIndexerDataSource", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerDataSource", + "usage": "Input,Output,Json", + "doc": "Represents a datasource definition, which can be used to configure an indexer.", + "decorators": [], + "properties": [ + { + "$id": "5431", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the datasource.", + "type": { + "$id": "5432", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataSource.name", + "serializationOptions": { + "$id": "5433", + "json": { + "$id": "5434", + "name": "name" + } + } + }, + { + "$id": "5435", + "kind": "property", + "name": "description", + "serializedName": "description", + "doc": "The description of the datasource.", + "type": { + "$id": "5436", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataSource.description", + "serializationOptions": { + "$id": "5437", + "json": { + "$id": "5438", + "name": "description" + } + } + }, + { + "$id": "5439", + "kind": "property", + "name": "type", + "serializedName": "type", + "doc": "The type of the datasource.", + "type": { + "$ref": "2164" + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataSource.type", + "serializationOptions": { + "$id": "5440", + "json": { + "$id": "5441", + "name": "type" + } + } + }, + { + "$id": "5442", + "kind": "property", + "name": "credentials", + "serializedName": "credentials", + "doc": "Credentials for the datasource.", + "type": { + "$id": "5443", + "kind": "model", + "name": "DataSourceCredentials", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.DataSourceCredentials", + "usage": "Input,Output,Json", + "doc": "Represents credentials that can be used to connect to a datasource.", + "decorators": [], + "properties": [ + { + "$id": "5444", + "kind": "property", + "name": "connectionString", + "serializedName": "connectionString", + "doc": "The connection string for the datasource. Set to `` (with brackets)\nif you don't want the connection string updated. Set to `` if you\nwant to remove the connection string value from the datasource.", + "type": { + "$id": "5445", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DataSourceCredentials.connectionString", + "serializationOptions": { + "$id": "5446", + "json": { + "$id": "5447", + "name": "connectionString" + } + } + } + ] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataSource.credentials", + "serializationOptions": { + "$id": "5448", + "json": { + "$id": "5449", + "name": "credentials" + } + } + }, + { + "$id": "5450", + "kind": "property", + "name": "container", + "serializedName": "container", + "doc": "The data container for the datasource.", + "type": { + "$id": "5451", + "kind": "model", + "name": "SearchIndexerDataContainer", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SearchIndexerDataContainer", + "usage": "Input,Output,Json", + "doc": "Represents information about the entity (such as Azure SQL table or CosmosDB\ncollection) that will be indexed.", + "decorators": [], + "properties": [ + { + "$id": "5452", + "kind": "property", + "name": "name", + "serializedName": "name", + "doc": "The name of the table or view (for Azure SQL data source) or collection (for\nCosmosDB data source) that will be indexed.", + "type": { + "$id": "5453", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataContainer.name", + "serializationOptions": { + "$id": "5454", + "json": { + "$id": "5455", + "name": "name" + } + } + }, + { + "$id": "5456", + "kind": "property", + "name": "query", + "serializedName": "query", + "doc": "A query that is applied to this data container. The syntax and meaning of this\nparameter is datasource-specific. Not supported by Azure SQL datasources.", + "type": { + "$id": "5457", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataContainer.query", + "serializationOptions": { + "$id": "5458", + "json": { + "$id": "5459", + "name": "query" + } + } + } + ] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataSource.container", + "serializationOptions": { + "$id": "5460", + "json": { + "$id": "5461", + "name": "container" + } + } + }, + { + "$id": "5462", + "kind": "property", + "name": "identity", + "serializedName": "identity", + "doc": "An explicit managed identity to use for this datasource. If not specified and\nthe connection string is a managed identity, the system-assigned managed\nidentity is used. If not specified, the value remains unchanged. If \"none\" is\nspecified, the value of this property is cleared.", + "type": { + "$ref": "3877" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataSource.identity", + "serializationOptions": { + "$id": "5463", + "json": { + "$id": "5464", + "name": "identity" + } + } + }, + { + "$id": "5465", + "kind": "property", + "name": "dataChangeDetectionPolicy", + "serializedName": "dataChangeDetectionPolicy", + "doc": "The data change detection policy for the datasource.", + "type": { + "$id": "5466", + "kind": "model", + "name": "DataChangeDetectionPolicy", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.DataChangeDetectionPolicy", + "usage": "Input,Output,Json", + "doc": "Base type for data change detection policies.", + "decorators": [], + "discriminatorProperty": { + "$id": "5467", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "The discriminator for derived types.", + "type": { + "$id": "5468", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DataChangeDetectionPolicy.@odata.type", + "serializationOptions": { + "$id": "5469", + "json": { + "$id": "5470", + "name": "@odata.type" + } + } + }, + "properties": [ + { + "$ref": "5467" + } + ], + "discriminatedSubtypes": { + "$id": "5471", + "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy": { + "$id": "5472", + "kind": "model", + "name": "HighWaterMarkChangeDetectionPolicy", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.HighWaterMarkChangeDetectionPolicy", + "usage": "Input,Output,Json", + "doc": "Defines a data change detection policy that captures changes based on the value\nof a high water mark column.", + "discriminatorValue": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "decorators": [], + "baseModel": { + "$ref": "5466" + }, + "properties": [ + { + "$id": "5473", + "kind": "property", + "name": "highWaterMarkColumnName", + "serializedName": "highWaterMarkColumnName", + "doc": "The name of the high water mark column.", + "type": { + "$id": "5474", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.HighWaterMarkChangeDetectionPolicy.highWaterMarkColumnName", + "serializationOptions": { + "$id": "5475", + "json": { + "$id": "5476", + "name": "highWaterMarkColumnName" + } + } + }, + { + "$id": "5477", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of data change detection policy.", + "type": { + "$id": "5478", + "kind": "constant", + "valueType": { + "$id": "5479", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.HighWaterMarkChangeDetectionPolicy.@odata.type", + "serializationOptions": { + "$id": "5480", + "json": { + "$id": "5481", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy": { + "$id": "5482", + "kind": "model", + "name": "SqlIntegratedChangeTrackingPolicy", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SqlIntegratedChangeTrackingPolicy", + "usage": "Input,Output,Json", + "doc": "Defines a data change detection policy that captures changes using the\nIntegrated Change Tracking feature of Azure SQL Database.", + "discriminatorValue": "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy", + "decorators": [], + "baseModel": { + "$ref": "5466" + }, + "properties": [ + { + "$id": "5483", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of data change detection policy.", + "type": { + "$id": "5484", + "kind": "constant", + "valueType": { + "$id": "5485", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SqlIntegratedChangeTrackingPolicy.@odata.type", + "serializationOptions": { + "$id": "5486", + "json": { + "$id": "5487", + "name": "@odata.type" + } + } + } + ] + } + } + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataSource.dataChangeDetectionPolicy", + "serializationOptions": { + "$id": "5488", + "json": { + "$id": "5489", + "name": "dataChangeDetectionPolicy" + } + } + }, + { + "$id": "5490", + "kind": "property", + "name": "dataDeletionDetectionPolicy", + "serializedName": "dataDeletionDetectionPolicy", + "doc": "The data deletion detection policy for the datasource.", + "type": { + "$id": "5491", + "kind": "model", + "name": "DataDeletionDetectionPolicy", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.DataDeletionDetectionPolicy", + "usage": "Input,Output,Json", + "doc": "Base type for data deletion detection policies.", + "decorators": [], + "discriminatorProperty": { + "$id": "5492", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "The discriminator for derived types.", + "type": { + "$id": "5493", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.DataDeletionDetectionPolicy.@odata.type", + "serializationOptions": { + "$id": "5494", + "json": { + "$id": "5495", + "name": "@odata.type" + } + } + }, + "properties": [ + { + "$ref": "5492" + } + ], + "discriminatedSubtypes": { + "$id": "5496", + "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy": { + "$id": "5497", + "kind": "model", + "name": "SoftDeleteColumnDeletionDetectionPolicy", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.SoftDeleteColumnDeletionDetectionPolicy", + "usage": "Input,Output,Json", + "doc": "Defines a data deletion detection policy that implements a soft-deletion\nstrategy. It determines whether an item should be deleted based on the value of\na designated 'soft delete' column.", + "discriminatorValue": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "decorators": [], + "baseModel": { + "$ref": "5491" + }, + "properties": [ + { + "$id": "5498", + "kind": "property", + "name": "softDeleteColumnName", + "serializedName": "softDeleteColumnName", + "doc": "The name of the column to use for soft-deletion detection.", + "type": { + "$id": "5499", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SoftDeleteColumnDeletionDetectionPolicy.softDeleteColumnName", + "serializationOptions": { + "$id": "5500", + "json": { + "$id": "5501", + "name": "softDeleteColumnName" + } + } + }, + { + "$id": "5502", + "kind": "property", + "name": "softDeleteMarkerValue", + "serializedName": "softDeleteMarkerValue", + "doc": "The marker value that identifies an item as deleted.", + "type": { + "$id": "5503", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SoftDeleteColumnDeletionDetectionPolicy.softDeleteMarkerValue", + "serializationOptions": { + "$id": "5504", + "json": { + "$id": "5505", + "name": "softDeleteMarkerValue" + } + } + }, + { + "$id": "5506", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of data deletion detection policy.", + "type": { + "$id": "5507", + "kind": "constant", + "valueType": { + "$id": "5508", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SoftDeleteColumnDeletionDetectionPolicy.@odata.type", + "serializationOptions": { + "$id": "5509", + "json": { + "$id": "5510", + "name": "@odata.type" + } + } + } + ] + }, + "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy": { + "$id": "5511", + "kind": "model", + "name": "NativeBlobSoftDeleteDeletionDetectionPolicy", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.NativeBlobSoftDeleteDeletionDetectionPolicy", + "usage": "Input,Output,Json", + "doc": "Defines a data deletion detection policy utilizing Azure Blob Storage's native\nsoft delete feature for deletion detection.", + "discriminatorValue": "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy", + "decorators": [], + "baseModel": { + "$ref": "5491" + }, + "properties": [ + { + "$id": "5512", + "kind": "property", + "name": "odataType", + "serializedName": "@odata.type", + "doc": "A URI fragment specifying the type of data deletion detection policy.", + "type": { + "$id": "5513", + "kind": "constant", + "valueType": { + "$id": "5514", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "#Microsoft.Azure.Search.NativeBlobSoftDeleteDeletionDetectionPolicy", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": true, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.NativeBlobSoftDeleteDeletionDetectionPolicy.@odata.type", + "serializationOptions": { + "$id": "5515", + "json": { + "$id": "5516", + "name": "@odata.type" + } + } + } + ] + } + } + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataSource.dataDeletionDetectionPolicy", + "serializationOptions": { + "$id": "5517", + "json": { + "$id": "5518", + "name": "dataDeletionDetectionPolicy" + } + } + }, + { + "$id": "5519", + "kind": "property", + "name": "eTag", + "serializedName": "@odata.etag", + "doc": "The ETag of the data source.", + "type": { + "$id": "5520", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataSource.eTag", + "serializationOptions": { + "$id": "5521", + "json": { + "$id": "5522", + "name": "@odata.etag" + } + } + }, + { + "$id": "5523", + "kind": "property", + "name": "encryptionKey", + "serializedName": "encryptionKey", + "doc": "A description of an encryption key that you create in Azure Key Vault. This key\nis used to provide an additional level of encryption-at-rest for your\ndatasource definition when you want full assurance that no one, not even\nMicrosoft, can decrypt your data source definition. Once you have encrypted\nyour data source definition, it will always remain encrypted. The search\nservice will ignore attempts to set this property to null. You can change this\nproperty as needed if you want to rotate your encryption key; Your datasource\ndefinition will be unaffected. Encryption with customer-managed keys is not\navailable for free search services, and is only available for paid services\ncreated on or after January 1, 2019.", + "type": { + "$ref": "3851" + }, + "optional": true, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.SearchIndexerDataSource.encryptionKey", + "serializationOptions": { + "$id": "5524", + "json": { + "$id": "5525", + "name": "encryptionKey" + } + } + } + ] + }, + { + "$ref": "5443" + }, + { + "$ref": "5451" + }, + { + "$ref": "5466" + }, + { + "$ref": "5472" + }, + { + "$ref": "5482" + }, + { + "$ref": "5491" + }, + { + "$ref": "5497" + }, + { + "$ref": "5511" + }, + { + "$id": "5526", + "kind": "model", + "name": "ListDataSourcesResult", + "namespace": "Azure.Search.Documents", + "crossLanguageDefinitionId": "Search.ListDataSourcesResult", + "usage": "Output,Json", + "doc": "Response from a List Datasources request. If successful, it includes the full\ndefinitions of all datasources.", + "decorators": [], + "properties": [ + { + "$id": "5527", + "kind": "property", + "name": "dataSources", + "serializedName": "value", + "doc": "The datasources in the Search service.", + "type": { + "$id": "5528", + "kind": "array", + "name": "ArraySearchIndexerDataSource", + "valueType": { + "$ref": "5430" + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "optional": false, + "readOnly": false, + "discriminator": false, + "flatten": false, + "decorators": [], + "crossLanguageDefinitionId": "Search.ListDataSourcesResult.value", + "serializationOptions": { + "$id": "5529", + "json": { + "$id": "5530", + "name": "value" + } + } + } + ] + } + ], + "clients": [ + { + "$id": "5531", + "kind": "client", + "name": "SearchClient", + "namespace": "Azure.Search.Documents", + "doc": "Client that can be used to manage and query indexes and documents, as well as\nmanage other resources, on a search service.", + "operations": [ + { + "$id": "5532", + "name": "getServiceStatistics", + "resourceName": "Search", + "doc": "Gets service level statistics for a search service.", + "accessibility": "public", + "parameters": [ + { + "$id": "5533", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "5534", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "5535", + "type": { + "$id": "5536", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5537", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "5538", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "5539", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5540", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "5541", + "kind": "constant", + "valueType": { + "$id": "5542", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "5543", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "2186" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/servicestats", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.getServiceStatistics", + "decorators": [], + "examples": [ + { + "$id": "5544", + "kind": "http", + "name": "SearchServiceGetServiceStatistics", + "description": "SearchServiceGetServiceStatistics", + "filePath": "2025-03-01-preview/SearchServiceGetServiceStatistics.json", + "parameters": [ + { + "$id": "5545", + "parameter": { + "$ref": "5533" + }, + "value": { + "$id": "5546", + "kind": "string", + "type": { + "$ref": "5534" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "5547", + "parameter": { + "$ref": "5537" + }, + "value": { + "$id": "5548", + "kind": "string", + "type": { + "$ref": "5538" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "5549", + "response": { + "$ref": "5543" + }, + "statusCode": 200, + "bodyValue": { + "$id": "5550", + "kind": "model", + "type": { + "$ref": "2186" + }, + "value": { + "$id": "5551", + "counters": { + "$id": "5552", + "kind": "model", + "type": { + "$ref": "2188" + }, + "value": { + "$id": "5553", + "documentCount": { + "$id": "5554", + "kind": "model", + "type": { + "$ref": "2190" + }, + "value": { + "$id": "5555", + "usage": { + "$id": "5556", + "kind": "number", + "type": { + "$ref": "2192" + }, + "value": 12 + } + } + }, + "indexesCount": { + "$id": "5557", + "kind": "model", + "type": { + "$ref": "2190" + }, + "value": { + "$id": "5558", + "usage": { + "$id": "5559", + "kind": "number", + "type": { + "$ref": "2192" + }, + "value": 2 + }, + "quota": { + "$id": "5560", + "kind": "number", + "type": { + "$ref": "2196" + }, + "value": 2 + } + } + }, + "indexersCount": { + "$id": "5561", + "kind": "model", + "type": { + "$ref": "2190" + }, + "value": { + "$id": "5562", + "usage": { + "$id": "5563", + "kind": "number", + "type": { + "$ref": "2192" + }, + "value": 2 + }, + "quota": { + "$id": "5564", + "kind": "number", + "type": { + "$ref": "2196" + }, + "value": 2 + } + } + }, + "dataSourcesCount": { + "$id": "5565", + "kind": "model", + "type": { + "$ref": "2190" + }, + "value": { + "$id": "5566", + "usage": { + "$id": "5567", + "kind": "number", + "type": { + "$ref": "2192" + }, + "value": 2 + }, + "quota": { + "$id": "5568", + "kind": "number", + "type": { + "$ref": "2196" + }, + "value": 2 + } + } + }, + "storageSize": { + "$id": "5569", + "kind": "model", + "type": { + "$ref": "2190" + }, + "value": { + "$id": "5570", + "usage": { + "$id": "5571", + "kind": "number", + "type": { + "$ref": "2192" + }, + "value": 123456 + }, + "quota": { + "$id": "5572", + "kind": "number", + "type": { + "$ref": "2196" + }, + "value": 10485760 + } + } + }, + "synonymMaps": { + "$id": "5573", + "kind": "model", + "type": { + "$ref": "2190" + }, + "value": { + "$id": "5574", + "usage": { + "$id": "5575", + "kind": "number", + "type": { + "$ref": "2192" + }, + "value": 3 + }, + "quota": { + "$id": "5576", + "kind": "number", + "type": { + "$ref": "2196" + }, + "value": 3 + } + } + }, + "skillsetCount": { + "$id": "5577", + "kind": "model", + "type": { + "$ref": "2190" + }, + "value": { + "$id": "5578", + "usage": { + "$id": "5579", + "kind": "number", + "type": { + "$ref": "2192" + }, + "value": 2 + }, + "quota": { + "$id": "5580", + "kind": "number", + "type": { + "$ref": "2196" + }, + "value": 2 + } + } + }, + "aliasesCount": { + "$id": "5581", + "kind": "model", + "type": { + "$ref": "2190" + }, + "value": { + "$id": "5582", + "usage": { + "$id": "5583", + "kind": "number", + "type": { + "$ref": "2192" + }, + "value": 4 + }, + "quota": { + "$id": "5584", + "kind": "number", + "type": { + "$ref": "2196" + }, + "value": 4 + } + } + }, + "vectorIndexSize": { + "$id": "5585", + "kind": "model", + "type": { + "$ref": "2190" + }, + "value": { + "$id": "5586", + "usage": { + "$id": "5587", + "kind": "number", + "type": { + "$ref": "2192" + }, + "value": 123456 + } + } + } + } + }, + "limits": { + "$id": "5588", + "kind": "model", + "type": { + "$ref": "2228" + }, + "value": { + "$id": "5589", + "maxStoragePerIndex": { + "$id": "5590", + "kind": "number", + "type": { + "$ref": "2246" + }, + "value": 10485760 + }, + "maxFieldsPerIndex": { + "$id": "5591", + "kind": "number", + "type": { + "$ref": "2230" + }, + "value": 1000 + }, + "maxFieldNestingDepthPerIndex": { + "$id": "5592", + "kind": "number", + "type": { + "$ref": "2234" + }, + "value": 10 + }, + "maxComplexCollectionFieldsPerIndex": { + "$id": "5593", + "kind": "number", + "type": { + "$ref": "2238" + }, + "value": 40 + }, + "maxComplexObjectsInCollectionsPerDocument": { + "$id": "5594", + "kind": "number", + "type": { + "$ref": "2242" + }, + "value": 3000 + } + } + } + } + } + } + ] + } + ] + }, + { + "$id": "5595", + "name": "getIndexStatsSummary", + "resourceName": "Search", + "doc": "Retrieves a summary of statistics for all indexes in the search service.", + "accessibility": "public", + "parameters": [ + { + "$id": "5596", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "5597", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "5598", + "type": { + "$id": "5599", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5600", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "5601", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "5602", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5603", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "5604", + "kind": "constant", + "valueType": { + "$id": "5605", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "5606", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "2287" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/indexstats", + "bufferResponse": true, + "paging": { + "$id": "5607", + "itemPropertySegments": [ + "IndexesStatistics" + ] + }, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.getIndexStatsSummary", + "decorators": [], + "examples": [ + { + "$id": "5608", + "kind": "http", + "name": "SearchServiceGetIndexStatsSummary", + "description": "SearchServiceGetIndexStatsSummary", + "filePath": "2025-03-01-preview/SearchServiceGetIndexStatsSummary.json", + "parameters": [ + { + "$id": "5609", + "parameter": { + "$ref": "5596" + }, + "value": { + "$id": "5610", + "kind": "string", + "type": { + "$ref": "5597" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "5611", + "parameter": { + "$ref": "5600" + }, + "value": { + "$id": "5612", + "kind": "string", + "type": { + "$ref": "5601" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "5613", + "response": { + "$ref": "5606" + }, + "statusCode": 200, + "bodyValue": { + "$id": "5614", + "kind": "model", + "type": { + "$ref": "2287" + }, + "value": { + "$id": "5615", + "value": { + "$id": "5616", + "kind": "array", + "type": { + "$ref": "2289" + }, + "value": [ + { + "$id": "5617", + "kind": "model", + "type": { + "$ref": "2290" + }, + "value": { + "$id": "5618", + "name": { + "$id": "5619", + "kind": "string", + "type": { + "$ref": "2292" + }, + "value": "preview-test" + }, + "documentCount": { + "$id": "5620", + "kind": "number", + "type": { + "$ref": "2296" + }, + "value": 0 + }, + "storageSize": { + "$id": "5621", + "kind": "number", + "type": { + "$ref": "2300" + }, + "value": 0 + }, + "vectorIndexSize": { + "$id": "5622", + "kind": "number", + "type": { + "$ref": "2304" + }, + "value": 0 + } + } + } + ] + } + } + } + } + ] + } + ] + } + ], + "parameters": [ + { + "$id": "5623", + "name": "endpoint", + "nameInRequest": "endpoint", + "doc": "Service host", + "type": { + "$id": "5624", + "kind": "url", + "name": "url", + "crossLanguageDefinitionId": "TypeSpec.url" + }, + "location": "Uri", + "isApiVersion": false, + "isContentType": false, + "isRequired": true, + "isEndpoint": true, + "skipUrlEncoding": false, + "explode": false, + "kind": "Client" + } + ], + "decorators": [ + { + "$id": "5625", + "name": "TypeSpec.@service", + "arguments": { + "$id": "5626", + "options": { + "$id": "5627", + "title": "Azure AI Search" + } + } + } + ], + "crossLanguageDefinitionId": "Search", + "apiVersions": [ + "2024-07-01", + "2025-03-01-preview" + ], + "children": [ + { + "$id": "5628", + "kind": "client", + "name": "DataSources", + "namespace": "Azure.Search.Documents", + "operations": [ + { + "$id": "5629", + "name": "createOrUpdate", + "resourceName": "DataSources", + "doc": "Creates a new datasource or updates a datasource if it already exists.", + "accessibility": "public", + "parameters": [ + { + "$id": "5630", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "5631", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "5632", + "type": { + "$id": "5633", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5634", + "name": "ifMatch", + "nameInRequest": "If-Match", + "doc": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "type": { + "$id": "5635", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5636", + "name": "ifNoneMatch", + "nameInRequest": "If-None-Match", + "doc": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "type": { + "$id": "5637", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5638", + "name": "prefer", + "nameInRequest": "Prefer", + "doc": "For HTTP PUT requests, instructs the service to return the created/updated resource on success.", + "type": { + "$id": "5639", + "kind": "constant", + "valueType": { + "$id": "5640", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "return=representation", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5641", + "name": "skipIndexerResetRequirementForCache", + "nameInRequest": "ignoreResetRequirements", + "doc": "Ignores cache reset requirements.", + "type": { + "$id": "5642", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5643", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "5644", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "5645", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5646", + "name": "dataSourceName", + "nameInRequest": "dataSourceName", + "doc": "The name of the datasource.", + "type": { + "$id": "5647", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5648", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "5649", + "kind": "constant", + "valueType": { + "$id": "5650", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5651", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "5652", + "kind": "constant", + "valueType": { + "$id": "5653", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5654", + "name": "dataSource", + "nameInRequest": "dataSource", + "doc": "The definition of the datasource to create or update.", + "type": { + "$ref": "5430" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "5655", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "5430" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + }, + { + "$id": "5656", + "statusCodes": [ + 201 + ], + "bodyType": { + "$ref": "5430" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "PUT", + "uri": "{endpoint}", + "path": "/datasources('{dataSourceName}')", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.DataSources.createOrUpdate", + "decorators": [], + "examples": [ + { + "$id": "5657", + "kind": "http", + "name": "SearchServiceCreateOrUpdateDataSource", + "description": "SearchServiceCreateOrUpdateDataSource", + "filePath": "2025-03-01-preview/SearchServiceCreateOrUpdateDataSource.json", + "parameters": [ + { + "$id": "5658", + "parameter": { + "$ref": "5646" + }, + "value": { + "$id": "5659", + "kind": "string", + "type": { + "$ref": "5647" + }, + "value": "tempdatasource" + } + }, + { + "$id": "5660", + "parameter": { + "$ref": "5630" + }, + "value": { + "$id": "5661", + "kind": "string", + "type": { + "$ref": "5631" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "5662", + "parameter": { + "$ref": "5643" + }, + "value": { + "$id": "5663", + "kind": "string", + "type": { + "$ref": "5644" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "5664", + "parameter": { + "$ref": "5638" + }, + "value": { + "$id": "5665", + "kind": "string", + "type": { + "$ref": "5639" + }, + "value": "return=representation" + } + }, + { + "$id": "5666", + "parameter": { + "$ref": "5654" + }, + "value": { + "$id": "5667", + "kind": "model", + "type": { + "$ref": "5430" + }, + "value": { + "$id": "5668", + "name": { + "$id": "5669", + "kind": "string", + "type": { + "$ref": "5432" + }, + "value": "tempdatasource" + }, + "description": { + "$id": "5670", + "kind": "string", + "type": { + "$ref": "5436" + }, + "value": "My Azure Blob data source." + }, + "type": { + "$id": "5671", + "kind": "string", + "type": { + "$ref": "2164" + }, + "value": "azureblob" + }, + "credentials": { + "$id": "5672", + "kind": "model", + "type": { + "$ref": "5443" + }, + "value": { + "$id": "5673", + "connectionString": { + "$id": "5674", + "kind": "string", + "type": { + "$ref": "5445" + }, + "value": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + } + } + }, + "container": { + "$id": "5675", + "kind": "model", + "type": { + "$ref": "5451" + }, + "value": { + "$id": "5676", + "name": { + "$id": "5677", + "kind": "string", + "type": { + "$ref": "5453" + }, + "value": "doc-extraction-skillset" + }, + "query": { + "$id": "5678", + "kind": "string", + "type": { + "$ref": "5457" + }, + "value": "E2E_Dsat" + } + } + }, + "@odata.etag": { + "$id": "5679", + "kind": "string", + "type": { + "$ref": "5520" + }, + "value": "0x1234568AE7E58A1" + }, + "encryptionKey": { + "$id": "5680", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "5681", + "keyVaultKeyName": { + "$id": "5682", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "5683", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "5684", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "5685", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "5686", + "applicationId": { + "$id": "5687", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "5688", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ], + "responses": [ + { + "$id": "5689", + "response": { + "$ref": "5655" + }, + "statusCode": 200, + "bodyValue": { + "$id": "5690", + "kind": "model", + "type": { + "$ref": "5430" + }, + "value": { + "$id": "5691", + "@odata.etag": { + "$id": "5692", + "kind": "string", + "type": { + "$ref": "5520" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "5693", + "kind": "string", + "type": { + "$ref": "5432" + }, + "value": "tempdatasource" + }, + "description": { + "$id": "5694", + "kind": "string", + "type": { + "$ref": "5436" + }, + "value": "My Azure Blob data source." + }, + "type": { + "$id": "5695", + "kind": "string", + "type": { + "$ref": "2164" + }, + "value": "azureblob" + }, + "credentials": { + "$id": "5696", + "kind": "model", + "type": { + "$ref": "5443" + }, + "value": { + "$id": "5697", + "connectionString": { + "$id": "5698", + "kind": "string", + "type": { + "$ref": "5445" + }, + "value": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + } + } + }, + "container": { + "$id": "5699", + "kind": "model", + "type": { + "$ref": "5451" + }, + "value": { + "$id": "5700", + "name": { + "$id": "5701", + "kind": "string", + "type": { + "$ref": "5453" + }, + "value": "doc-extraction-skillset" + }, + "query": { + "$id": "5702", + "kind": "string", + "type": { + "$ref": "5457" + }, + "value": "E2E_Dsat" + } + } + }, + "encryptionKey": { + "$id": "5703", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "5704", + "keyVaultKeyName": { + "$id": "5705", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "5706", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "5707", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "5708", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "5709", + "applicationId": { + "$id": "5710", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "5711", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + }, + { + "$id": "5712", + "response": { + "$ref": "5656" + }, + "statusCode": 201, + "bodyValue": { + "$id": "5713", + "kind": "model", + "type": { + "$ref": "5430" + }, + "value": { + "$id": "5714", + "@odata.etag": { + "$id": "5715", + "kind": "string", + "type": { + "$ref": "5520" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "5716", + "kind": "string", + "type": { + "$ref": "5432" + }, + "value": "tempdatasource" + }, + "description": { + "$id": "5717", + "kind": "string", + "type": { + "$ref": "5436" + }, + "value": "My Azure Blob data source." + }, + "type": { + "$id": "5718", + "kind": "string", + "type": { + "$ref": "2164" + }, + "value": "azureblob" + }, + "credentials": { + "$id": "5719", + "kind": "model", + "type": { + "$ref": "5443" + }, + "value": { + "$id": "5720", + "connectionString": { + "$id": "5721", + "kind": "string", + "type": { + "$ref": "5445" + }, + "value": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + } + } + }, + "container": { + "$id": "5722", + "kind": "model", + "type": { + "$ref": "5451" + }, + "value": { + "$id": "5723", + "name": { + "$id": "5724", + "kind": "string", + "type": { + "$ref": "5453" + }, + "value": "doc-extraction-skillset" + }, + "query": { + "$id": "5725", + "kind": "string", + "type": { + "$ref": "5457" + }, + "value": "E2E_Dsat" + } + } + }, + "encryptionKey": { + "$id": "5726", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "5727", + "keyVaultKeyName": { + "$id": "5728", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "5729", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "5730", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "5731", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "5732", + "applicationId": { + "$id": "5733", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "5734", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ] + } + ] + }, + { + "$id": "5735", + "name": "delete", + "resourceName": "DataSources", + "doc": "Deletes a datasource.", + "accessibility": "public", + "parameters": [ + { + "$id": "5736", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "5737", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "5738", + "type": { + "$id": "5739", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5740", + "name": "ifMatch", + "nameInRequest": "If-Match", + "doc": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "type": { + "$id": "5741", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5742", + "name": "ifNoneMatch", + "nameInRequest": "If-None-Match", + "doc": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "type": { + "$id": "5743", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5744", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "5745", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "5746", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5747", + "name": "dataSourceName", + "nameInRequest": "dataSourceName", + "doc": "The name of the datasource.", + "type": { + "$id": "5748", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5749", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "5750", + "kind": "constant", + "valueType": { + "$id": "5751", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "5752", + "statusCodes": [ + 204 + ], + "headers": [], + "isErrorResponse": false + }, + { + "$id": "5753", + "statusCodes": [ + 404 + ], + "headers": [], + "isErrorResponse": false + } + ], + "httpMethod": "DELETE", + "uri": "{endpoint}", + "path": "/datasources('{dataSourceName}')", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.DataSources.delete", + "decorators": [], + "examples": [ + { + "$id": "5754", + "kind": "http", + "name": "SearchServiceDeleteDataSource", + "description": "SearchServiceDeleteDataSource", + "filePath": "2025-03-01-preview/SearchServiceDeleteDataSource.json", + "parameters": [ + { + "$id": "5755", + "parameter": { + "$ref": "5747" + }, + "value": { + "$id": "5756", + "kind": "string", + "type": { + "$ref": "5748" + }, + "value": "tempdatasource" + } + }, + { + "$id": "5757", + "parameter": { + "$ref": "5736" + }, + "value": { + "$id": "5758", + "kind": "string", + "type": { + "$ref": "5737" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "5759", + "parameter": { + "$ref": "5744" + }, + "value": { + "$id": "5760", + "kind": "string", + "type": { + "$ref": "5745" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "5761", + "response": { + "$ref": "5752" + }, + "statusCode": 204 + }, + { + "$id": "5762", + "response": { + "$ref": "5753" + }, + "statusCode": 404 + } + ] + } + ] + }, + { + "$id": "5763", + "name": "get", + "resourceName": "DataSources", + "doc": "Retrieves a datasource definition.", + "accessibility": "public", + "parameters": [ + { + "$id": "5764", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "5765", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "5766", + "type": { + "$id": "5767", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5768", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "5769", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "5770", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5771", + "name": "dataSourceName", + "nameInRequest": "dataSourceName", + "doc": "The name of the datasource.", + "type": { + "$id": "5772", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5773", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "5774", + "kind": "constant", + "valueType": { + "$id": "5775", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "5776", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "5430" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/datasources('{dataSourceName}')", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.DataSources.get", + "decorators": [], + "examples": [ + { + "$id": "5777", + "kind": "http", + "name": "SearchServiceGetDataSource", + "description": "SearchServiceGetDataSource", + "filePath": "2025-03-01-preview/SearchServiceGetDataSource.json", + "parameters": [ + { + "$id": "5778", + "parameter": { + "$ref": "5771" + }, + "value": { + "$id": "5779", + "kind": "string", + "type": { + "$ref": "5772" + }, + "value": "mydocdbdatasource" + } + }, + { + "$id": "5780", + "parameter": { + "$ref": "5764" + }, + "value": { + "$id": "5781", + "kind": "string", + "type": { + "$ref": "5765" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "5782", + "parameter": { + "$ref": "5768" + }, + "value": { + "$id": "5783", + "kind": "string", + "type": { + "$ref": "5769" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "5784", + "response": { + "$ref": "5776" + }, + "statusCode": 200, + "bodyValue": { + "$id": "5785", + "kind": "model", + "type": { + "$ref": "5430" + }, + "value": { + "$id": "5786", + "@odata.etag": { + "$id": "5787", + "kind": "string", + "type": { + "$ref": "5520" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "5788", + "kind": "string", + "type": { + "$ref": "5432" + }, + "value": "mydocdbdatasource" + }, + "description": { + "$id": "5789", + "kind": "string", + "type": { + "$ref": "5436" + }, + "value": "My Azure Blob data source." + }, + "type": { + "$id": "5790", + "kind": "string", + "type": { + "$ref": "2164" + }, + "value": "azureblob" + }, + "credentials": { + "$id": "5791", + "kind": "model", + "type": { + "$ref": "5443" + }, + "value": { + "$id": "5792", + "connectionString": { + "$id": "5793", + "kind": "string", + "type": { + "$ref": "5445" + }, + "value": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + } + } + }, + "container": { + "$id": "5794", + "kind": "model", + "type": { + "$ref": "5451" + }, + "value": { + "$id": "5795", + "name": { + "$id": "5796", + "kind": "string", + "type": { + "$ref": "5453" + }, + "value": "doc-extraction-skillset" + }, + "query": { + "$id": "5797", + "kind": "string", + "type": { + "$ref": "5457" + }, + "value": "E2E_Dsat" + } + } + }, + "encryptionKey": { + "$id": "5798", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "5799", + "keyVaultKeyName": { + "$id": "5800", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "5801", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "5802", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "5803", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "5804", + "applicationId": { + "$id": "5805", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "5806", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ] + } + ] + }, + { + "$id": "5807", + "name": "list", + "resourceName": "DataSources", + "doc": "Lists all datasources available for a search service.", + "accessibility": "public", + "parameters": [ + { + "$id": "5808", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "5809", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "5810", + "type": { + "$id": "5811", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5812", + "name": "$select", + "nameInRequest": "$select", + "doc": "Selects which top-level properties to retrieve.\nSpecified as a comma-separated list of JSON property names,\nor '*' for all properties. The default is all properties.", + "type": { + "$id": "5813", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5814", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "5815", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "5816", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5817", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "5818", + "kind": "constant", + "valueType": { + "$id": "5819", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "5820", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "5526" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/datasources", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.DataSources.list", + "decorators": [], + "examples": [ + { + "$id": "5821", + "kind": "http", + "name": "SearchServiceListDataSources", + "description": "SearchServiceListDataSources", + "filePath": "2025-03-01-preview/SearchServiceListDataSources.json", + "parameters": [ + { + "$id": "5822", + "parameter": { + "$ref": "5808" + }, + "value": { + "$id": "5823", + "kind": "string", + "type": { + "$ref": "5809" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "5824", + "parameter": { + "$ref": "5814" + }, + "value": { + "$id": "5825", + "kind": "string", + "type": { + "$ref": "5815" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "5826", + "response": { + "$ref": "5820" + }, + "statusCode": 200, + "bodyValue": { + "$id": "5827", + "kind": "model", + "type": { + "$ref": "5526" + }, + "value": { + "$id": "5828", + "value": { + "$id": "5829", + "kind": "array", + "type": { + "$ref": "5528" + }, + "value": [ + { + "$id": "5830", + "kind": "model", + "type": { + "$ref": "5430" + }, + "value": { + "$id": "5831", + "@odata.etag": { + "$id": "5832", + "kind": "string", + "type": { + "$ref": "5520" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "5833", + "kind": "string", + "type": { + "$ref": "5432" + }, + "value": "mydocdbdatasource" + }, + "description": { + "$id": "5834", + "kind": "string", + "type": { + "$ref": "5436" + }, + "value": "My Azure Blob data source." + }, + "type": { + "$id": "5835", + "kind": "string", + "type": { + "$ref": "2164" + }, + "value": "azureblob" + }, + "credentials": { + "$id": "5836", + "kind": "model", + "type": { + "$ref": "5443" + }, + "value": { + "$id": "5837", + "connectionString": { + "$id": "5838", + "kind": "string", + "type": { + "$ref": "5445" + }, + "value": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + } + } + }, + "container": { + "$id": "5839", + "kind": "model", + "type": { + "$ref": "5451" + }, + "value": { + "$id": "5840", + "name": { + "$id": "5841", + "kind": "string", + "type": { + "$ref": "5453" + }, + "value": "doc-extraction-skillset" + }, + "query": { + "$id": "5842", + "kind": "string", + "type": { + "$ref": "5457" + }, + "value": "E2E_Dsat" + } + } + }, + "encryptionKey": { + "$id": "5843", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "5844", + "keyVaultKeyName": { + "$id": "5845", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "5846", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "5847", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "5848", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "5849", + "applicationId": { + "$id": "5850", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "5851", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + ] + } + } + } + } + ] + } + ] + }, + { + "$id": "5852", + "name": "create", + "resourceName": "DataSources", + "doc": "Creates a new datasource.", + "accessibility": "public", + "parameters": [ + { + "$id": "5853", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "5854", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "5855", + "type": { + "$id": "5856", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5857", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "5858", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "5859", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5860", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "5861", + "kind": "constant", + "valueType": { + "$id": "5862", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5863", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "5864", + "kind": "constant", + "valueType": { + "$id": "5865", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5866", + "name": "dataSource", + "nameInRequest": "dataSource", + "doc": "The definition of the datasource to create.", + "type": { + "$ref": "5430" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "5867", + "statusCodes": [ + 201 + ], + "bodyType": { + "$ref": "5430" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "POST", + "uri": "{endpoint}", + "path": "/datasources", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.DataSources.create", + "decorators": [], + "examples": [ + { + "$id": "5868", + "kind": "http", + "name": "SearchServiceCreateDataSource", + "description": "SearchServiceCreateDataSource", + "filePath": "2025-03-01-preview/SearchServiceCreateDataSource.json", + "parameters": [ + { + "$id": "5869", + "parameter": { + "$ref": "5853" + }, + "value": { + "$id": "5870", + "kind": "string", + "type": { + "$ref": "5854" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "5871", + "parameter": { + "$ref": "5857" + }, + "value": { + "$id": "5872", + "kind": "string", + "type": { + "$ref": "5858" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "5873", + "parameter": { + "$ref": "5866" + }, + "value": { + "$id": "5874", + "kind": "model", + "type": { + "$ref": "5430" + }, + "value": { + "$id": "5875", + "name": { + "$id": "5876", + "kind": "string", + "type": { + "$ref": "5432" + }, + "value": "tempdatasource" + }, + "description": { + "$id": "5877", + "kind": "string", + "type": { + "$ref": "5436" + }, + "value": "My Azure Blob data source." + }, + "type": { + "$id": "5878", + "kind": "string", + "type": { + "$ref": "2164" + }, + "value": "azureblob" + }, + "credentials": { + "$id": "5879", + "kind": "model", + "type": { + "$ref": "5443" + }, + "value": { + "$id": "5880", + "connectionString": { + "$id": "5881", + "kind": "string", + "type": { + "$ref": "5445" + }, + "value": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + } + } + }, + "container": { + "$id": "5882", + "kind": "model", + "type": { + "$ref": "5451" + }, + "value": { + "$id": "5883", + "name": { + "$id": "5884", + "kind": "string", + "type": { + "$ref": "5453" + }, + "value": "doc-extraction-skillset" + }, + "query": { + "$id": "5885", + "kind": "string", + "type": { + "$ref": "5457" + }, + "value": "E2E_Dsat" + } + } + }, + "@odata.etag": { + "$id": "5886", + "kind": "string", + "type": { + "$ref": "5520" + }, + "value": "0x1234568AE7E58A1" + }, + "encryptionKey": { + "$id": "5887", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "5888", + "keyVaultKeyName": { + "$id": "5889", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "5890", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "5891", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "5892", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "5893", + "applicationId": { + "$id": "5894", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "5895", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ], + "responses": [ + { + "$id": "5896", + "response": { + "$ref": "5867" + }, + "statusCode": 201, + "bodyValue": { + "$id": "5897", + "kind": "model", + "type": { + "$ref": "5430" + }, + "value": { + "$id": "5898", + "name": { + "$id": "5899", + "kind": "string", + "type": { + "$ref": "5432" + }, + "value": "tempdatasource" + }, + "description": { + "$id": "5900", + "kind": "string", + "type": { + "$ref": "5436" + }, + "value": "My Azure Blob data source." + }, + "type": { + "$id": "5901", + "kind": "string", + "type": { + "$ref": "2164" + }, + "value": "azureblob" + }, + "credentials": { + "$id": "5902", + "kind": "model", + "type": { + "$ref": "5443" + }, + "value": { + "$id": "5903", + "connectionString": { + "$id": "5904", + "kind": "string", + "type": { + "$ref": "5445" + }, + "value": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + } + } + }, + "container": { + "$id": "5905", + "kind": "model", + "type": { + "$ref": "5451" + }, + "value": { + "$id": "5906", + "name": { + "$id": "5907", + "kind": "string", + "type": { + "$ref": "5453" + }, + "value": "doc-extraction-skillset" + }, + "query": { + "$id": "5908", + "kind": "string", + "type": { + "$ref": "5457" + }, + "value": "E2E_Dsat" + } + } + }, + "encryptionKey": { + "$id": "5909", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "5910", + "keyVaultKeyName": { + "$id": "5911", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "5912", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "5913", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "5914", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "5915", + "applicationId": { + "$id": "5916", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "5917", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ] + } + ] + } + ], + "parameters": [ + { + "$id": "5918", + "name": "endpoint", + "nameInRequest": "endpoint", + "doc": "Service host", + "type": { + "$id": "5919", + "kind": "url", + "name": "url", + "crossLanguageDefinitionId": "TypeSpec.url" + }, + "location": "Uri", + "isApiVersion": false, + "isContentType": false, + "isRequired": true, + "isEndpoint": true, + "skipUrlEncoding": false, + "explode": false, + "kind": "Client" + } + ], + "decorators": [], + "crossLanguageDefinitionId": "Search.DataSources", + "apiVersions": [ + "2024-07-01", + "2025-03-01-preview" + ], + "parent": { + "$ref": "5531" + } + }, + { + "$id": "5920", + "kind": "client", + "name": "Indexers", + "namespace": "Azure.Search.Documents", + "operations": [ + { + "$id": "5921", + "name": "reset", + "resourceName": "Indexers", + "doc": "Resets the change tracking state associated with an indexer.", + "accessibility": "public", + "parameters": [ + { + "$id": "5922", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "5923", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "5924", + "type": { + "$id": "5925", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5926", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "5927", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "5928", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5929", + "name": "indexerName", + "nameInRequest": "indexerName", + "doc": "The name of the indexer.", + "type": { + "$id": "5930", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5931", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "5932", + "kind": "constant", + "valueType": { + "$id": "5933", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "5934", + "statusCodes": [ + 204 + ], + "headers": [], + "isErrorResponse": false + } + ], + "httpMethod": "POST", + "uri": "{endpoint}", + "path": "/indexers('{indexerName}')/search.reset", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexers.reset", + "decorators": [], + "examples": [ + { + "$id": "5935", + "kind": "http", + "name": "SearchServiceResetIndexer", + "description": "SearchServiceResetIndexer", + "filePath": "2025-03-01-preview/SearchServiceResetIndexer.json", + "parameters": [ + { + "$id": "5936", + "parameter": { + "$ref": "5929" + }, + "value": { + "$id": "5937", + "kind": "string", + "type": { + "$ref": "5930" + }, + "value": "myindexer" + } + }, + { + "$id": "5938", + "parameter": { + "$ref": "5922" + }, + "value": { + "$id": "5939", + "kind": "string", + "type": { + "$ref": "5923" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "5940", + "parameter": { + "$ref": "5926" + }, + "value": { + "$id": "5941", + "kind": "string", + "type": { + "$ref": "5927" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "5942", + "response": { + "$ref": "5934" + }, + "statusCode": 204 + } + ] + } + ] + }, + { + "$id": "5943", + "name": "resetDocs", + "resourceName": "Indexers", + "doc": "Resets specific documents in the datasource to be selectively re-ingested by\nthe indexer.", + "accessibility": "public", + "parameters": [ + { + "$id": "5944", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "5945", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "5946", + "type": { + "$id": "5947", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5948", + "name": "overwrite", + "nameInRequest": "overwrite", + "doc": "If false, keys or ids will be appended to existing ones. If true, only the keys\nor ids in this payload will be queued to be re-ingested.", + "type": { + "$id": "5949", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5950", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "5951", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "5952", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5953", + "name": "indexerName", + "nameInRequest": "indexerName", + "doc": "The name of the indexer.", + "type": { + "$id": "5954", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5955", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "5956", + "kind": "constant", + "valueType": { + "$id": "5957", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5958", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "5959", + "kind": "constant", + "valueType": { + "$id": "5960", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5961", + "name": "keysOrIds", + "nameInRequest": "keysOrIds", + "doc": "The keys or ids of the documents to be re-ingested. If keys are provided, the\ndocument key field must be specified in the indexer configuration. If ids are\nprovided, the document key field is ignored.", + "type": { + "$ref": "5080" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "5962", + "statusCodes": [ + 204 + ], + "headers": [], + "isErrorResponse": false + } + ], + "httpMethod": "POST", + "uri": "{endpoint}", + "path": "/indexers('{indexerName}')/search.resetdocs", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexers.resetDocs", + "decorators": [], + "examples": [ + { + "$id": "5963", + "kind": "http", + "name": "SearchServiceResetDocs", + "description": "SearchServiceResetDocs", + "filePath": "2025-03-01-preview/SearchServiceResetDocs.json", + "parameters": [ + { + "$id": "5964", + "parameter": { + "$ref": "5953" + }, + "value": { + "$id": "5965", + "kind": "string", + "type": { + "$ref": "5954" + }, + "value": "myindexer" + } + }, + { + "$id": "5966", + "parameter": { + "$ref": "5948" + }, + "value": { + "$id": "5967", + "kind": "boolean", + "type": { + "$ref": "5949" + }, + "value": true + } + }, + { + "$id": "5968", + "parameter": { + "$ref": "5944" + }, + "value": { + "$id": "5969", + "kind": "string", + "type": { + "$ref": "5945" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "5970", + "parameter": { + "$ref": "5950" + }, + "value": { + "$id": "5971", + "kind": "string", + "type": { + "$ref": "5951" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "5972", + "parameter": { + "$ref": "5961" + }, + "value": { + "$id": "5973", + "kind": "model", + "type": { + "$ref": "5080" + }, + "value": { + "$id": "5974", + "documentKeys": { + "$id": "5975", + "kind": "array", + "type": { + "$ref": "5082" + }, + "value": [ + { + "$id": "5976", + "kind": "string", + "type": { + "$ref": "5083" + }, + "value": "1" + }, + { + "$id": "5977", + "kind": "string", + "type": { + "$ref": "5083" + }, + "value": "2" + }, + { + "$id": "5978", + "kind": "string", + "type": { + "$ref": "5083" + }, + "value": "3" + } + ] + } + } + } + } + ], + "responses": [ + { + "$id": "5979", + "response": { + "$ref": "5962" + }, + "statusCode": 204 + } + ] + } + ] + }, + { + "$id": "5980", + "name": "run", + "resourceName": "Indexers", + "doc": "Runs an indexer on-demand.", + "accessibility": "public", + "parameters": [ + { + "$id": "5981", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "5982", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "5983", + "type": { + "$id": "5984", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5985", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "5986", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "5987", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5988", + "name": "indexerName", + "nameInRequest": "indexerName", + "doc": "The name of the indexer.", + "type": { + "$id": "5989", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "5990", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "5991", + "kind": "constant", + "valueType": { + "$id": "5992", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "5993", + "statusCodes": [ + 202 + ], + "headers": [], + "isErrorResponse": false + } + ], + "httpMethod": "POST", + "uri": "{endpoint}", + "path": "/indexers('{indexerName}')/search.run", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexers.run", + "decorators": [], + "examples": [ + { + "$id": "5994", + "kind": "http", + "name": "SearchServiceRunIndexer", + "description": "SearchServiceRunIndexer", + "filePath": "2025-03-01-preview/SearchServiceRunIndexer.json", + "parameters": [ + { + "$id": "5995", + "parameter": { + "$ref": "5988" + }, + "value": { + "$id": "5996", + "kind": "string", + "type": { + "$ref": "5989" + }, + "value": "myindexer" + } + }, + { + "$id": "5997", + "parameter": { + "$ref": "5981" + }, + "value": { + "$id": "5998", + "kind": "string", + "type": { + "$ref": "5982" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "5999", + "parameter": { + "$ref": "5985" + }, + "value": { + "$id": "6000", + "kind": "string", + "type": { + "$ref": "5986" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "6001", + "response": { + "$ref": "5993" + }, + "statusCode": 202 + } + ] + } + ] + }, + { + "$id": "6002", + "name": "createOrUpdate", + "resourceName": "Indexers", + "doc": "Creates a new indexer or updates an indexer if it already exists.", + "accessibility": "public", + "parameters": [ + { + "$id": "6003", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "6004", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "6005", + "type": { + "$id": "6006", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6007", + "name": "ifMatch", + "nameInRequest": "If-Match", + "doc": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "type": { + "$id": "6008", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6009", + "name": "ifNoneMatch", + "nameInRequest": "If-None-Match", + "doc": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "type": { + "$id": "6010", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6011", + "name": "prefer", + "nameInRequest": "Prefer", + "doc": "For HTTP PUT requests, instructs the service to return the created/updated resource on success.", + "type": { + "$id": "6012", + "kind": "constant", + "valueType": { + "$id": "6013", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "return=representation", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6014", + "name": "skipIndexerResetRequirementForCache", + "nameInRequest": "ignoreResetRequirements", + "doc": "Ignores cache reset requirements.", + "type": { + "$id": "6015", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6016", + "name": "disableCacheReprocessingChangeDetection", + "nameInRequest": "disableCacheReprocessingChangeDetection", + "doc": "Disables cache reprocessing change detection.", + "type": { + "$id": "6017", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6018", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "6019", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "6020", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6021", + "name": "indexerName", + "nameInRequest": "indexerName", + "doc": "The name of the indexer.", + "type": { + "$id": "6022", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6023", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "6024", + "kind": "constant", + "valueType": { + "$id": "6025", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6026", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "6027", + "kind": "constant", + "valueType": { + "$id": "6028", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6029", + "name": "indexer", + "nameInRequest": "indexer", + "doc": "The definition of the indexer to create or update.", + "type": { + "$ref": "5091" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "6030", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "5091" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + }, + { + "$id": "6031", + "statusCodes": [ + 201 + ], + "bodyType": { + "$ref": "5091" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "PUT", + "uri": "{endpoint}", + "path": "/indexers('{indexerName}')", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexers.createOrUpdate", + "decorators": [], + "examples": [ + { + "$id": "6032", + "kind": "http", + "name": "SearchServiceCreateOrUpdateIndexer", + "description": "SearchServiceCreateOrUpdateIndexer", + "filePath": "2025-03-01-preview/SearchServiceCreateOrUpdateIndexer.json", + "parameters": [ + { + "$id": "6033", + "parameter": { + "$ref": "6021" + }, + "value": { + "$id": "6034", + "kind": "string", + "type": { + "$ref": "6022" + }, + "value": "myindexer" + } + }, + { + "$id": "6035", + "parameter": { + "$ref": "6003" + }, + "value": { + "$id": "6036", + "kind": "string", + "type": { + "$ref": "6004" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "6037", + "parameter": { + "$ref": "6018" + }, + "value": { + "$id": "6038", + "kind": "string", + "type": { + "$ref": "6019" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "6039", + "parameter": { + "$ref": "6011" + }, + "value": { + "$id": "6040", + "kind": "string", + "type": { + "$ref": "6012" + }, + "value": "return=representation" + } + }, + { + "$id": "6041", + "parameter": { + "$ref": "6029" + }, + "value": { + "$id": "6042", + "kind": "model", + "type": { + "$ref": "5091" + }, + "value": { + "$id": "6043", + "name": { + "$id": "6044", + "kind": "string", + "type": { + "$ref": "5093" + }, + "value": "myindexer" + }, + "description": { + "$id": "6045", + "kind": "string", + "type": { + "$ref": "5097" + }, + "value": "Description of the indexer" + }, + "dataSourceName": { + "$id": "6046", + "kind": "string", + "type": { + "$ref": "5101" + }, + "value": "mydocdbdatasource" + }, + "skillsetName": { + "$id": "6047", + "kind": "string", + "type": { + "$ref": "5105" + }, + "value": "myskillset" + }, + "targetIndexName": { + "$id": "6048", + "kind": "string", + "type": { + "$ref": "5109" + }, + "value": "preview-test" + }, + "schedule": { + "$id": "6049", + "kind": "model", + "type": { + "$ref": "5113" + }, + "value": { + "$id": "6050", + "interval": { + "$id": "6051", + "kind": "string", + "type": { + "$ref": "5115" + }, + "value": "P1D" + }, + "startTime": { + "$id": "6052", + "kind": "string", + "type": { + "$ref": "5120" + }, + "value": "2025-01-07T19:30:00Z" + } + } + }, + "parameters": { + "$id": "6053", + "kind": "model", + "type": { + "$ref": "5127" + }, + "value": { + "$id": "6054", + "batchSize": { + "$id": "6055", + "kind": "number", + "type": { + "$ref": "5129" + }, + "value": 10 + }, + "maxFailedItems": { + "$id": "6056", + "kind": "number", + "type": { + "$ref": "5133" + }, + "value": 10 + }, + "maxFailedItemsPerBatch": { + "$id": "6057", + "kind": "number", + "type": { + "$ref": "5137" + }, + "value": 5 + }, + "configuration": { + "$id": "6058", + "kind": "model", + "type": { + "$ref": "5141" + }, + "value": { + "$id": "6059", + "parsingMode": { + "$id": "6060", + "kind": "string", + "type": { + "$ref": "2072" + }, + "value": "markdown" + }, + "excludedFileNameExtensions": { + "$id": "6061", + "kind": "string", + "type": { + "$ref": "5147" + }, + "value": ".png,.mp4" + }, + "indexedFileNameExtensions": { + "$id": "6062", + "kind": "string", + "type": { + "$ref": "5151" + }, + "value": ".docx,.pptx" + }, + "failOnUnsupportedContentType": { + "$id": "6063", + "kind": "boolean", + "type": { + "$ref": "5155" + }, + "value": true + }, + "failOnUnprocessableDocument": { + "$id": "6064", + "kind": "boolean", + "type": { + "$ref": "5159" + }, + "value": false + }, + "indexStorageMetadataOnlyForOversizedDocuments": { + "$id": "6065", + "kind": "boolean", + "type": { + "$ref": "5163" + }, + "value": true + }, + "delimitedTextHeaders": { + "$id": "6066", + "kind": "string", + "type": { + "$ref": "5167" + }, + "value": "Header1,Header2" + }, + "delimitedTextDelimiter": { + "$id": "6067", + "kind": "string", + "type": { + "$ref": "5171" + }, + "value": "|" + }, + "firstLineContainsHeaders": { + "$id": "6068", + "kind": "boolean", + "type": { + "$ref": "5175" + }, + "value": true + }, + "markdownParsingSubmode": { + "$id": "6069", + "kind": "string", + "type": { + "$ref": "2088" + }, + "value": "oneToOne" + }, + "markdownHeaderDepth": { + "$id": "6070", + "kind": "string", + "type": { + "$ref": "2094" + }, + "value": "h6" + }, + "documentRoot": { + "$id": "6071", + "kind": "string", + "type": { + "$ref": "5185" + }, + "value": "/root" + }, + "dataToExtract": { + "$id": "6072", + "kind": "string", + "type": { + "$ref": "2108" + }, + "value": "storageMetadata" + }, + "imageAction": { + "$id": "6073", + "kind": "string", + "type": { + "$ref": "2116" + }, + "value": "none" + }, + "allowSkillsetToReadFileData": { + "$id": "6074", + "kind": "boolean", + "type": { + "$ref": "5195" + }, + "value": false + }, + "pdfTextRotationAlgorithm": { + "$id": "6075", + "kind": "string", + "type": { + "$ref": "2124" + }, + "value": "none" + }, + "executionEnvironment": { + "$id": "6076", + "kind": "string", + "type": { + "$ref": "2130" + }, + "value": "standard" + } + } + } + } + }, + "fieldMappings": { + "$id": "6077", + "kind": "array", + "type": { + "$ref": "5213" + }, + "value": [ + { + "$id": "6078", + "kind": "model", + "type": { + "$ref": "5214" + }, + "value": { + "$id": "6079", + "sourceFieldName": { + "$id": "6080", + "kind": "string", + "type": { + "$ref": "5216" + }, + "value": "/document" + }, + "targetFieldName": { + "$id": "6081", + "kind": "string", + "type": { + "$ref": "5220" + }, + "value": "name" + }, + "mappingFunction": { + "$id": "6082", + "kind": "model", + "type": { + "$ref": "5224" + }, + "value": { + "$id": "6083", + "name": { + "$id": "6084", + "kind": "string", + "type": { + "$ref": "5226" + }, + "value": "base64Encode" + } + } + } + } + } + ] + }, + "outputFieldMappings": { + "$id": "6085", + "kind": "array", + "type": { + "$ref": "5240" + }, + "value": [ + { + "$id": "6086", + "kind": "model", + "type": { + "$ref": "5214" + }, + "value": { + "$id": "6087", + "sourceFieldName": { + "$id": "6088", + "kind": "string", + "type": { + "$ref": "5216" + }, + "value": "/document" + }, + "targetFieldName": { + "$id": "6089", + "kind": "string", + "type": { + "$ref": "5220" + }, + "value": "name" + }, + "mappingFunction": { + "$id": "6090", + "kind": "model", + "type": { + "$ref": "5224" + }, + "value": { + "$id": "6091", + "name": { + "$id": "6092", + "kind": "string", + "type": { + "$ref": "5226" + }, + "value": "base64Encode" + } + } + } + } + } + ] + }, + "disabled": { + "$id": "6093", + "kind": "boolean", + "type": { + "$ref": "5244" + }, + "value": false + }, + "@odata.etag": { + "$id": "6094", + "kind": "string", + "type": { + "$ref": "5248" + }, + "value": "0x1234568AE7E58A1" + }, + "encryptionKey": { + "$id": "6095", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6096", + "keyVaultKeyName": { + "$id": "6097", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6098", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6099", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6100", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6101", + "applicationId": { + "$id": "6102", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6103", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ], + "responses": [ + { + "$id": "6104", + "response": { + "$ref": "6030" + }, + "statusCode": 200, + "bodyValue": { + "$id": "6105", + "kind": "model", + "type": { + "$ref": "5091" + }, + "value": { + "$id": "6106", + "@odata.etag": { + "$id": "6107", + "kind": "string", + "type": { + "$ref": "5248" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "6108", + "kind": "string", + "type": { + "$ref": "5093" + }, + "value": "myindexer" + }, + "description": { + "$id": "6109", + "kind": "string", + "type": { + "$ref": "5097" + }, + "value": "Description of the indexer" + }, + "dataSourceName": { + "$id": "6110", + "kind": "string", + "type": { + "$ref": "5101" + }, + "value": "mydocdbdatasource" + }, + "skillsetName": { + "$id": "6111", + "kind": "string", + "type": { + "$ref": "5105" + }, + "value": "myskillset" + }, + "targetIndexName": { + "$id": "6112", + "kind": "string", + "type": { + "$ref": "5109" + }, + "value": "preview-test" + }, + "disabled": { + "$id": "6113", + "kind": "boolean", + "type": { + "$ref": "5244" + }, + "value": false + }, + "schedule": { + "$id": "6114", + "kind": "model", + "type": { + "$ref": "5113" + }, + "value": { + "$id": "6115", + "interval": { + "$id": "6116", + "kind": "string", + "type": { + "$ref": "5115" + }, + "value": "P1D" + }, + "startTime": { + "$id": "6117", + "kind": "string", + "type": { + "$ref": "5120" + }, + "value": "2024-06-06T00:01:50.265Z" + } + } + }, + "parameters": { + "$id": "6118", + "kind": "model", + "type": { + "$ref": "5127" + }, + "value": { + "$id": "6119", + "batchSize": { + "$id": "6120", + "kind": "number", + "type": { + "$ref": "5129" + }, + "value": 10 + }, + "maxFailedItems": { + "$id": "6121", + "kind": "number", + "type": { + "$ref": "5133" + }, + "value": 10 + }, + "maxFailedItemsPerBatch": { + "$id": "6122", + "kind": "number", + "type": { + "$ref": "5137" + }, + "value": 5 + }, + "configuration": { + "$id": "6123", + "kind": "model", + "type": { + "$ref": "5141" + }, + "value": { + "$id": "6124", + "parsingMode": { + "$id": "6125", + "kind": "string", + "type": { + "$ref": "2072" + }, + "value": "markdown" + }, + "excludedFileNameExtensions": { + "$id": "6126", + "kind": "string", + "type": { + "$ref": "5147" + }, + "value": ".png,.mp4" + }, + "indexedFileNameExtensions": { + "$id": "6127", + "kind": "string", + "type": { + "$ref": "5151" + }, + "value": ".docx,.pptx" + }, + "failOnUnsupportedContentType": { + "$id": "6128", + "kind": "boolean", + "type": { + "$ref": "5155" + }, + "value": true + }, + "failOnUnprocessableDocument": { + "$id": "6129", + "kind": "boolean", + "type": { + "$ref": "5159" + }, + "value": false + }, + "indexStorageMetadataOnlyForOversizedDocuments": { + "$id": "6130", + "kind": "boolean", + "type": { + "$ref": "5163" + }, + "value": true + }, + "delimitedTextHeaders": { + "$id": "6131", + "kind": "string", + "type": { + "$ref": "5167" + }, + "value": "Header1,Header2" + }, + "delimitedTextDelimiter": { + "$id": "6132", + "kind": "string", + "type": { + "$ref": "5171" + }, + "value": "|" + }, + "firstLineContainsHeaders": { + "$id": "6133", + "kind": "boolean", + "type": { + "$ref": "5175" + }, + "value": true + }, + "markdownParsingSubmode": { + "$id": "6134", + "kind": "string", + "type": { + "$ref": "2088" + }, + "value": "oneToOne" + }, + "markdownHeaderDepth": { + "$id": "6135", + "kind": "string", + "type": { + "$ref": "2094" + }, + "value": "h6" + }, + "documentRoot": { + "$id": "6136", + "kind": "string", + "type": { + "$ref": "5185" + }, + "value": "/root" + }, + "dataToExtract": { + "$id": "6137", + "kind": "string", + "type": { + "$ref": "2108" + }, + "value": "storageMetadata" + }, + "imageAction": { + "$id": "6138", + "kind": "string", + "type": { + "$ref": "2116" + }, + "value": "none" + }, + "allowSkillsetToReadFileData": { + "$id": "6139", + "kind": "boolean", + "type": { + "$ref": "5195" + }, + "value": false + }, + "pdfTextRotationAlgorithm": { + "$id": "6140", + "kind": "string", + "type": { + "$ref": "2124" + }, + "value": "none" + }, + "executionEnvironment": { + "$id": "6141", + "kind": "string", + "type": { + "$ref": "2130" + }, + "value": "standard" + } + } + } + } + }, + "fieldMappings": { + "$id": "6142", + "kind": "array", + "type": { + "$ref": "5213" + }, + "value": [ + { + "$id": "6143", + "kind": "model", + "type": { + "$ref": "5214" + }, + "value": { + "$id": "6144", + "sourceFieldName": { + "$id": "6145", + "kind": "string", + "type": { + "$ref": "5216" + }, + "value": "/document" + }, + "targetFieldName": { + "$id": "6146", + "kind": "string", + "type": { + "$ref": "5220" + }, + "value": "name" + }, + "mappingFunction": { + "$id": "6147", + "kind": "model", + "type": { + "$ref": "5224" + }, + "value": { + "$id": "6148", + "name": { + "$id": "6149", + "kind": "string", + "type": { + "$ref": "5226" + }, + "value": "base64Encode" + } + } + } + } + } + ] + }, + "outputFieldMappings": { + "$id": "6150", + "kind": "array", + "type": { + "$ref": "5240" + }, + "value": [ + { + "$id": "6151", + "kind": "model", + "type": { + "$ref": "5214" + }, + "value": { + "$id": "6152", + "sourceFieldName": { + "$id": "6153", + "kind": "string", + "type": { + "$ref": "5216" + }, + "value": "/document" + }, + "targetFieldName": { + "$id": "6154", + "kind": "string", + "type": { + "$ref": "5220" + }, + "value": "name" + }, + "mappingFunction": { + "$id": "6155", + "kind": "model", + "type": { + "$ref": "5224" + }, + "value": { + "$id": "6156", + "name": { + "$id": "6157", + "kind": "string", + "type": { + "$ref": "5226" + }, + "value": "base64Encode" + } + } + } + } + } + ] + }, + "encryptionKey": { + "$id": "6158", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6159", + "keyVaultKeyName": { + "$id": "6160", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6161", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6162", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6163", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6164", + "applicationId": { + "$id": "6165", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6166", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + }, + { + "$id": "6167", + "response": { + "$ref": "6031" + }, + "statusCode": 201, + "bodyValue": { + "$id": "6168", + "kind": "model", + "type": { + "$ref": "5091" + }, + "value": { + "$id": "6169", + "@odata.etag": { + "$id": "6170", + "kind": "string", + "type": { + "$ref": "5248" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "6171", + "kind": "string", + "type": { + "$ref": "5093" + }, + "value": "myindexer" + }, + "description": { + "$id": "6172", + "kind": "string", + "type": { + "$ref": "5097" + }, + "value": "Description of the indexer" + }, + "dataSourceName": { + "$id": "6173", + "kind": "string", + "type": { + "$ref": "5101" + }, + "value": "mydocdbdatasource" + }, + "skillsetName": { + "$id": "6174", + "kind": "string", + "type": { + "$ref": "5105" + }, + "value": "myskillset" + }, + "targetIndexName": { + "$id": "6175", + "kind": "string", + "type": { + "$ref": "5109" + }, + "value": "preview-test" + }, + "disabled": { + "$id": "6176", + "kind": "boolean", + "type": { + "$ref": "5244" + }, + "value": false + }, + "schedule": { + "$id": "6177", + "kind": "model", + "type": { + "$ref": "5113" + }, + "value": { + "$id": "6178", + "interval": { + "$id": "6179", + "kind": "string", + "type": { + "$ref": "5115" + }, + "value": "P1D" + }, + "startTime": { + "$id": "6180", + "kind": "string", + "type": { + "$ref": "5120" + }, + "value": "2024-06-06T00:01:50.265Z" + } + } + }, + "parameters": { + "$id": "6181", + "kind": "model", + "type": { + "$ref": "5127" + }, + "value": { + "$id": "6182", + "batchSize": { + "$id": "6183", + "kind": "number", + "type": { + "$ref": "5129" + }, + "value": 10 + }, + "maxFailedItems": { + "$id": "6184", + "kind": "number", + "type": { + "$ref": "5133" + }, + "value": 10 + }, + "maxFailedItemsPerBatch": { + "$id": "6185", + "kind": "number", + "type": { + "$ref": "5137" + }, + "value": 5 + }, + "configuration": { + "$id": "6186", + "kind": "model", + "type": { + "$ref": "5141" + }, + "value": { + "$id": "6187", + "parsingMode": { + "$id": "6188", + "kind": "string", + "type": { + "$ref": "2072" + }, + "value": "markdown" + }, + "excludedFileNameExtensions": { + "$id": "6189", + "kind": "string", + "type": { + "$ref": "5147" + }, + "value": ".png,.mp4" + }, + "indexedFileNameExtensions": { + "$id": "6190", + "kind": "string", + "type": { + "$ref": "5151" + }, + "value": ".docx,.pptx" + }, + "failOnUnsupportedContentType": { + "$id": "6191", + "kind": "boolean", + "type": { + "$ref": "5155" + }, + "value": true + }, + "failOnUnprocessableDocument": { + "$id": "6192", + "kind": "boolean", + "type": { + "$ref": "5159" + }, + "value": false + }, + "indexStorageMetadataOnlyForOversizedDocuments": { + "$id": "6193", + "kind": "boolean", + "type": { + "$ref": "5163" + }, + "value": true + }, + "delimitedTextHeaders": { + "$id": "6194", + "kind": "string", + "type": { + "$ref": "5167" + }, + "value": "Header1,Header2" + }, + "delimitedTextDelimiter": { + "$id": "6195", + "kind": "string", + "type": { + "$ref": "5171" + }, + "value": "|" + }, + "firstLineContainsHeaders": { + "$id": "6196", + "kind": "boolean", + "type": { + "$ref": "5175" + }, + "value": true + }, + "markdownParsingSubmode": { + "$id": "6197", + "kind": "string", + "type": { + "$ref": "2088" + }, + "value": "oneToOne" + }, + "markdownHeaderDepth": { + "$id": "6198", + "kind": "string", + "type": { + "$ref": "2094" + }, + "value": "h6" + }, + "documentRoot": { + "$id": "6199", + "kind": "string", + "type": { + "$ref": "5185" + }, + "value": "/root" + }, + "dataToExtract": { + "$id": "6200", + "kind": "string", + "type": { + "$ref": "2108" + }, + "value": "storageMetadata" + }, + "imageAction": { + "$id": "6201", + "kind": "string", + "type": { + "$ref": "2116" + }, + "value": "none" + }, + "allowSkillsetToReadFileData": { + "$id": "6202", + "kind": "boolean", + "type": { + "$ref": "5195" + }, + "value": false + }, + "pdfTextRotationAlgorithm": { + "$id": "6203", + "kind": "string", + "type": { + "$ref": "2124" + }, + "value": "none" + }, + "executionEnvironment": { + "$id": "6204", + "kind": "string", + "type": { + "$ref": "2130" + }, + "value": "standard" + } + } + } + } + }, + "fieldMappings": { + "$id": "6205", + "kind": "array", + "type": { + "$ref": "5213" + }, + "value": [ + { + "$id": "6206", + "kind": "model", + "type": { + "$ref": "5214" + }, + "value": { + "$id": "6207", + "sourceFieldName": { + "$id": "6208", + "kind": "string", + "type": { + "$ref": "5216" + }, + "value": "/document" + }, + "targetFieldName": { + "$id": "6209", + "kind": "string", + "type": { + "$ref": "5220" + }, + "value": "name" + }, + "mappingFunction": { + "$id": "6210", + "kind": "model", + "type": { + "$ref": "5224" + }, + "value": { + "$id": "6211", + "name": { + "$id": "6212", + "kind": "string", + "type": { + "$ref": "5226" + }, + "value": "base64Encode" + } + } + } + } + } + ] + }, + "outputFieldMappings": { + "$id": "6213", + "kind": "array", + "type": { + "$ref": "5240" + }, + "value": [ + { + "$id": "6214", + "kind": "model", + "type": { + "$ref": "5214" + }, + "value": { + "$id": "6215", + "sourceFieldName": { + "$id": "6216", + "kind": "string", + "type": { + "$ref": "5216" + }, + "value": "/document" + }, + "targetFieldName": { + "$id": "6217", + "kind": "string", + "type": { + "$ref": "5220" + }, + "value": "name" + }, + "mappingFunction": { + "$id": "6218", + "kind": "model", + "type": { + "$ref": "5224" + }, + "value": { + "$id": "6219", + "name": { + "$id": "6220", + "kind": "string", + "type": { + "$ref": "5226" + }, + "value": "base64Encode" + } + } + } + } + } + ] + }, + "encryptionKey": { + "$id": "6221", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6222", + "keyVaultKeyName": { + "$id": "6223", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6224", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6225", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6226", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6227", + "applicationId": { + "$id": "6228", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6229", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ] + } + ] + }, + { + "$id": "6230", + "name": "delete", + "resourceName": "Indexers", + "doc": "Deletes an indexer.", + "accessibility": "public", + "parameters": [ + { + "$id": "6231", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "6232", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "6233", + "type": { + "$id": "6234", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6235", + "name": "ifMatch", + "nameInRequest": "If-Match", + "doc": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "type": { + "$id": "6236", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6237", + "name": "ifNoneMatch", + "nameInRequest": "If-None-Match", + "doc": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "type": { + "$id": "6238", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6239", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "6240", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "6241", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6242", + "name": "indexerName", + "nameInRequest": "indexerName", + "doc": "The name of the indexer.", + "type": { + "$id": "6243", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6244", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "6245", + "kind": "constant", + "valueType": { + "$id": "6246", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "6247", + "statusCodes": [ + 204 + ], + "headers": [], + "isErrorResponse": false + }, + { + "$id": "6248", + "statusCodes": [ + 404 + ], + "headers": [], + "isErrorResponse": false + } + ], + "httpMethod": "DELETE", + "uri": "{endpoint}", + "path": "/indexers('{indexerName}')", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexers.delete", + "decorators": [], + "examples": [ + { + "$id": "6249", + "kind": "http", + "name": "SearchServiceDeleteIndexer", + "description": "SearchServiceDeleteIndexer", + "filePath": "2025-03-01-preview/SearchServiceDeleteIndexer.json", + "parameters": [ + { + "$id": "6250", + "parameter": { + "$ref": "6242" + }, + "value": { + "$id": "6251", + "kind": "string", + "type": { + "$ref": "6243" + }, + "value": "tempindexer" + } + }, + { + "$id": "6252", + "parameter": { + "$ref": "6231" + }, + "value": { + "$id": "6253", + "kind": "string", + "type": { + "$ref": "6232" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "6254", + "parameter": { + "$ref": "6239" + }, + "value": { + "$id": "6255", + "kind": "string", + "type": { + "$ref": "6240" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "6256", + "response": { + "$ref": "6247" + }, + "statusCode": 204 + }, + { + "$id": "6257", + "response": { + "$ref": "6248" + }, + "statusCode": 404 + } + ] + } + ] + }, + { + "$id": "6258", + "name": "get", + "resourceName": "Indexers", + "doc": "Retrieves an indexer definition.", + "accessibility": "public", + "parameters": [ + { + "$id": "6259", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "6260", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "6261", + "type": { + "$id": "6262", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6263", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "6264", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "6265", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6266", + "name": "indexerName", + "nameInRequest": "indexerName", + "doc": "The name of the indexer.", + "type": { + "$id": "6267", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6268", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "6269", + "kind": "constant", + "valueType": { + "$id": "6270", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "6271", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "5091" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/indexers('{indexerName}')", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexers.get", + "decorators": [], + "examples": [ + { + "$id": "6272", + "kind": "http", + "name": "SearchServiceGetIndexer", + "description": "SearchServiceGetIndexer", + "filePath": "2025-03-01-preview/SearchServiceGetIndexer.json", + "parameters": [ + { + "$id": "6273", + "parameter": { + "$ref": "6266" + }, + "value": { + "$id": "6274", + "kind": "string", + "type": { + "$ref": "6267" + }, + "value": "myindexer" + } + }, + { + "$id": "6275", + "parameter": { + "$ref": "6259" + }, + "value": { + "$id": "6276", + "kind": "string", + "type": { + "$ref": "6260" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "6277", + "parameter": { + "$ref": "6263" + }, + "value": { + "$id": "6278", + "kind": "string", + "type": { + "$ref": "6264" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "6279", + "response": { + "$ref": "6271" + }, + "statusCode": 200, + "bodyValue": { + "$id": "6280", + "kind": "model", + "type": { + "$ref": "5091" + }, + "value": { + "$id": "6281", + "@odata.etag": { + "$id": "6282", + "kind": "string", + "type": { + "$ref": "5248" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "6283", + "kind": "string", + "type": { + "$ref": "5093" + }, + "value": "myindexer" + }, + "description": { + "$id": "6284", + "kind": "string", + "type": { + "$ref": "5097" + }, + "value": "Description of the indexer" + }, + "dataSourceName": { + "$id": "6285", + "kind": "string", + "type": { + "$ref": "5101" + }, + "value": "mydocdbdatasource" + }, + "skillsetName": { + "$id": "6286", + "kind": "string", + "type": { + "$ref": "5105" + }, + "value": "myskillset" + }, + "targetIndexName": { + "$id": "6287", + "kind": "string", + "type": { + "$ref": "5109" + }, + "value": "preview-test" + }, + "disabled": { + "$id": "6288", + "kind": "boolean", + "type": { + "$ref": "5244" + }, + "value": false + }, + "schedule": { + "$id": "6289", + "kind": "model", + "type": { + "$ref": "5113" + }, + "value": { + "$id": "6290", + "interval": { + "$id": "6291", + "kind": "string", + "type": { + "$ref": "5115" + }, + "value": "P1D" + }, + "startTime": { + "$id": "6292", + "kind": "string", + "type": { + "$ref": "5120" + }, + "value": "2024-06-06T00:01:50.265Z" + } + } + }, + "parameters": { + "$id": "6293", + "kind": "model", + "type": { + "$ref": "5127" + }, + "value": { + "$id": "6294", + "batchSize": { + "$id": "6295", + "kind": "number", + "type": { + "$ref": "5129" + }, + "value": 10 + }, + "maxFailedItems": { + "$id": "6296", + "kind": "number", + "type": { + "$ref": "5133" + }, + "value": 10 + }, + "maxFailedItemsPerBatch": { + "$id": "6297", + "kind": "number", + "type": { + "$ref": "5137" + }, + "value": 5 + }, + "configuration": { + "$id": "6298", + "kind": "model", + "type": { + "$ref": "5141" + }, + "value": { + "$id": "6299" + } + } + } + }, + "fieldMappings": { + "$id": "6300", + "kind": "array", + "type": { + "$ref": "5213" + }, + "value": [ + { + "$id": "6301", + "kind": "model", + "type": { + "$ref": "5214" + }, + "value": { + "$id": "6302", + "sourceFieldName": { + "$id": "6303", + "kind": "string", + "type": { + "$ref": "5216" + }, + "value": "/document" + }, + "targetFieldName": { + "$id": "6304", + "kind": "string", + "type": { + "$ref": "5220" + }, + "value": "name" + }, + "mappingFunction": { + "$id": "6305", + "kind": "model", + "type": { + "$ref": "5224" + }, + "value": { + "$id": "6306", + "name": { + "$id": "6307", + "kind": "string", + "type": { + "$ref": "5226" + }, + "value": "base64Encode" + } + } + } + } + } + ] + }, + "outputFieldMappings": { + "$id": "6308", + "kind": "array", + "type": { + "$ref": "5240" + }, + "value": [ + { + "$id": "6309", + "kind": "model", + "type": { + "$ref": "5214" + }, + "value": { + "$id": "6310", + "sourceFieldName": { + "$id": "6311", + "kind": "string", + "type": { + "$ref": "5216" + }, + "value": "/document" + }, + "targetFieldName": { + "$id": "6312", + "kind": "string", + "type": { + "$ref": "5220" + }, + "value": "name" + }, + "mappingFunction": { + "$id": "6313", + "kind": "model", + "type": { + "$ref": "5224" + }, + "value": { + "$id": "6314", + "name": { + "$id": "6315", + "kind": "string", + "type": { + "$ref": "5226" + }, + "value": "base64Encode" + } + } + } + } + } + ] + }, + "encryptionKey": { + "$id": "6316", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6317", + "keyVaultKeyName": { + "$id": "6318", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6319", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6320", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6321", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6322", + "applicationId": { + "$id": "6323", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6324", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ] + } + ] + }, + { + "$id": "6325", + "name": "list", + "resourceName": "Indexers", + "doc": "Lists all indexers available for a search service.", + "accessibility": "public", + "parameters": [ + { + "$id": "6326", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "6327", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "6328", + "type": { + "$id": "6329", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6330", + "name": "$select", + "nameInRequest": "$select", + "doc": "Selects which top-level properties to retrieve.\nSpecified as a comma-separated list of JSON property names,\nor '*' for all properties. The default is all properties.", + "type": { + "$id": "6331", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6332", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "6333", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "6334", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6335", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "6336", + "kind": "constant", + "valueType": { + "$id": "6337", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "6338", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "5273" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/indexers", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexers.list", + "decorators": [], + "examples": [ + { + "$id": "6339", + "kind": "http", + "name": "SearchServiceListIndexers", + "description": "SearchServiceListIndexers", + "filePath": "2025-03-01-preview/SearchServiceListIndexers.json", + "parameters": [ + { + "$id": "6340", + "parameter": { + "$ref": "6330" + }, + "value": { + "$id": "6341", + "kind": "string", + "type": { + "$ref": "6331" + }, + "value": "*" + } + }, + { + "$id": "6342", + "parameter": { + "$ref": "6326" + }, + "value": { + "$id": "6343", + "kind": "string", + "type": { + "$ref": "6327" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "6344", + "parameter": { + "$ref": "6332" + }, + "value": { + "$id": "6345", + "kind": "string", + "type": { + "$ref": "6333" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "6346", + "response": { + "$ref": "6338" + }, + "statusCode": 200, + "bodyValue": { + "$id": "6347", + "kind": "model", + "type": { + "$ref": "5273" + }, + "value": { + "$id": "6348", + "value": { + "$id": "6349", + "kind": "array", + "type": { + "$ref": "5275" + }, + "value": [ + { + "$id": "6350", + "kind": "model", + "type": { + "$ref": "5091" + }, + "value": { + "$id": "6351", + "name": { + "$id": "6352", + "kind": "string", + "type": { + "$ref": "5093" + }, + "value": "myindexer" + }, + "description": { + "$id": "6353", + "kind": "string", + "type": { + "$ref": "5097" + }, + "value": "Description of the indexer" + }, + "dataSourceName": { + "$id": "6354", + "kind": "string", + "type": { + "$ref": "5101" + }, + "value": "mydocdbdatasource" + }, + "skillsetName": { + "$id": "6355", + "kind": "string", + "type": { + "$ref": "5105" + }, + "value": "myskillset" + }, + "targetIndexName": { + "$id": "6356", + "kind": "string", + "type": { + "$ref": "5109" + }, + "value": "preview-test" + }, + "disabled": { + "$id": "6357", + "kind": "boolean", + "type": { + "$ref": "5244" + }, + "value": false + }, + "schedule": { + "$id": "6358", + "kind": "model", + "type": { + "$ref": "5113" + }, + "value": { + "$id": "6359", + "interval": { + "$id": "6360", + "kind": "string", + "type": { + "$ref": "5115" + }, + "value": "P1D" + }, + "startTime": { + "$id": "6361", + "kind": "string", + "type": { + "$ref": "5120" + }, + "value": "2024-06-06T00:01:50.265Z" + } + } + }, + "parameters": { + "$id": "6362", + "kind": "model", + "type": { + "$ref": "5127" + }, + "value": { + "$id": "6363", + "batchSize": { + "$id": "6364", + "kind": "number", + "type": { + "$ref": "5129" + }, + "value": 10 + }, + "maxFailedItems": { + "$id": "6365", + "kind": "number", + "type": { + "$ref": "5133" + }, + "value": 10 + }, + "maxFailedItemsPerBatch": { + "$id": "6366", + "kind": "number", + "type": { + "$ref": "5137" + }, + "value": 5 + }, + "configuration": { + "$id": "6367", + "kind": "model", + "type": { + "$ref": "5141" + }, + "value": { + "$id": "6368" + } + } + } + }, + "fieldMappings": { + "$id": "6369", + "kind": "array", + "type": { + "$ref": "5213" + }, + "value": [ + { + "$id": "6370", + "kind": "model", + "type": { + "$ref": "5214" + }, + "value": { + "$id": "6371", + "sourceFieldName": { + "$id": "6372", + "kind": "string", + "type": { + "$ref": "5216" + }, + "value": "/document" + }, + "targetFieldName": { + "$id": "6373", + "kind": "string", + "type": { + "$ref": "5220" + }, + "value": "name" + }, + "mappingFunction": { + "$id": "6374", + "kind": "model", + "type": { + "$ref": "5224" + }, + "value": { + "$id": "6375", + "name": { + "$id": "6376", + "kind": "string", + "type": { + "$ref": "5226" + }, + "value": "base64Encode" + } + } + } + } + } + ] + }, + "outputFieldMappings": { + "$id": "6377", + "kind": "array", + "type": { + "$ref": "5240" + }, + "value": [ + { + "$id": "6378", + "kind": "model", + "type": { + "$ref": "5214" + }, + "value": { + "$id": "6379", + "sourceFieldName": { + "$id": "6380", + "kind": "string", + "type": { + "$ref": "5216" + }, + "value": "/document" + }, + "targetFieldName": { + "$id": "6381", + "kind": "string", + "type": { + "$ref": "5220" + }, + "value": "name" + }, + "mappingFunction": { + "$id": "6382", + "kind": "model", + "type": { + "$ref": "5224" + }, + "value": { + "$id": "6383", + "name": { + "$id": "6384", + "kind": "string", + "type": { + "$ref": "5226" + }, + "value": "base64Encode" + } + } + } + } + } + ] + }, + "encryptionKey": { + "$id": "6385", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6386", + "keyVaultKeyName": { + "$id": "6387", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6388", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6389", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6390", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6391", + "applicationId": { + "$id": "6392", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6393", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + ] + } + } + } + } + ] + } + ] + }, + { + "$id": "6394", + "name": "create", + "resourceName": "Indexers", + "doc": "Creates a new indexer.", + "accessibility": "public", + "parameters": [ + { + "$id": "6395", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "6396", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "6397", + "type": { + "$id": "6398", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6399", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "6400", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "6401", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6402", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "6403", + "kind": "constant", + "valueType": { + "$id": "6404", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6405", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "6406", + "kind": "constant", + "valueType": { + "$id": "6407", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6408", + "name": "indexer", + "nameInRequest": "indexer", + "doc": "The definition of the indexer to create.", + "type": { + "$ref": "5091" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "6409", + "statusCodes": [ + 201 + ], + "bodyType": { + "$ref": "5091" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "POST", + "uri": "{endpoint}", + "path": "/indexers", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexers.create", + "decorators": [], + "examples": [ + { + "$id": "6410", + "kind": "http", + "name": "SearchServiceCreateIndexer", + "description": "SearchServiceCreateIndexer", + "filePath": "2025-03-01-preview/SearchServiceCreateIndexer.json", + "parameters": [ + { + "$id": "6411", + "parameter": { + "$ref": "6395" + }, + "value": { + "$id": "6412", + "kind": "string", + "type": { + "$ref": "6396" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "6413", + "parameter": { + "$ref": "6399" + }, + "value": { + "$id": "6414", + "kind": "string", + "type": { + "$ref": "6400" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "6415", + "parameter": { + "$ref": "6408" + }, + "value": { + "$id": "6416", + "kind": "model", + "type": { + "$ref": "5091" + }, + "value": { + "$id": "6417", + "name": { + "$id": "6418", + "kind": "string", + "type": { + "$ref": "5093" + }, + "value": "myindexer" + }, + "description": { + "$id": "6419", + "kind": "string", + "type": { + "$ref": "5097" + }, + "value": "Description of the indexer" + }, + "dataSourceName": { + "$id": "6420", + "kind": "string", + "type": { + "$ref": "5101" + }, + "value": "mydocdbdatasource" + }, + "skillsetName": { + "$id": "6421", + "kind": "string", + "type": { + "$ref": "5105" + }, + "value": "myskillset" + }, + "targetIndexName": { + "$id": "6422", + "kind": "string", + "type": { + "$ref": "5109" + }, + "value": "preview-test" + }, + "schedule": { + "$id": "6423", + "kind": "model", + "type": { + "$ref": "5113" + }, + "value": { + "$id": "6424", + "interval": { + "$id": "6425", + "kind": "string", + "type": { + "$ref": "5115" + }, + "value": "P1D" + }, + "startTime": { + "$id": "6426", + "kind": "string", + "type": { + "$ref": "5120" + }, + "value": "2025-01-07T19:30:00Z" + } + } + }, + "parameters": { + "$id": "6427", + "kind": "model", + "type": { + "$ref": "5127" + }, + "value": { + "$id": "6428", + "batchSize": { + "$id": "6429", + "kind": "number", + "type": { + "$ref": "5129" + }, + "value": 10 + }, + "maxFailedItems": { + "$id": "6430", + "kind": "number", + "type": { + "$ref": "5133" + }, + "value": 10 + }, + "maxFailedItemsPerBatch": { + "$id": "6431", + "kind": "number", + "type": { + "$ref": "5137" + }, + "value": 5 + }, + "configuration": { + "$id": "6432", + "kind": "model", + "type": { + "$ref": "5141" + }, + "value": { + "$id": "6433", + "parsingMode": { + "$id": "6434", + "kind": "string", + "type": { + "$ref": "2072" + }, + "value": "markdown" + }, + "excludedFileNameExtensions": { + "$id": "6435", + "kind": "string", + "type": { + "$ref": "5147" + }, + "value": ".png,.mp4" + }, + "indexedFileNameExtensions": { + "$id": "6436", + "kind": "string", + "type": { + "$ref": "5151" + }, + "value": ".docx,.pptx" + }, + "failOnUnsupportedContentType": { + "$id": "6437", + "kind": "boolean", + "type": { + "$ref": "5155" + }, + "value": true + }, + "failOnUnprocessableDocument": { + "$id": "6438", + "kind": "boolean", + "type": { + "$ref": "5159" + }, + "value": false + }, + "indexStorageMetadataOnlyForOversizedDocuments": { + "$id": "6439", + "kind": "boolean", + "type": { + "$ref": "5163" + }, + "value": true + }, + "delimitedTextHeaders": { + "$id": "6440", + "kind": "string", + "type": { + "$ref": "5167" + }, + "value": "Header1,Header2" + }, + "delimitedTextDelimiter": { + "$id": "6441", + "kind": "string", + "type": { + "$ref": "5171" + }, + "value": "|" + }, + "firstLineContainsHeaders": { + "$id": "6442", + "kind": "boolean", + "type": { + "$ref": "5175" + }, + "value": true + }, + "markdownParsingSubmode": { + "$id": "6443", + "kind": "string", + "type": { + "$ref": "2088" + }, + "value": "oneToMany" + }, + "markdownHeaderDepth": { + "$id": "6444", + "kind": "string", + "type": { + "$ref": "2094" + }, + "value": "h6" + }, + "documentRoot": { + "$id": "6445", + "kind": "string", + "type": { + "$ref": "5185" + }, + "value": "/root" + }, + "dataToExtract": { + "$id": "6446", + "kind": "string", + "type": { + "$ref": "2108" + }, + "value": "storageMetadata" + }, + "imageAction": { + "$id": "6447", + "kind": "string", + "type": { + "$ref": "2116" + }, + "value": "none" + }, + "allowSkillsetToReadFileData": { + "$id": "6448", + "kind": "boolean", + "type": { + "$ref": "5195" + }, + "value": false + }, + "pdfTextRotationAlgorithm": { + "$id": "6449", + "kind": "string", + "type": { + "$ref": "2124" + }, + "value": "none" + }, + "executionEnvironment": { + "$id": "6450", + "kind": "string", + "type": { + "$ref": "2130" + }, + "value": "standard" + } + } + } + } + }, + "fieldMappings": { + "$id": "6451", + "kind": "array", + "type": { + "$ref": "5213" + }, + "value": [ + { + "$id": "6452", + "kind": "model", + "type": { + "$ref": "5214" + }, + "value": { + "$id": "6453", + "sourceFieldName": { + "$id": "6454", + "kind": "string", + "type": { + "$ref": "5216" + }, + "value": "/document" + }, + "targetFieldName": { + "$id": "6455", + "kind": "string", + "type": { + "$ref": "5220" + }, + "value": "name" + }, + "mappingFunction": { + "$id": "6456", + "kind": "model", + "type": { + "$ref": "5224" + }, + "value": { + "$id": "6457", + "name": { + "$id": "6458", + "kind": "string", + "type": { + "$ref": "5226" + }, + "value": "base64Encode" + } + } + } + } + } + ] + }, + "outputFieldMappings": { + "$id": "6459", + "kind": "array", + "type": { + "$ref": "5240" + }, + "value": [ + { + "$id": "6460", + "kind": "model", + "type": { + "$ref": "5214" + }, + "value": { + "$id": "6461", + "sourceFieldName": { + "$id": "6462", + "kind": "string", + "type": { + "$ref": "5216" + }, + "value": "/document" + }, + "targetFieldName": { + "$id": "6463", + "kind": "string", + "type": { + "$ref": "5220" + }, + "value": "name" + }, + "mappingFunction": { + "$id": "6464", + "kind": "model", + "type": { + "$ref": "5224" + }, + "value": { + "$id": "6465", + "name": { + "$id": "6466", + "kind": "string", + "type": { + "$ref": "5226" + }, + "value": "base64Encode" + } + } + } + } + } + ] + }, + "disabled": { + "$id": "6467", + "kind": "boolean", + "type": { + "$ref": "5244" + }, + "value": false + }, + "@odata.etag": { + "$id": "6468", + "kind": "string", + "type": { + "$ref": "5248" + }, + "value": "0x1234568AE7E58A1" + }, + "encryptionKey": { + "$id": "6469", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6470", + "keyVaultKeyName": { + "$id": "6471", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6472", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6473", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6474", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6475", + "applicationId": { + "$id": "6476", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6477", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + }, + "cache": { + "$id": "6478", + "kind": "model", + "type": { + "$ref": "5255" + }, + "value": { + "$id": "6479", + "storageConnectionString": { + "$id": "6480", + "kind": "string", + "type": { + "$ref": "5257" + }, + "value": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + }, + "enableReprocessing": { + "$id": "6481", + "kind": "boolean", + "type": { + "$ref": "5261" + }, + "value": true + } + } + } + } + } + } + ], + "responses": [ + { + "$id": "6482", + "response": { + "$ref": "6409" + }, + "statusCode": 201, + "bodyValue": { + "$id": "6483", + "kind": "model", + "type": { + "$ref": "5091" + }, + "value": { + "$id": "6484", + "name": { + "$id": "6485", + "kind": "string", + "type": { + "$ref": "5093" + }, + "value": "myindexer" + }, + "description": { + "$id": "6486", + "kind": "string", + "type": { + "$ref": "5097" + }, + "value": "Description of the indexer" + }, + "dataSourceName": { + "$id": "6487", + "kind": "string", + "type": { + "$ref": "5101" + }, + "value": "mydocdbdatasource" + }, + "skillsetName": { + "$id": "6488", + "kind": "string", + "type": { + "$ref": "5105" + }, + "value": "myskillset" + }, + "targetIndexName": { + "$id": "6489", + "kind": "string", + "type": { + "$ref": "5109" + }, + "value": "preview-test" + }, + "disabled": { + "$id": "6490", + "kind": "boolean", + "type": { + "$ref": "5244" + }, + "value": false + }, + "schedule": { + "$id": "6491", + "kind": "model", + "type": { + "$ref": "5113" + }, + "value": { + "$id": "6492", + "interval": { + "$id": "6493", + "kind": "string", + "type": { + "$ref": "5115" + }, + "value": "P1D" + }, + "startTime": { + "$id": "6494", + "kind": "string", + "type": { + "$ref": "5120" + }, + "value": "2024-06-06T00:01:50.265Z" + } + } + }, + "parameters": { + "$id": "6495", + "kind": "model", + "type": { + "$ref": "5127" + }, + "value": { + "$id": "6496", + "batchSize": { + "$id": "6497", + "kind": "number", + "type": { + "$ref": "5129" + }, + "value": 10 + }, + "maxFailedItems": { + "$id": "6498", + "kind": "number", + "type": { + "$ref": "5133" + }, + "value": 10 + }, + "maxFailedItemsPerBatch": { + "$id": "6499", + "kind": "number", + "type": { + "$ref": "5137" + }, + "value": 5 + }, + "configuration": { + "$id": "6500", + "kind": "model", + "type": { + "$ref": "5141" + }, + "value": { + "$id": "6501", + "parsingMode": { + "$id": "6502", + "kind": "string", + "type": { + "$ref": "2072" + }, + "value": "markdown" + }, + "excludedFileNameExtensions": { + "$id": "6503", + "kind": "string", + "type": { + "$ref": "5147" + }, + "value": ".png,.mp4" + }, + "indexedFileNameExtensions": { + "$id": "6504", + "kind": "string", + "type": { + "$ref": "5151" + }, + "value": ".docx,.pptx" + }, + "failOnUnsupportedContentType": { + "$id": "6505", + "kind": "boolean", + "type": { + "$ref": "5155" + }, + "value": true + }, + "failOnUnprocessableDocument": { + "$id": "6506", + "kind": "boolean", + "type": { + "$ref": "5159" + }, + "value": false + }, + "indexStorageMetadataOnlyForOversizedDocuments": { + "$id": "6507", + "kind": "boolean", + "type": { + "$ref": "5163" + }, + "value": true + }, + "delimitedTextHeaders": { + "$id": "6508", + "kind": "string", + "type": { + "$ref": "5167" + }, + "value": "Header1,Header2" + }, + "delimitedTextDelimiter": { + "$id": "6509", + "kind": "string", + "type": { + "$ref": "5171" + }, + "value": "|" + }, + "firstLineContainsHeaders": { + "$id": "6510", + "kind": "boolean", + "type": { + "$ref": "5175" + }, + "value": true + }, + "markdownParsingSubmode": { + "$id": "6511", + "kind": "string", + "type": { + "$ref": "2088" + }, + "value": "oneToMany" + }, + "markdownHeaderDepth": { + "$id": "6512", + "kind": "string", + "type": { + "$ref": "2094" + }, + "value": "h6" + }, + "documentRoot": { + "$id": "6513", + "kind": "string", + "type": { + "$ref": "5185" + }, + "value": "/root" + }, + "dataToExtract": { + "$id": "6514", + "kind": "string", + "type": { + "$ref": "2108" + }, + "value": "storageMetadata" + }, + "imageAction": { + "$id": "6515", + "kind": "string", + "type": { + "$ref": "2116" + }, + "value": "none" + }, + "allowSkillsetToReadFileData": { + "$id": "6516", + "kind": "boolean", + "type": { + "$ref": "5195" + }, + "value": false + }, + "pdfTextRotationAlgorithm": { + "$id": "6517", + "kind": "string", + "type": { + "$ref": "2124" + }, + "value": "none" + }, + "executionEnvironment": { + "$id": "6518", + "kind": "string", + "type": { + "$ref": "2130" + }, + "value": "standard" + } + } + } + } + }, + "fieldMappings": { + "$id": "6519", + "kind": "array", + "type": { + "$ref": "5213" + }, + "value": [ + { + "$id": "6520", + "kind": "model", + "type": { + "$ref": "5214" + }, + "value": { + "$id": "6521", + "sourceFieldName": { + "$id": "6522", + "kind": "string", + "type": { + "$ref": "5216" + }, + "value": "/document" + }, + "targetFieldName": { + "$id": "6523", + "kind": "string", + "type": { + "$ref": "5220" + }, + "value": "name" + }, + "mappingFunction": { + "$id": "6524", + "kind": "model", + "type": { + "$ref": "5224" + }, + "value": { + "$id": "6525", + "name": { + "$id": "6526", + "kind": "string", + "type": { + "$ref": "5226" + }, + "value": "base64Encode" + } + } + } + } + } + ] + }, + "outputFieldMappings": { + "$id": "6527", + "kind": "array", + "type": { + "$ref": "5240" + }, + "value": [ + { + "$id": "6528", + "kind": "model", + "type": { + "$ref": "5214" + }, + "value": { + "$id": "6529", + "sourceFieldName": { + "$id": "6530", + "kind": "string", + "type": { + "$ref": "5216" + }, + "value": "/document" + }, + "targetFieldName": { + "$id": "6531", + "kind": "string", + "type": { + "$ref": "5220" + }, + "value": "name" + }, + "mappingFunction": { + "$id": "6532", + "kind": "model", + "type": { + "$ref": "5224" + }, + "value": { + "$id": "6533", + "name": { + "$id": "6534", + "kind": "string", + "type": { + "$ref": "5226" + }, + "value": "base64Encode" + } + } + } + } + } + ] + }, + "cache": { + "$id": "6535", + "kind": "model", + "type": { + "$ref": "5255" + }, + "value": { + "$id": "6536", + "id": { + "$id": "6537", + "kind": "string", + "type": { + "$ref": "5268" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "enableReprocessing": { + "$id": "6538", + "kind": "boolean", + "type": { + "$ref": "5261" + }, + "value": true + }, + "storageConnectionString": { + "$id": "6539", + "kind": "string", + "type": { + "$ref": "5257" + }, + "value": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net " + } + } + }, + "encryptionKey": { + "$id": "6540", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6541", + "keyVaultKeyName": { + "$id": "6542", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6543", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6544", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6545", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6546", + "applicationId": { + "$id": "6547", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6548", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ] + } + ] + }, + { + "$id": "6549", + "name": "getStatus", + "resourceName": "Indexers", + "doc": "Returns the current status and execution history of an indexer.", + "accessibility": "public", + "parameters": [ + { + "$id": "6550", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "6551", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "6552", + "type": { + "$id": "6553", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6554", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "6555", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "6556", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6557", + "name": "indexerName", + "nameInRequest": "indexerName", + "doc": "The name of the indexer.", + "type": { + "$id": "6558", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6559", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "6560", + "kind": "constant", + "valueType": { + "$id": "6561", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "6562", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "5278" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/indexers('{indexerName}')/search.status", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexers.getStatus", + "decorators": [], + "examples": [ + { + "$id": "6563", + "kind": "http", + "name": "SearchServiceGetIndexerStatus", + "description": "SearchServiceGetIndexerStatus", + "filePath": "2025-03-01-preview/SearchServiceGetIndexerStatus.json", + "parameters": [ + { + "$id": "6564", + "parameter": { + "$ref": "6557" + }, + "value": { + "$id": "6565", + "kind": "string", + "type": { + "$ref": "6558" + }, + "value": "myindexer" + } + }, + { + "$id": "6566", + "parameter": { + "$ref": "6550" + }, + "value": { + "$id": "6567", + "kind": "string", + "type": { + "$ref": "6551" + }, + "value": "2025-03-01-preview" + } + } + ], + "responses": [ + { + "$id": "6568", + "response": { + "$ref": "6562" + }, + "statusCode": 200, + "bodyValue": { + "$id": "6569", + "kind": "model", + "type": { + "$ref": "5278" + }, + "value": { + "$id": "6570", + "status": { + "$id": "6571", + "kind": "string", + "type": { + "$ref": "2136" + }, + "value": "running" + }, + "lastResult": { + "$id": "6572", + "kind": "model", + "type": { + "$ref": "5283" + }, + "value": { + "$id": "6573", + "status": { + "$id": "6574", + "kind": "string", + "type": { + "$ref": "2144" + }, + "value": "success" + }, + "startTime": { + "$id": "6575", + "kind": "string", + "type": { + "$ref": "5328" + }, + "value": "2014-11-26T03:37:18.853Z" + }, + "endTime": { + "$id": "6576", + "kind": "string", + "type": { + "$ref": "5333" + }, + "value": "2014-11-26T03:37:19.012Z" + }, + "errors": { + "$id": "6577", + "kind": "array", + "type": { + "$ref": "5338" + }, + "value": [] + }, + "warnings": { + "$id": "6578", + "kind": "array", + "type": { + "$ref": "5367" + }, + "value": [] + }, + "itemsProcessed": { + "$id": "6579", + "kind": "number", + "type": { + "$ref": "5392" + }, + "value": 11 + }, + "itemsFailed": { + "$id": "6580", + "kind": "number", + "type": { + "$ref": "5396" + }, + "value": 0 + } + } + }, + "executionHistory": { + "$id": "6581", + "kind": "array", + "type": { + "$ref": "5410" + }, + "value": [ + { + "$id": "6582", + "kind": "model", + "type": { + "$ref": "5283" + }, + "value": { + "$id": "6583", + "status": { + "$id": "6584", + "kind": "string", + "type": { + "$ref": "2144" + }, + "value": "success" + }, + "startTime": { + "$id": "6585", + "kind": "string", + "type": { + "$ref": "5328" + }, + "value": "2014-11-26T03:37:18.853Z" + }, + "endTime": { + "$id": "6586", + "kind": "string", + "type": { + "$ref": "5333" + }, + "value": "2014-11-26T03:37:19.012Z" + }, + "errors": { + "$id": "6587", + "kind": "array", + "type": { + "$ref": "5338" + }, + "value": [] + }, + "warnings": { + "$id": "6588", + "kind": "array", + "type": { + "$ref": "5367" + }, + "value": [] + }, + "itemsProcessed": { + "$id": "6589", + "kind": "number", + "type": { + "$ref": "5392" + }, + "value": 11 + }, + "itemsFailed": { + "$id": "6590", + "kind": "number", + "type": { + "$ref": "5396" + }, + "value": 0 + } + } + }, + { + "$id": "6591", + "kind": "model", + "type": { + "$ref": "5283" + }, + "value": { + "$id": "6592", + "status": { + "$id": "6593", + "kind": "string", + "type": { + "$ref": "2144" + }, + "value": "transientFailure" + }, + "startTime": { + "$id": "6594", + "kind": "string", + "type": { + "$ref": "5328" + }, + "value": "2014-11-26T03:28:10.125Z" + }, + "endTime": { + "$id": "6595", + "kind": "string", + "type": { + "$ref": "5333" + }, + "value": "2014-11-26T03:28:12.007Z" + }, + "errors": { + "$id": "6596", + "kind": "array", + "type": { + "$ref": "5338" + }, + "value": [ + { + "$id": "6597", + "kind": "model", + "type": { + "$ref": "5339" + }, + "value": { + "$id": "6598", + "key": { + "$id": "6599", + "kind": "string", + "type": { + "$ref": "5341" + }, + "value": "" + }, + "errorMessage": { + "$id": "6600", + "kind": "string", + "type": { + "$ref": "5345" + }, + "value": "Document key cannot be missing or empty." + }, + "statusCode": { + "$id": "6601", + "kind": "number", + "type": { + "$ref": "5349" + }, + "value": 400 + } + } + }, + { + "$id": "6602", + "kind": "model", + "type": { + "$ref": "5339" + }, + "value": { + "$id": "6603", + "key": { + "$id": "6604", + "kind": "string", + "type": { + "$ref": "5341" + }, + "value": "document id 1" + }, + "errorMessage": { + "$id": "6605", + "kind": "string", + "type": { + "$ref": "5345" + }, + "value": "Could not read the value of column 'foo' at index '0'." + }, + "statusCode": { + "$id": "6606", + "kind": "number", + "type": { + "$ref": "5349" + }, + "value": 400 + }, + "name": { + "$id": "6607", + "kind": "string", + "type": { + "$ref": "5353" + }, + "value": "DocumentExtraction.AzureBlob.MyDataSource" + }, + "details": { + "$id": "6608", + "kind": "string", + "type": { + "$ref": "5357" + }, + "value": "The file could not be parsed." + }, + "documentationLink": { + "$id": "6609", + "kind": "string", + "type": { + "$ref": "5361" + }, + "value": "https://go.microsoft.com/fwlink/?linkid=2049388" + } + } + } + ] + }, + "warnings": { + "$id": "6610", + "kind": "array", + "type": { + "$ref": "5367" + }, + "value": [ + { + "$id": "6611", + "kind": "model", + "type": { + "$ref": "5368" + }, + "value": { + "$id": "6612", + "key": { + "$id": "6613", + "kind": "string", + "type": { + "$ref": "5370" + }, + "value": "document id" + }, + "message": { + "$id": "6614", + "kind": "string", + "type": { + "$ref": "5374" + }, + "value": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob." + } + } + }, + { + "$id": "6615", + "kind": "model", + "type": { + "$ref": "5368" + }, + "value": { + "$id": "6616", + "key": { + "$id": "6617", + "kind": "string", + "type": { + "$ref": "5370" + }, + "value": "document id 2" + }, + "message": { + "$id": "6618", + "kind": "string", + "type": { + "$ref": "5374" + }, + "value": "Document was truncated to 50000 characters." + }, + "name": { + "$id": "6619", + "kind": "string", + "type": { + "$ref": "5378" + }, + "value": "Enrichment.LanguageDetectionSkill.#4" + }, + "details": { + "$id": "6620", + "kind": "string", + "type": { + "$ref": "5382" + }, + "value": "The skill did something that didn't break anything, nonetheless something we didn't expect happened, so it might be worth double checking." + }, + "documentationLink": { + "$id": "6621", + "kind": "string", + "type": { + "$ref": "5386" + }, + "value": "https://go.microsoft.com/fwlink/?linkid=2099692" + } + } + } + ] + }, + "itemsProcessed": { + "$id": "6622", + "kind": "number", + "type": { + "$ref": "5392" + }, + "value": 1 + }, + "itemsFailed": { + "$id": "6623", + "kind": "number", + "type": { + "$ref": "5396" + }, + "value": 2 + } + } + } + ] + }, + "limits": { + "$id": "6624", + "kind": "model", + "type": { + "$ref": "5414" + }, + "value": { + "$id": "6625", + "maxRunTime": { + "$id": "6626", + "kind": "string", + "type": { + "$ref": "5416" + }, + "value": "PT22H" + }, + "maxDocumentExtractionSize": { + "$id": "6627", + "kind": "number", + "type": { + "$ref": "5421" + }, + "value": 256000000 + }, + "maxDocumentContentCharactersToExtract": { + "$id": "6628", + "kind": "number", + "type": { + "$ref": "5425" + }, + "value": 4000000 + } + } + } + } + } + } + ] + } + ] + } + ], + "parameters": [ + { + "$id": "6629", + "name": "endpoint", + "nameInRequest": "endpoint", + "doc": "Service host", + "type": { + "$id": "6630", + "kind": "url", + "name": "url", + "crossLanguageDefinitionId": "TypeSpec.url" + }, + "location": "Uri", + "isApiVersion": false, + "isContentType": false, + "isRequired": true, + "isEndpoint": true, + "skipUrlEncoding": false, + "explode": false, + "kind": "Client" + } + ], + "decorators": [], + "crossLanguageDefinitionId": "Search.Indexers", + "apiVersions": [ + "2024-07-01", + "2025-03-01-preview" + ], + "parent": { + "$ref": "5531" + } + }, + { + "$id": "6631", + "kind": "client", + "name": "Skillsets", + "namespace": "Azure.Search.Documents", + "operations": [ + { + "$id": "6632", + "name": "createOrUpdate", + "resourceName": "Skillsets", + "doc": "Creates a new skillset in a search service or updates the skillset if it\nalready exists.", + "accessibility": "public", + "parameters": [ + { + "$id": "6633", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "6634", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "6635", + "type": { + "$id": "6636", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6637", + "name": "ifMatch", + "nameInRequest": "If-Match", + "doc": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "type": { + "$id": "6638", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6639", + "name": "ifNoneMatch", + "nameInRequest": "If-None-Match", + "doc": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "type": { + "$id": "6640", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6641", + "name": "prefer", + "nameInRequest": "Prefer", + "doc": "For HTTP PUT requests, instructs the service to return the created/updated resource on success.", + "type": { + "$id": "6642", + "kind": "constant", + "valueType": { + "$id": "6643", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "return=representation", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6644", + "name": "skipIndexerResetRequirementForCache", + "nameInRequest": "ignoreResetRequirements", + "doc": "Ignores cache reset requirements.", + "type": { + "$id": "6645", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6646", + "name": "disableCacheReprocessingChangeDetection", + "nameInRequest": "disableCacheReprocessingChangeDetection", + "doc": "Disables cache reprocessing change detection.", + "type": { + "$id": "6647", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6648", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "6649", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "6650", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6651", + "name": "skillsetName", + "nameInRequest": "skillsetName", + "doc": "The name of the skillset.", + "type": { + "$id": "6652", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6653", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "6654", + "kind": "constant", + "valueType": { + "$id": "6655", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6656", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "6657", + "kind": "constant", + "valueType": { + "$id": "6658", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6659", + "name": "skillset", + "nameInRequest": "skillset", + "doc": "The skillset containing one or more skills to create or update in a search\nservice.", + "type": { + "$ref": "4335" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "6660", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "4335" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + }, + { + "$id": "6661", + "statusCodes": [ + 201 + ], + "bodyType": { + "$ref": "4335" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "PUT", + "uri": "{endpoint}", + "path": "/skillsets('{skillsetName}')", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Skillsets.createOrUpdate", + "decorators": [], + "examples": [ + { + "$id": "6662", + "kind": "http", + "name": "SearchServiceCreateOrUpdateSkillset", + "description": "SearchServiceCreateOrUpdateSkillset", + "filePath": "2025-03-01-preview/SearchServiceCreateOrUpdateSkillset.json", + "parameters": [ + { + "$id": "6663", + "parameter": { + "$ref": "6651" + }, + "value": { + "$id": "6664", + "kind": "string", + "type": { + "$ref": "6652" + }, + "value": "tempskillset" + } + }, + { + "$id": "6665", + "parameter": { + "$ref": "6633" + }, + "value": { + "$id": "6666", + "kind": "string", + "type": { + "$ref": "6634" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "6667", + "parameter": { + "$ref": "6648" + }, + "value": { + "$id": "6668", + "kind": "string", + "type": { + "$ref": "6649" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "6669", + "parameter": { + "$ref": "6641" + }, + "value": { + "$id": "6670", + "kind": "string", + "type": { + "$ref": "6642" + }, + "value": "return=representation" + } + }, + { + "$id": "6671", + "parameter": { + "$ref": "6659" + }, + "value": { + "$id": "6672", + "kind": "model", + "type": { + "$ref": "4335" + }, + "value": { + "$id": "6673", + "name": { + "$id": "6674", + "kind": "string", + "type": { + "$ref": "4337" + }, + "value": "tempskillset" + }, + "description": { + "$id": "6675", + "kind": "string", + "type": { + "$ref": "4341" + }, + "value": "Skillset for extracting entities and more" + }, + "skills": { + "$id": "6676", + "kind": "array", + "type": { + "$ref": "4345" + }, + "value": [] + }, + "@odata.etag": { + "$id": "6677", + "kind": "string", + "type": { + "$ref": "5063" + }, + "value": "0x1234568AE7E58A1" + }, + "encryptionKey": { + "$id": "6678", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6679", + "keyVaultKeyName": { + "$id": "6680", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6681", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6682", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6683", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6684", + "applicationId": { + "$id": "6685", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6686", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ], + "responses": [ + { + "$id": "6687", + "response": { + "$ref": "6660" + }, + "statusCode": 200, + "bodyValue": { + "$id": "6688", + "kind": "model", + "type": { + "$ref": "4335" + }, + "value": { + "$id": "6689", + "@odata.etag": { + "$id": "6690", + "kind": "string", + "type": { + "$ref": "5063" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "6691", + "kind": "string", + "type": { + "$ref": "4337" + }, + "value": "tempskillset" + }, + "description": { + "$id": "6692", + "kind": "string", + "type": { + "$ref": "4341" + }, + "value": "Skillset for extracting entities and more" + }, + "skills": { + "$id": "6693", + "kind": "array", + "type": { + "$ref": "4345" + }, + "value": [] + }, + "encryptionKey": { + "$id": "6694", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6695", + "keyVaultKeyName": { + "$id": "6696", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6697", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6698", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6699", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6700", + "applicationId": { + "$id": "6701", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6702", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + }, + { + "$id": "6703", + "response": { + "$ref": "6661" + }, + "statusCode": 201, + "bodyValue": { + "$id": "6704", + "kind": "model", + "type": { + "$ref": "4335" + }, + "value": { + "$id": "6705", + "@odata.etag": { + "$id": "6706", + "kind": "string", + "type": { + "$ref": "5063" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "6707", + "kind": "string", + "type": { + "$ref": "4337" + }, + "value": "tempskillset" + }, + "description": { + "$id": "6708", + "kind": "string", + "type": { + "$ref": "4341" + }, + "value": "Skillset for extracting entities and more" + }, + "skills": { + "$id": "6709", + "kind": "array", + "type": { + "$ref": "4345" + }, + "value": [] + }, + "encryptionKey": { + "$id": "6710", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6711", + "keyVaultKeyName": { + "$id": "6712", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6713", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6714", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6715", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6716", + "applicationId": { + "$id": "6717", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6718", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ] + } + ] + }, + { + "$id": "6719", + "name": "delete", + "resourceName": "Skillsets", + "doc": "Deletes a skillset in a search service.", + "accessibility": "public", + "parameters": [ + { + "$id": "6720", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "6721", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "6722", + "type": { + "$id": "6723", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6724", + "name": "ifMatch", + "nameInRequest": "If-Match", + "doc": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "type": { + "$id": "6725", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6726", + "name": "ifNoneMatch", + "nameInRequest": "If-None-Match", + "doc": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "type": { + "$id": "6727", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6728", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "6729", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "6730", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6731", + "name": "skillsetName", + "nameInRequest": "skillsetName", + "doc": "The name of the skillset.", + "type": { + "$id": "6732", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6733", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "6734", + "kind": "constant", + "valueType": { + "$id": "6735", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "6736", + "statusCodes": [ + 204 + ], + "headers": [], + "isErrorResponse": false + }, + { + "$id": "6737", + "statusCodes": [ + 404 + ], + "headers": [], + "isErrorResponse": false + } + ], + "httpMethod": "DELETE", + "uri": "{endpoint}", + "path": "/skillsets('{skillsetName}')", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Skillsets.delete", + "decorators": [], + "examples": [ + { + "$id": "6738", + "kind": "http", + "name": "SearchServiceDeleteSkillset", + "description": "SearchServiceDeleteSkillset", + "filePath": "2025-03-01-preview/SearchServiceDeleteSkillset.json", + "parameters": [ + { + "$id": "6739", + "parameter": { + "$ref": "6731" + }, + "value": { + "$id": "6740", + "kind": "string", + "type": { + "$ref": "6732" + }, + "value": "tempskillset" + } + }, + { + "$id": "6741", + "parameter": { + "$ref": "6720" + }, + "value": { + "$id": "6742", + "kind": "string", + "type": { + "$ref": "6721" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "6743", + "parameter": { + "$ref": "6728" + }, + "value": { + "$id": "6744", + "kind": "string", + "type": { + "$ref": "6729" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "6745", + "response": { + "$ref": "6736" + }, + "statusCode": 204 + }, + { + "$id": "6746", + "response": { + "$ref": "6737" + }, + "statusCode": 404 + } + ] + } + ] + }, + { + "$id": "6747", + "name": "get", + "resourceName": "Skillsets", + "doc": "Retrieves a skillset in a search service.", + "accessibility": "public", + "parameters": [ + { + "$id": "6748", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "6749", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "6750", + "type": { + "$id": "6751", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6752", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "6753", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "6754", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6755", + "name": "skillsetName", + "nameInRequest": "skillsetName", + "doc": "The name of the skillset.", + "type": { + "$id": "6756", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6757", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "6758", + "kind": "constant", + "valueType": { + "$id": "6759", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "6760", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "4335" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/skillsets('{skillsetName}')", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Skillsets.get", + "decorators": [], + "examples": [ + { + "$id": "6761", + "kind": "http", + "name": "SearchServiceGetSkillset", + "description": "SearchServiceGetSkillset", + "filePath": "2025-03-01-preview/SearchServiceGetSkillset.json", + "parameters": [ + { + "$id": "6762", + "parameter": { + "$ref": "6755" + }, + "value": { + "$id": "6763", + "kind": "string", + "type": { + "$ref": "6756" + }, + "value": "myskillset" + } + }, + { + "$id": "6764", + "parameter": { + "$ref": "6748" + }, + "value": { + "$id": "6765", + "kind": "string", + "type": { + "$ref": "6749" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "6766", + "parameter": { + "$ref": "6752" + }, + "value": { + "$id": "6767", + "kind": "string", + "type": { + "$ref": "6753" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "6768", + "response": { + "$ref": "6760" + }, + "statusCode": 200, + "bodyValue": { + "$id": "6769", + "kind": "model", + "type": { + "$ref": "4335" + }, + "value": { + "$id": "6770", + "@odata.etag": { + "$id": "6771", + "kind": "string", + "type": { + "$ref": "5063" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "6772", + "kind": "string", + "type": { + "$ref": "4337" + }, + "value": "myskillset" + }, + "description": { + "$id": "6773", + "kind": "string", + "type": { + "$ref": "4341" + }, + "value": "Skillset for extracting entities and more" + }, + "skills": { + "$id": "6774", + "kind": "array", + "type": { + "$ref": "4345" + }, + "value": [] + }, + "encryptionKey": { + "$id": "6775", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6776", + "keyVaultKeyName": { + "$id": "6777", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6778", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6779", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6780", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6781", + "applicationId": { + "$id": "6782", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6783", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ] + } + ] + }, + { + "$id": "6784", + "name": "list", + "resourceName": "Skillsets", + "doc": "List all skillsets in a search service.", + "accessibility": "public", + "parameters": [ + { + "$id": "6785", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "6786", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "6787", + "type": { + "$id": "6788", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6789", + "name": "$select", + "nameInRequest": "$select", + "doc": "Selects which top-level properties to retrieve.\nSpecified as a comma-separated list of JSON property names,\nor '*' for all properties. The default is all properties.", + "type": { + "$id": "6790", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6791", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "6792", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "6793", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6794", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "6795", + "kind": "constant", + "valueType": { + "$id": "6796", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "6797", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "5069" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/skillsets", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Skillsets.list", + "decorators": [], + "examples": [ + { + "$id": "6798", + "kind": "http", + "name": "SearchServiceListSkillsets", + "description": "SearchServiceListSkillsets", + "filePath": "2025-03-01-preview/SearchServiceListSkillsets.json", + "parameters": [ + { + "$id": "6799", + "parameter": { + "$ref": "6785" + }, + "value": { + "$id": "6800", + "kind": "string", + "type": { + "$ref": "6786" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "6801", + "parameter": { + "$ref": "6791" + }, + "value": { + "$id": "6802", + "kind": "string", + "type": { + "$ref": "6792" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "6803", + "response": { + "$ref": "6797" + }, + "statusCode": 200, + "bodyValue": { + "$id": "6804", + "kind": "model", + "type": { + "$ref": "5069" + }, + "value": { + "$id": "6805", + "value": { + "$id": "6806", + "kind": "array", + "type": { + "$ref": "5071" + }, + "value": [ + { + "$id": "6807", + "kind": "model", + "type": { + "$ref": "4335" + }, + "value": { + "$id": "6808", + "@odata.etag": { + "$id": "6809", + "kind": "string", + "type": { + "$ref": "5063" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "6810", + "kind": "string", + "type": { + "$ref": "4337" + }, + "value": "myskillset" + }, + "description": { + "$id": "6811", + "kind": "string", + "type": { + "$ref": "4341" + }, + "value": "Skillset for extracting entities and more" + }, + "skills": { + "$id": "6812", + "kind": "array", + "type": { + "$ref": "4345" + }, + "value": [] + }, + "encryptionKey": { + "$id": "6813", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6814", + "keyVaultKeyName": { + "$id": "6815", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6816", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6817", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6818", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6819", + "applicationId": { + "$id": "6820", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6821", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + ] + } + } + } + } + ] + } + ] + }, + { + "$id": "6822", + "name": "create", + "resourceName": "Skillsets", + "doc": "Creates a new skillset in a search service.", + "accessibility": "public", + "parameters": [ + { + "$id": "6823", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "6824", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "6825", + "type": { + "$id": "6826", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6827", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "6828", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "6829", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6830", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "6831", + "kind": "constant", + "valueType": { + "$id": "6832", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6833", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "6834", + "kind": "constant", + "valueType": { + "$id": "6835", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6836", + "name": "skillset", + "nameInRequest": "skillset", + "doc": "The skillset containing one or more skills to create in a search service.", + "type": { + "$ref": "4335" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "6837", + "statusCodes": [ + 201 + ], + "bodyType": { + "$ref": "4335" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "POST", + "uri": "{endpoint}", + "path": "/skillsets", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Skillsets.create", + "decorators": [], + "examples": [ + { + "$id": "6838", + "kind": "http", + "name": "SearchServiceCreateSkillset", + "description": "SearchServiceCreateSkillset", + "filePath": "2025-03-01-preview/SearchServiceCreateSkillset.json", + "parameters": [ + { + "$id": "6839", + "parameter": { + "$ref": "6823" + }, + "value": { + "$id": "6840", + "kind": "string", + "type": { + "$ref": "6824" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "6841", + "parameter": { + "$ref": "6827" + }, + "value": { + "$id": "6842", + "kind": "string", + "type": { + "$ref": "6828" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "6843", + "parameter": { + "$ref": "6836" + }, + "value": { + "$id": "6844", + "kind": "model", + "type": { + "$ref": "4335" + }, + "value": { + "$id": "6845", + "name": { + "$id": "6846", + "kind": "string", + "type": { + "$ref": "4337" + }, + "value": "tempskillset" + }, + "description": { + "$id": "6847", + "kind": "string", + "type": { + "$ref": "4341" + }, + "value": "Skillset for extracting entities and more" + }, + "skills": { + "$id": "6848", + "kind": "array", + "type": { + "$ref": "4345" + }, + "value": [] + }, + "@odata.etag": { + "$id": "6849", + "kind": "string", + "type": { + "$ref": "5063" + }, + "value": "0x1234568AE7E58A1" + }, + "encryptionKey": { + "$id": "6850", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6851", + "keyVaultKeyName": { + "$id": "6852", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6853", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6854", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6855", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6856", + "applicationId": { + "$id": "6857", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6858", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ], + "responses": [ + { + "$id": "6859", + "response": { + "$ref": "6837" + }, + "statusCode": 201, + "bodyValue": { + "$id": "6860", + "kind": "model", + "type": { + "$ref": "4335" + }, + "value": { + "$id": "6861", + "name": { + "$id": "6862", + "kind": "string", + "type": { + "$ref": "4337" + }, + "value": "tempskillset" + }, + "description": { + "$id": "6863", + "kind": "string", + "type": { + "$ref": "4341" + }, + "value": "Skillset for extracting entities and more" + }, + "skills": { + "$id": "6864", + "kind": "array", + "type": { + "$ref": "4345" + }, + "value": [] + }, + "encryptionKey": { + "$id": "6865", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6866", + "keyVaultKeyName": { + "$id": "6867", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6868", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6869", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6870", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6871", + "applicationId": { + "$id": "6872", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6873", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ] + } + ] + }, + { + "$id": "6874", + "name": "resetSkills", + "resourceName": "Skillsets", + "doc": "Reset an existing skillset in a search service.", + "accessibility": "public", + "parameters": [ + { + "$id": "6875", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "6876", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "6877", + "type": { + "$id": "6878", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6879", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "6880", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "6881", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6882", + "name": "skillsetName", + "nameInRequest": "skillsetName", + "doc": "The name of the skillset.", + "type": { + "$id": "6883", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6884", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "6885", + "kind": "constant", + "valueType": { + "$id": "6886", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6887", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "6888", + "kind": "constant", + "valueType": { + "$id": "6889", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6890", + "name": "skillNames", + "nameInRequest": "skillNames", + "doc": "The names of the skills to reset. If not specified, all skills in the skillset\nwill be reset.", + "type": { + "$ref": "5074" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "6891", + "statusCodes": [ + 204 + ], + "headers": [], + "isErrorResponse": false + } + ], + "httpMethod": "POST", + "uri": "{endpoint}", + "path": "/skillsets('{skillsetName}')/search.resetskills", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Skillsets.resetSkills", + "decorators": [], + "examples": [ + { + "$id": "6892", + "kind": "http", + "name": "SearchServiceResetSkills", + "description": "SearchServiceResetSkills", + "filePath": "2025-03-01-preview/SearchServiceResetSkills.json", + "parameters": [ + { + "$id": "6893", + "parameter": { + "$ref": "6882" + }, + "value": { + "$id": "6894", + "kind": "string", + "type": { + "$ref": "6883" + }, + "value": "myskillset" + } + }, + { + "$id": "6895", + "parameter": { + "$ref": "6875" + }, + "value": { + "$id": "6896", + "kind": "string", + "type": { + "$ref": "6876" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "6897", + "parameter": { + "$ref": "6879" + }, + "value": { + "$id": "6898", + "kind": "string", + "type": { + "$ref": "6880" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "6899", + "parameter": { + "$ref": "6890" + }, + "value": { + "$id": "6900", + "kind": "model", + "type": { + "$ref": "5074" + }, + "value": { + "$id": "6901", + "skillNames": { + "$id": "6902", + "kind": "array", + "type": { + "$ref": "5076" + }, + "value": [ + { + "$id": "6903", + "kind": "string", + "type": { + "$ref": "5077" + }, + "value": "skill2" + }, + { + "$id": "6904", + "kind": "string", + "type": { + "$ref": "5077" + }, + "value": "skill3" + }, + { + "$id": "6905", + "kind": "string", + "type": { + "$ref": "5077" + }, + "value": "skill4" + } + ] + } + } + } + } + ], + "responses": [ + { + "$id": "6906", + "response": { + "$ref": "6891" + }, + "statusCode": 204 + } + ] + } + ] + } + ], + "parameters": [ + { + "$id": "6907", + "name": "endpoint", + "nameInRequest": "endpoint", + "doc": "Service host", + "type": { + "$id": "6908", + "kind": "url", + "name": "url", + "crossLanguageDefinitionId": "TypeSpec.url" + }, + "location": "Uri", + "isApiVersion": false, + "isContentType": false, + "isRequired": true, + "isEndpoint": true, + "skipUrlEncoding": false, + "explode": false, + "kind": "Client" + } + ], + "decorators": [], + "crossLanguageDefinitionId": "Search.Skillsets", + "apiVersions": [ + "2024-07-01", + "2025-03-01-preview" + ], + "parent": { + "$ref": "5531" + } + }, + { + "$id": "6909", + "kind": "client", + "name": "SynonymMaps", + "namespace": "Azure.Search.Documents", + "operations": [ + { + "$id": "6910", + "name": "createOrUpdate", + "resourceName": "SynonymMaps", + "doc": "Creates a new synonym map or updates a synonym map if it already exists.", + "accessibility": "public", + "parameters": [ + { + "$id": "6911", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "6912", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "6913", + "type": { + "$id": "6914", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6915", + "name": "ifMatch", + "nameInRequest": "If-Match", + "doc": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "type": { + "$id": "6916", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6917", + "name": "ifNoneMatch", + "nameInRequest": "If-None-Match", + "doc": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "type": { + "$id": "6918", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6919", + "name": "prefer", + "nameInRequest": "Prefer", + "doc": "For HTTP PUT requests, instructs the service to return the created/updated resource on success.", + "type": { + "$id": "6920", + "kind": "constant", + "valueType": { + "$id": "6921", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "return=representation", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6922", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "6923", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "6924", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6925", + "name": "synonymMapName", + "nameInRequest": "synonymMapName", + "doc": "The name of the synonym map.", + "type": { + "$id": "6926", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6927", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "6928", + "kind": "constant", + "valueType": { + "$id": "6929", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6930", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "6931", + "kind": "constant", + "valueType": { + "$id": "6932", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6933", + "name": "synonymMap", + "nameInRequest": "synonymMap", + "doc": "The definition of the synonym map to create or update.", + "type": { + "$ref": "4310" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "6934", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "4310" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + }, + { + "$id": "6935", + "statusCodes": [ + 201 + ], + "bodyType": { + "$ref": "4310" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "PUT", + "uri": "{endpoint}", + "path": "/synonymmaps('{synonymMapName}')", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.SynonymMaps.createOrUpdate", + "decorators": [], + "examples": [ + { + "$id": "6936", + "kind": "http", + "name": "SearchServiceCreateOrUpdateSynonymMap", + "description": "SearchServiceCreateOrUpdateSynonymMap", + "filePath": "2025-03-01-preview/SearchServiceCreateOrUpdateSynonymMap.json", + "parameters": [ + { + "$id": "6937", + "parameter": { + "$ref": "6925" + }, + "value": { + "$id": "6938", + "kind": "string", + "type": { + "$ref": "6926" + }, + "value": "mysynonymmap" + } + }, + { + "$id": "6939", + "parameter": { + "$ref": "6911" + }, + "value": { + "$id": "6940", + "kind": "string", + "type": { + "$ref": "6912" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "6941", + "parameter": { + "$ref": "6922" + }, + "value": { + "$id": "6942", + "kind": "string", + "type": { + "$ref": "6923" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "6943", + "parameter": { + "$ref": "6919" + }, + "value": { + "$id": "6944", + "kind": "string", + "type": { + "$ref": "6920" + }, + "value": "return=representation" + } + }, + { + "$id": "6945", + "parameter": { + "$ref": "6933" + }, + "value": { + "$id": "6946", + "kind": "model", + "type": { + "$ref": "4310" + }, + "value": { + "$id": "6947", + "name": { + "$id": "6948", + "kind": "string", + "type": { + "$ref": "4312" + }, + "value": "mysynonymmap" + }, + "format": { + "$id": "6949", + "kind": "string", + "type": { + "$ref": "4316" + }, + "value": "solr" + }, + "synonyms": { + "$id": "6950", + "kind": "string", + "type": { + "$ref": "4320" + }, + "value": "United States, United States of America, USA\nWashington, Wash. => WA" + }, + "encryptionKey": { + "$id": "6951", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6952", + "keyVaultKeyName": { + "$id": "6953", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6954", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6955", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6956", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6957", + "applicationId": { + "$id": "6958", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6959", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + }, + "@odata.etag": { + "$id": "6960", + "kind": "string", + "type": { + "$ref": "4327" + }, + "value": "0x1234568AE7E58A1" + } + } + } + } + ], + "responses": [ + { + "$id": "6961", + "response": { + "$ref": "6934" + }, + "statusCode": 200, + "bodyValue": { + "$id": "6962", + "kind": "model", + "type": { + "$ref": "4310" + }, + "value": { + "$id": "6963", + "@odata.etag": { + "$id": "6964", + "kind": "string", + "type": { + "$ref": "4327" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "6965", + "kind": "string", + "type": { + "$ref": "4312" + }, + "value": "mysynonymmap" + }, + "format": { + "$id": "6966", + "kind": "string", + "type": { + "$ref": "4316" + }, + "value": "solr" + }, + "synonyms": { + "$id": "6967", + "kind": "string", + "type": { + "$ref": "4320" + }, + "value": "United States, United States of America, USA\nWashington, Wash. => WA" + }, + "encryptionKey": { + "$id": "6968", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6969", + "keyVaultKeyName": { + "$id": "6970", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6971", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6972", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6973", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6974", + "applicationId": { + "$id": "6975", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6976", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + }, + { + "$id": "6977", + "response": { + "$ref": "6935" + }, + "statusCode": 201, + "bodyValue": { + "$id": "6978", + "kind": "model", + "type": { + "$ref": "4310" + }, + "value": { + "$id": "6979", + "@odata.etag": { + "$id": "6980", + "kind": "string", + "type": { + "$ref": "4327" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "6981", + "kind": "string", + "type": { + "$ref": "4312" + }, + "value": "mysynonymmap" + }, + "format": { + "$id": "6982", + "kind": "string", + "type": { + "$ref": "4316" + }, + "value": "solr" + }, + "synonyms": { + "$id": "6983", + "kind": "string", + "type": { + "$ref": "4320" + }, + "value": "United States, United States of America, USA\nWashington, Wash. => WA" + }, + "encryptionKey": { + "$id": "6984", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "6985", + "keyVaultKeyName": { + "$id": "6986", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "6987", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "6988", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "6989", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "6990", + "applicationId": { + "$id": "6991", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "6992", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ] + } + ] + }, + { + "$id": "6993", + "name": "delete", + "resourceName": "SynonymMaps", + "doc": "Deletes a synonym map.", + "accessibility": "public", + "parameters": [ + { + "$id": "6994", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "6995", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "6996", + "type": { + "$id": "6997", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "6998", + "name": "ifMatch", + "nameInRequest": "If-Match", + "doc": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "type": { + "$id": "6999", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7000", + "name": "ifNoneMatch", + "nameInRequest": "If-None-Match", + "doc": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "type": { + "$id": "7001", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7002", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "7003", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "7004", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7005", + "name": "synonymMapName", + "nameInRequest": "synonymMapName", + "doc": "The name of the synonym map.", + "type": { + "$id": "7006", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7007", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "7008", + "kind": "constant", + "valueType": { + "$id": "7009", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "7010", + "statusCodes": [ + 204 + ], + "headers": [], + "isErrorResponse": false + }, + { + "$id": "7011", + "statusCodes": [ + 404 + ], + "headers": [], + "isErrorResponse": false + } + ], + "httpMethod": "DELETE", + "uri": "{endpoint}", + "path": "/synonymmaps('{synonymMapName}')", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.SynonymMaps.delete", + "decorators": [], + "examples": [ + { + "$id": "7012", + "kind": "http", + "name": "SearchServiceDeleteSynonymMap", + "description": "SearchServiceDeleteSynonymMap", + "filePath": "2025-03-01-preview/SearchServiceDeleteSynonymMap.json", + "parameters": [ + { + "$id": "7013", + "parameter": { + "$ref": "7005" + }, + "value": { + "$id": "7014", + "kind": "string", + "type": { + "$ref": "7006" + }, + "value": "tempsynonymmap" + } + }, + { + "$id": "7015", + "parameter": { + "$ref": "6994" + }, + "value": { + "$id": "7016", + "kind": "string", + "type": { + "$ref": "6995" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "7017", + "parameter": { + "$ref": "7002" + }, + "value": { + "$id": "7018", + "kind": "string", + "type": { + "$ref": "7003" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "7019", + "response": { + "$ref": "7010" + }, + "statusCode": 204 + }, + { + "$id": "7020", + "response": { + "$ref": "7011" + }, + "statusCode": 404 + } + ] + } + ] + }, + { + "$id": "7021", + "name": "get", + "resourceName": "SynonymMaps", + "doc": "Retrieves a synonym map definition.", + "accessibility": "public", + "parameters": [ + { + "$id": "7022", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "7023", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "7024", + "type": { + "$id": "7025", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7026", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "7027", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "7028", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7029", + "name": "synonymMapName", + "nameInRequest": "synonymMapName", + "doc": "The name of the synonym map.", + "type": { + "$id": "7030", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7031", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "7032", + "kind": "constant", + "valueType": { + "$id": "7033", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "7034", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "4310" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/synonymmaps('{synonymMapName}')", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.SynonymMaps.get", + "decorators": [], + "examples": [ + { + "$id": "7035", + "kind": "http", + "name": "SearchServiceGetSynonymMap", + "description": "SearchServiceGetSynonymMap", + "filePath": "2025-03-01-preview/SearchServiceGetSynonymMap.json", + "parameters": [ + { + "$id": "7036", + "parameter": { + "$ref": "7029" + }, + "value": { + "$id": "7037", + "kind": "string", + "type": { + "$ref": "7030" + }, + "value": "mysynonymmap" + } + }, + { + "$id": "7038", + "parameter": { + "$ref": "7022" + }, + "value": { + "$id": "7039", + "kind": "string", + "type": { + "$ref": "7023" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "7040", + "parameter": { + "$ref": "7026" + }, + "value": { + "$id": "7041", + "kind": "string", + "type": { + "$ref": "7027" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "7042", + "response": { + "$ref": "7034" + }, + "statusCode": 200, + "bodyValue": { + "$id": "7043", + "kind": "model", + "type": { + "$ref": "4310" + }, + "value": { + "$id": "7044", + "@odata.etag": { + "$id": "7045", + "kind": "string", + "type": { + "$ref": "4327" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "7046", + "kind": "string", + "type": { + "$ref": "4312" + }, + "value": "mysynonymmap" + }, + "format": { + "$id": "7047", + "kind": "string", + "type": { + "$ref": "4316" + }, + "value": "solr" + }, + "synonyms": { + "$id": "7048", + "kind": "string", + "type": { + "$ref": "4320" + }, + "value": "United States, United States of America, USA\nWashington, Wash. => WA" + }, + "encryptionKey": { + "$id": "7049", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "7050", + "keyVaultKeyName": { + "$id": "7051", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "7052", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "7053", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "7054", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "7055", + "applicationId": { + "$id": "7056", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "7057", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ] + } + ] + }, + { + "$id": "7058", + "name": "list", + "resourceName": "SynonymMaps", + "doc": "Lists all synonym maps available for a search service.", + "accessibility": "public", + "parameters": [ + { + "$id": "7059", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "7060", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "7061", + "type": { + "$id": "7062", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7063", + "name": "$select", + "nameInRequest": "$select", + "doc": "Selects which top-level properties to retrieve.\nSpecified as a comma-separated list of JSON property names,\nor '*' for all properties. The default is all properties.", + "type": { + "$id": "7064", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7065", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "7066", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "7067", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7068", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "7069", + "kind": "constant", + "valueType": { + "$id": "7070", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "7071", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "4330" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/synonymmaps", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.SynonymMaps.list", + "decorators": [], + "examples": [ + { + "$id": "7072", + "kind": "http", + "name": "SearchServiceListSynonymMaps", + "description": "SearchServiceListSynonymMaps", + "filePath": "2025-03-01-preview/SearchServiceListSynonymMaps.json", + "parameters": [ + { + "$id": "7073", + "parameter": { + "$ref": "7059" + }, + "value": { + "$id": "7074", + "kind": "string", + "type": { + "$ref": "7060" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "7075", + "parameter": { + "$ref": "7065" + }, + "value": { + "$id": "7076", + "kind": "string", + "type": { + "$ref": "7066" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "7077", + "response": { + "$ref": "7071" + }, + "statusCode": 200, + "bodyValue": { + "$id": "7078", + "kind": "model", + "type": { + "$ref": "4330" + }, + "value": { + "$id": "7079", + "value": { + "$id": "7080", + "kind": "array", + "type": { + "$ref": "4332" + }, + "value": [ + { + "$id": "7081", + "kind": "model", + "type": { + "$ref": "4310" + }, + "value": { + "$id": "7082", + "@odata.etag": { + "$id": "7083", + "kind": "string", + "type": { + "$ref": "4327" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "7084", + "kind": "string", + "type": { + "$ref": "4312" + }, + "value": "mysynonymmap" + }, + "format": { + "$id": "7085", + "kind": "string", + "type": { + "$ref": "4316" + }, + "value": "solr" + }, + "synonyms": { + "$id": "7086", + "kind": "string", + "type": { + "$ref": "4320" + }, + "value": "United States, United States of America, USA\nWashington, Wash. => WA" + }, + "encryptionKey": { + "$id": "7087", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "7088", + "keyVaultKeyName": { + "$id": "7089", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "7090", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "7091", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "7092", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "7093", + "applicationId": { + "$id": "7094", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "7095", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + ] + } + } + } + } + ] + } + ] + }, + { + "$id": "7096", + "name": "create", + "resourceName": "SynonymMaps", + "doc": "Creates a new synonym map.", + "accessibility": "public", + "parameters": [ + { + "$id": "7097", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "7098", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "7099", + "type": { + "$id": "7100", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7101", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "7102", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "7103", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7104", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "7105", + "kind": "constant", + "valueType": { + "$id": "7106", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7107", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "7108", + "kind": "constant", + "valueType": { + "$id": "7109", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7110", + "name": "synonymMap", + "nameInRequest": "synonymMap", + "doc": "The definition of the synonym map to create.", + "type": { + "$ref": "4310" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "7111", + "statusCodes": [ + 201 + ], + "bodyType": { + "$ref": "4310" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "POST", + "uri": "{endpoint}", + "path": "/synonymmaps", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.SynonymMaps.create", + "decorators": [], + "examples": [ + { + "$id": "7112", + "kind": "http", + "name": "SearchServiceCreateSynonymMap", + "description": "SearchServiceCreateSynonymMap", + "filePath": "2025-03-01-preview/SearchServiceCreateSynonymMap.json", + "parameters": [ + { + "$id": "7113", + "parameter": { + "$ref": "7097" + }, + "value": { + "$id": "7114", + "kind": "string", + "type": { + "$ref": "7098" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "7115", + "parameter": { + "$ref": "7101" + }, + "value": { + "$id": "7116", + "kind": "string", + "type": { + "$ref": "7102" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "7117", + "parameter": { + "$ref": "7110" + }, + "value": { + "$id": "7118", + "kind": "model", + "type": { + "$ref": "4310" + }, + "value": { + "$id": "7119", + "name": { + "$id": "7120", + "kind": "string", + "type": { + "$ref": "4312" + }, + "value": "tempsynonymmap" + }, + "format": { + "$id": "7121", + "kind": "string", + "type": { + "$ref": "4316" + }, + "value": "solr" + }, + "synonyms": { + "$id": "7122", + "kind": "string", + "type": { + "$ref": "4320" + }, + "value": "United States, United States of America, USA\nWashington, Wash. => WA" + }, + "encryptionKey": { + "$id": "7123", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "7124", + "keyVaultKeyName": { + "$id": "7125", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "7126", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "7127", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "7128", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "7129", + "applicationId": { + "$id": "7130", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "7131", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + }, + "@odata.etag": { + "$id": "7132", + "kind": "string", + "type": { + "$ref": "4327" + }, + "value": "0x1234568AE7E58A1" + } + } + } + } + ], + "responses": [ + { + "$id": "7133", + "response": { + "$ref": "7111" + }, + "statusCode": 201, + "bodyValue": { + "$id": "7134", + "kind": "model", + "type": { + "$ref": "4310" + }, + "value": { + "$id": "7135", + "@odata.etag": { + "$id": "7136", + "kind": "string", + "type": { + "$ref": "4327" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "7137", + "kind": "string", + "type": { + "$ref": "4312" + }, + "value": "tempsynonymmap" + }, + "format": { + "$id": "7138", + "kind": "string", + "type": { + "$ref": "4316" + }, + "value": "solr" + }, + "synonyms": { + "$id": "7139", + "kind": "string", + "type": { + "$ref": "4320" + }, + "value": "United States, United States of America, USA\nWashington, Wash. => WA" + }, + "encryptionKey": { + "$id": "7140", + "kind": "model", + "type": { + "$ref": "3851" + }, + "value": { + "$id": "7141", + "keyVaultKeyName": { + "$id": "7142", + "kind": "string", + "type": { + "$ref": "3853" + }, + "value": "myUserManagedEncryptionKey-createdinAzureKeyVault" + }, + "keyVaultKeyVersion": { + "$id": "7143", + "kind": "string", + "type": { + "$ref": "3857" + }, + "value": "myKeyVersion-32charAlphaNumericString" + }, + "keyVaultUri": { + "$id": "7144", + "kind": "string", + "type": { + "$ref": "3861" + }, + "value": "https://myKeyVault.vault.azure.net" + }, + "accessCredentials": { + "$id": "7145", + "kind": "model", + "type": { + "$ref": "3865" + }, + "value": { + "$id": "7146", + "applicationId": { + "$id": "7147", + "kind": "string", + "type": { + "$ref": "3867" + }, + "value": "00000000-0000-0000-0000-000000000000" + }, + "applicationSecret": { + "$id": "7148", + "kind": "string", + "type": { + "$ref": "3871" + }, + "value": "" + } + } + } + } + } + } + } + } + ] + } + ] + } + ], + "parameters": [ + { + "$id": "7149", + "name": "endpoint", + "nameInRequest": "endpoint", + "doc": "Service host", + "type": { + "$id": "7150", + "kind": "url", + "name": "url", + "crossLanguageDefinitionId": "TypeSpec.url" + }, + "location": "Uri", + "isApiVersion": false, + "isContentType": false, + "isRequired": true, + "isEndpoint": true, + "skipUrlEncoding": false, + "explode": false, + "kind": "Client" + } + ], + "decorators": [], + "crossLanguageDefinitionId": "Search.SynonymMaps", + "apiVersions": [ + "2024-07-01", + "2025-03-01-preview" + ], + "parent": { + "$ref": "5531" + } + }, + { + "$id": "7151", + "kind": "client", + "name": "Indexes", + "namespace": "Azure.Search.Documents", + "operations": [ + { + "$id": "7152", + "name": "create", + "resourceName": "Indexes", + "doc": "Creates a new search index.", + "accessibility": "public", + "parameters": [ + { + "$id": "7153", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "7154", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "7155", + "type": { + "$id": "7156", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7157", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "7158", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "7159", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7160", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "7161", + "kind": "constant", + "valueType": { + "$id": "7162", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7163", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "7164", + "kind": "constant", + "valueType": { + "$id": "7165", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7166", + "name": "index", + "nameInRequest": "index", + "doc": "The definition of the index to create.", + "type": { + "$ref": "2920" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "7167", + "statusCodes": [ + 201 + ], + "bodyType": { + "$ref": "2920" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "POST", + "uri": "{endpoint}", + "path": "/indexes", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexes.create", + "decorators": [], + "examples": [ + { + "$id": "7168", + "kind": "http", + "name": "SearchServiceCreateIndex", + "description": "SearchServiceCreateIndex", + "filePath": "2025-03-01-preview/SearchServiceCreateIndex.json", + "parameters": [ + { + "$id": "7169", + "parameter": { + "$ref": "7153" + }, + "value": { + "$id": "7170", + "kind": "string", + "type": { + "$ref": "7154" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "7171", + "parameter": { + "$ref": "7157" + }, + "value": { + "$id": "7172", + "kind": "string", + "type": { + "$ref": "7158" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "7173", + "parameter": { + "$ref": "7166" + }, + "value": { + "$id": "7174", + "kind": "model", + "type": { + "$ref": "2920" + }, + "value": { + "$id": "7175", + "name": { + "$id": "7176", + "kind": "string", + "type": { + "$ref": "2922" + }, + "value": "temp-preview-test" + }, + "fields": { + "$id": "7177", + "kind": "array", + "type": { + "$ref": "2926" + }, + "value": [ + { + "$id": "7178", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7179", + "name": { + "$id": "7180", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "id" + }, + "type": { + "$id": "7181", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "key": { + "$id": "7182", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": true + }, + "sortable": { + "$id": "7183", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + } + } + }, + { + "$id": "7184", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7185", + "name": { + "$id": "7186", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector1" + }, + "type": { + "$id": "7187", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "retrievable": { + "$id": "7188", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "7189", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "dimensions": { + "$id": "7190", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 20 + }, + "vectorSearchProfile": { + "$id": "7191", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config1" + } + } + }, + { + "$id": "7192", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7193", + "name": { + "$id": "7194", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector1b" + }, + "type": { + "$id": "7195", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "retrievable": { + "$id": "7196", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "7197", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "dimensions": { + "$id": "7198", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 10 + }, + "vectorSearchProfile": { + "$id": "7199", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config2" + } + } + }, + { + "$id": "7200", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7201", + "name": { + "$id": "7202", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector2" + }, + "type": { + "$id": "7203", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "retrievable": { + "$id": "7204", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "7205", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "dimensions": { + "$id": "7206", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 5 + }, + "vectorSearchProfile": { + "$id": "7207", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config3" + } + } + }, + { + "$id": "7208", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7209", + "name": { + "$id": "7210", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector3" + }, + "type": { + "$id": "7211", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "retrievable": { + "$id": "7212", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "7213", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "dimensions": { + "$id": "7214", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 5 + }, + "vectorSearchProfile": { + "$id": "7215", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config3" + } + } + }, + { + "$id": "7216", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7217", + "name": { + "$id": "7218", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector22" + }, + "type": { + "$id": "7219", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "retrievable": { + "$id": "7220", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "7221", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "dimensions": { + "$id": "7222", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 10 + }, + "vectorSearchProfile": { + "$id": "7223", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config2" + } + } + }, + { + "$id": "7224", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7225", + "name": { + "$id": "7226", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector4" + }, + "type": { + "$id": "7227", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "retrievable": { + "$id": "7228", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "7229", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "dimensions": { + "$id": "7230", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 32 + }, + "vectorSearchProfile": { + "$id": "7231", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config4" + } + } + }, + { + "$id": "7232", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7233", + "name": { + "$id": "7234", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "name" + }, + "type": { + "$id": "7235", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "retrievable": { + "$id": "7236", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "7237", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7238", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "sortable": { + "$id": "7239", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7240", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "analyzer": { + "$id": "7241", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + } + } + }, + { + "$id": "7242", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7243", + "name": { + "$id": "7244", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "description" + }, + "type": { + "$id": "7245", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "retrievable": { + "$id": "7246", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "7247", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7248", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "sortable": { + "$id": "7249", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7250", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "analyzer": { + "$id": "7251", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "standard.lucene" + } + } + }, + { + "$id": "7252", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7253", + "name": { + "$id": "7254", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "category" + }, + "type": { + "$id": "7255", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "retrievable": { + "$id": "7256", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "7257", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7258", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "sortable": { + "$id": "7259", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7260", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "analyzer": { + "$id": "7261", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + } + } + }, + { + "$id": "7262", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7263", + "name": { + "$id": "7264", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "ownerId" + }, + "type": { + "$id": "7265", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "retrievable": { + "$id": "7266", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "7267", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7268", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "sortable": { + "$id": "7269", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7270", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "analyzer": { + "$id": "7271", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + } + } + }, + { + "$id": "7272", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7273", + "name": { + "$id": "7274", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "price" + }, + "type": { + "$id": "7275", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.Double" + }, + "retrievable": { + "$id": "7276", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "filterable": { + "$id": "7277", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "sortable": { + "$id": "7278", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7279", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + } + } + } + ] + }, + "scoringProfiles": { + "$id": "7280", + "kind": "array", + "type": { + "$ref": "2998" + }, + "value": [ + { + "$id": "7281", + "kind": "model", + "type": { + "$ref": "2999" + }, + "value": { + "$id": "7282", + "name": { + "$id": "7283", + "kind": "string", + "type": { + "$ref": "3001" + }, + "value": "stringFieldBoost" + }, + "text": { + "$id": "7284", + "kind": "model", + "type": { + "$ref": "3005" + }, + "value": { + "$id": "7285", + "weights": { + "$id": "7286", + "kind": "dict", + "type": { + "$ref": "3007" + }, + "value": { + "$id": "7287", + "name": { + "$id": "7288", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 3 + }, + "description": { + "$id": "7289", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 1 + }, + "category": { + "$id": "7290", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 2 + }, + "ownerId": { + "$id": "7291", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 1 + } + } + } + } + }, + "functions": { + "$id": "7292", + "kind": "array", + "type": { + "$ref": "3015" + }, + "value": [ + { + "$id": "7293", + "kind": "model", + "type": { + "$ref": "3088" + }, + "value": { + "$id": "7294", + "tag": { + "$id": "7295", + "kind": "model", + "type": { + "$ref": "3090" + }, + "value": { + "$id": "7296", + "tagsParameter": { + "$id": "7297", + "kind": "string", + "type": { + "$ref": "3092" + }, + "value": "categoryTag" + } + } + }, + "type": { + "$id": "7298", + "kind": "string", + "type": { + "$ref": "3098" + }, + "value": "tag" + }, + "fieldName": { + "$id": "7299", + "kind": "string", + "type": { + "$ref": "3022" + }, + "value": "category" + }, + "boost": { + "$id": "7300", + "kind": "number", + "type": { + "$ref": "3026" + }, + "value": 2 + } + } + } + ] + } + } + } + ] + }, + "defaultScoringProfile": { + "$id": "7301", + "kind": "string", + "type": { + "$ref": "3110" + }, + "value": "stringFieldBoost" + }, + "corsOptions": { + "$id": "7302", + "kind": "model", + "type": { + "$ref": "3114" + }, + "value": { + "$id": "7303", + "allowedOrigins": { + "$id": "7304", + "kind": "array", + "type": { + "$ref": "3116" + }, + "value": [ + { + "$id": "7305", + "kind": "string", + "type": { + "$ref": "3117" + }, + "value": "https://www.example.com/foo" + } + ] + }, + "maxAgeInSeconds": { + "$id": "7306", + "kind": "number", + "type": { + "$ref": "3121" + }, + "value": 10 + } + } + }, + "suggesters": { + "$id": "7307", + "kind": "array", + "type": { + "$ref": "3127" + }, + "value": [ + { + "$id": "7308", + "kind": "model", + "type": { + "$ref": "3128" + }, + "value": { + "$id": "7309", + "name": { + "$id": "7310", + "kind": "string", + "type": { + "$ref": "3130" + }, + "value": "sg" + }, + "searchMode": { + "$id": "7311", + "kind": "string", + "type": { + "$ref": "3134" + }, + "value": "analyzingInfixMatching" + }, + "sourceFields": { + "$id": "7312", + "kind": "array", + "type": { + "$ref": "3138" + }, + "value": [ + { + "$id": "7313", + "kind": "string", + "type": { + "$ref": "3139" + }, + "value": "category" + }, + { + "$id": "7314", + "kind": "string", + "type": { + "$ref": "3139" + }, + "value": "ownerId" + } + ] + } + } + } + ] + }, + "analyzers": { + "$id": "7315", + "kind": "array", + "type": { + "$ref": "3145" + }, + "value": [] + }, + "tokenizers": { + "$id": "7316", + "kind": "array", + "type": { + "$ref": "3224" + }, + "value": [] + }, + "tokenFilters": { + "$id": "7317", + "kind": "array", + "type": { + "$ref": "3391" + }, + "value": [] + }, + "charFilters": { + "$id": "7318", + "kind": "array", + "type": { + "$ref": "3784" + }, + "value": [] + }, + "normalizers": { + "$id": "7319", + "kind": "array", + "type": { + "$ref": "3823" + }, + "value": [] + }, + "semantic": { + "$id": "7320", + "kind": "model", + "type": { + "$ref": "3933" + }, + "value": { + "$id": "7321", + "defaultConfiguration": { + "$id": "7322", + "kind": "string", + "type": { + "$ref": "3935" + }, + "value": "testconfig" + }, + "configurations": { + "$id": "7323", + "kind": "array", + "type": { + "$ref": "3939" + }, + "value": [ + { + "$id": "7324", + "kind": "model", + "type": { + "$ref": "3940" + }, + "value": { + "$id": "7325", + "name": { + "$id": "7326", + "kind": "string", + "type": { + "$ref": "3942" + }, + "value": "testconfig" + }, + "prioritizedFields": { + "$id": "7327", + "kind": "model", + "type": { + "$ref": "3946" + }, + "value": { + "$id": "7328", + "titleField": { + "$id": "7329", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "7330", + "fieldName": { + "$id": "7331", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "category" + } + } + }, + "prioritizedContentFields": { + "$id": "7332", + "kind": "array", + "type": { + "$ref": "3956" + }, + "value": [ + { + "$id": "7333", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "7334", + "fieldName": { + "$id": "7335", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "description" + } + } + } + ] + }, + "prioritizedKeywordsFields": { + "$id": "7336", + "kind": "array", + "type": { + "$ref": "3960" + }, + "value": [ + { + "$id": "7337", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "7338", + "fieldName": { + "$id": "7339", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "ownerId" + } + } + } + ] + } + } + }, + "flightingOptIn": { + "$id": "7340", + "kind": "boolean", + "type": { + "$ref": "3966" + }, + "value": true + } + } + } + ] + } + } + }, + "vectorSearch": { + "$id": "7341", + "kind": "model", + "type": { + "$ref": "3974" + }, + "value": { + "$id": "7342", + "profiles": { + "$id": "7343", + "kind": "array", + "type": { + "$ref": "3976" + }, + "value": [ + { + "$id": "7344", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "7345", + "name": { + "$id": "7346", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config1" + }, + "algorithm": { + "$id": "7347", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "cosine" + }, + "vectorizer": { + "$id": "7348", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "openai" + }, + "compression": { + "$id": "7349", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "mySQ8" + } + } + }, + { + "$id": "7350", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "7351", + "name": { + "$id": "7352", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config2" + }, + "algorithm": { + "$id": "7353", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "euclidean" + }, + "vectorizer": { + "$id": "7354", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "7355", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "mySQ8" + } + } + }, + { + "$id": "7356", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "7357", + "name": { + "$id": "7358", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config3" + }, + "algorithm": { + "$id": "7359", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "dotProduct" + }, + "vectorizer": { + "$id": "7360", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "7361", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "myBQC" + } + } + }, + { + "$id": "7362", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "7363", + "name": { + "$id": "7364", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config4" + }, + "algorithm": { + "$id": "7365", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "dotProduct" + }, + "vectorizer": { + "$id": "7366", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "7367", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "myBQWithoutOriginals" + } + } + } + ] + }, + "algorithms": { + "$id": "7368", + "kind": "array", + "type": { + "$ref": "3997" + }, + "value": [ + { + "$id": "7369", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "7370", + "hnswParameters": { + "$id": "7371", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "7372", + "metric": { + "$id": "7373", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "cosine" + } + } + }, + "name": { + "$id": "7374", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "cosine" + }, + "kind": { + "$id": "7375", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + } + } + }, + { + "$id": "7376", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "7377", + "hnswParameters": { + "$id": "7378", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "7379", + "metric": { + "$id": "7380", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "euclidean" + } + } + }, + "name": { + "$id": "7381", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "euclidean" + }, + "kind": { + "$id": "7382", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + } + } + }, + { + "$id": "7383", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "7384", + "hnswParameters": { + "$id": "7385", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "7386", + "metric": { + "$id": "7387", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "dotProduct" + } + } + }, + "name": { + "$id": "7388", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "dotProduct" + }, + "kind": { + "$id": "7389", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + } + } + } + ] + }, + "vectorizers": { + "$id": "7390", + "kind": "array", + "type": { + "$ref": "4048" + }, + "value": [ + { + "$id": "7391", + "kind": "model", + "type": { + "$ref": "4058" + }, + "value": { + "$id": "7392", + "azureOpenAIParameters": { + "$id": "7393", + "kind": "model", + "type": { + "$ref": "4060" + }, + "value": { + "$id": "7394", + "resourceUri": { + "$id": "7395", + "kind": "string", + "type": { + "$ref": "4062" + }, + "value": "https://test-sample.openai.azure.com/" + }, + "deploymentId": { + "$id": "7396", + "kind": "string", + "type": { + "$ref": "4066" + }, + "value": "model" + }, + "apiKey": { + "$id": "7397", + "kind": "string", + "type": { + "$ref": "4070" + }, + "value": "api-key" + }, + "modelName": { + "$id": "7398", + "kind": "string", + "type": { + "$ref": "1135" + }, + "value": "text-embedding-3-large" + } + } + }, + "name": { + "$id": "7399", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "openai" + }, + "kind": { + "$id": "7400", + "kind": "string", + "type": { + "$ref": "4082" + }, + "value": "azureOpenAI" + } + } + }, + { + "$id": "7401", + "kind": "model", + "type": { + "$ref": "4086" + }, + "value": { + "$id": "7402", + "customWebApiParameters": { + "$id": "7403", + "kind": "model", + "type": { + "$ref": "4088" + }, + "value": { + "$id": "7404", + "uri": { + "$id": "7405", + "kind": "string", + "type": { + "$ref": "4090" + }, + "value": "https://my-custom-endpoint.org/" + }, + "httpHeaders": { + "$id": "7406", + "kind": "dict", + "type": { + "$ref": "4094" + }, + "value": { + "$id": "7407", + "header1": { + "$id": "7408", + "kind": "string", + "type": { + "$ref": "4096" + }, + "value": "value1" + }, + "header2": { + "$id": "7409", + "kind": "string", + "type": { + "$ref": "4096" + }, + "value": "value2" + } + } + }, + "httpMethod": { + "$id": "7410", + "kind": "string", + "type": { + "$ref": "4100" + }, + "value": "POST" + }, + "timeout": { + "$id": "7411", + "kind": "string", + "type": { + "$ref": "4104" + }, + "value": "PT1M" + }, + "authResourceId": { + "$id": "7412", + "kind": "string", + "type": { + "$ref": "4109" + }, + "value": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b" + } + } + }, + "name": { + "$id": "7413", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "custom-web-api" + }, + "kind": { + "$id": "7414", + "kind": "string", + "type": { + "$ref": "4118" + }, + "value": "customWebApi" + } + } + }, + { + "$id": "7415", + "kind": "model", + "type": { + "$ref": "4147" + }, + "value": { + "$id": "7416", + "amlParameters": { + "$id": "7417", + "kind": "model", + "type": { + "$ref": "4149" + }, + "value": { + "$id": "7418", + "uri": { + "$id": "7419", + "kind": "string", + "type": { + "$ref": "4151" + }, + "value": "https://my-custom-endpoint.org/" + }, + "resourceId": { + "$id": "7420", + "kind": "string", + "type": { + "$ref": "4159" + }, + "value": "aml resource id" + }, + "timeout": { + "$id": "7421", + "kind": "string", + "type": { + "$ref": "4163" + }, + "value": "PT1M" + }, + "region": { + "$id": "7422", + "kind": "string", + "type": { + "$ref": "4168" + }, + "value": "aml region" + }, + "modelName": { + "$id": "7423", + "kind": "string", + "type": { + "$ref": "1143" + }, + "value": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + }, + "name": { + "$id": "7424", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "aml" + }, + "kind": { + "$id": "7425", + "kind": "string", + "type": { + "$ref": "4177" + }, + "value": "aml" + } + } + } + ] + }, + "compressions": { + "$id": "7426", + "kind": "array", + "type": { + "$ref": "4184" + }, + "value": [ + { + "$id": "7427", + "kind": "model", + "type": { + "$ref": "4221" + }, + "value": { + "$id": "7428", + "scalarQuantizationParameters": { + "$id": "7429", + "kind": "model", + "type": { + "$ref": "4223" + }, + "value": { + "$id": "7430", + "quantizedDataType": { + "$id": "7431", + "kind": "string", + "type": { + "$ref": "1169" + }, + "value": "int8" + } + } + }, + "name": { + "$id": "7432", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "mySQ8" + }, + "kind": { + "$id": "7433", + "kind": "string", + "type": { + "$ref": "4230" + }, + "value": "scalarQuantization" + }, + "rescoringOptions": { + "$id": "7434", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "7435", + "enableRescoring": { + "$id": "7436", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "7437", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "7438", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "preserveOriginals" + } + } + }, + "truncationDimension": { + "$id": "7439", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + } + } + }, + { + "$id": "7440", + "kind": "model", + "type": { + "$ref": "4234" + }, + "value": { + "$id": "7441", + "name": { + "$id": "7442", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "myBQC" + }, + "kind": { + "$id": "7443", + "kind": "string", + "type": { + "$ref": "4236" + }, + "value": "binaryQuantization" + }, + "rescoringOptions": { + "$id": "7444", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "7445", + "enableRescoring": { + "$id": "7446", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "7447", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "7448", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "preserveOriginals" + } + } + }, + "truncationDimension": { + "$id": "7449", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + } + } + }, + { + "$id": "7450", + "kind": "model", + "type": { + "$ref": "4234" + }, + "value": { + "$id": "7451", + "name": { + "$id": "7452", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "myBQWithoutOriginals" + }, + "kind": { + "$id": "7453", + "kind": "string", + "type": { + "$ref": "4236" + }, + "value": "binaryQuantization" + }, + "rescoringOptions": { + "$id": "7454", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "7455", + "enableRescoring": { + "$id": "7456", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "7457", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "7458", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "discardOriginals" + } + } + }, + "truncationDimension": { + "$id": "7459", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + } + } + } + ] + } + } + }, + "@odata.etag": { + "$id": "7460", + "kind": "string", + "type": { + "$ref": "4245" + }, + "value": "0x1234568AE7E58A1" + } + } + } + } + ], + "responses": [ + { + "$id": "7461", + "response": { + "$ref": "7167" + }, + "statusCode": 201, + "bodyValue": { + "$id": "7462", + "kind": "model", + "type": { + "$ref": "2920" + }, + "value": { + "$id": "7463", + "@odata.etag": { + "$id": "7464", + "kind": "string", + "type": { + "$ref": "4245" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "7465", + "kind": "string", + "type": { + "$ref": "2922" + }, + "value": "temp-preview-test" + }, + "defaultScoringProfile": { + "$id": "7466", + "kind": "string", + "type": { + "$ref": "3110" + }, + "value": "stringFieldBoost" + }, + "fields": { + "$id": "7467", + "kind": "array", + "type": { + "$ref": "2926" + }, + "value": [ + { + "$id": "7468", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7469", + "name": { + "$id": "7470", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "id" + }, + "type": { + "$id": "7471", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "7472", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7473", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "7474", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7475", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7476", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7477", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "7478", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": true + }, + "synonymMaps": { + "$id": "7479", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7480", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7481", + "name": { + "$id": "7482", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector1" + }, + "type": { + "$id": "7483", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "7484", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7485", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "7486", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7487", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7488", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "7489", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "7490", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "7491", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 20 + }, + "vectorSearchProfile": { + "$id": "7492", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config1" + }, + "synonymMaps": { + "$id": "7493", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7494", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7495", + "name": { + "$id": "7496", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector1b" + }, + "type": { + "$id": "7497", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "7498", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7499", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "7500", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7501", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7502", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "7503", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "7504", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "7505", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 10 + }, + "vectorSearchProfile": { + "$id": "7506", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config2" + }, + "synonymMaps": { + "$id": "7507", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7508", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7509", + "name": { + "$id": "7510", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector2" + }, + "type": { + "$id": "7511", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "7512", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7513", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "7514", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7515", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7516", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "7517", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "7518", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "7519", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 5 + }, + "vectorSearchProfile": { + "$id": "7520", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config3" + }, + "synonymMaps": { + "$id": "7521", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7522", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7523", + "name": { + "$id": "7524", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector3" + }, + "type": { + "$id": "7525", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "7526", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7527", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "7528", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7529", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7530", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "7531", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "7532", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "7533", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 5 + }, + "vectorSearchProfile": { + "$id": "7534", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config3" + }, + "synonymMaps": { + "$id": "7535", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7536", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7537", + "name": { + "$id": "7538", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector22" + }, + "type": { + "$id": "7539", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "7540", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7541", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "7542", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7543", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7544", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "7545", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "7546", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "7547", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 10 + }, + "vectorSearchProfile": { + "$id": "7548", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config2" + }, + "synonymMaps": { + "$id": "7549", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7550", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7551", + "name": { + "$id": "7552", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector4" + }, + "type": { + "$id": "7553", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "7554", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7555", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "7556", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7557", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7558", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "7559", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "7560", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "7561", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 32 + }, + "vectorSearchProfile": { + "$id": "7562", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config4" + }, + "synonymMaps": { + "$id": "7563", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7564", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7565", + "name": { + "$id": "7566", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "name" + }, + "type": { + "$id": "7567", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "7568", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7569", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "7570", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7571", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7572", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7573", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "7574", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "7575", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + }, + "synonymMaps": { + "$id": "7576", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7577", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7578", + "name": { + "$id": "7579", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "description" + }, + "type": { + "$id": "7580", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "7581", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7582", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "7583", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7584", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7585", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7586", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "7587", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "7588", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "standard.lucene" + }, + "synonymMaps": { + "$id": "7589", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7590", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7591", + "name": { + "$id": "7592", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "category" + }, + "type": { + "$id": "7593", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "7594", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7595", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "7596", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7597", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7598", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7599", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "7600", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "7601", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + }, + "synonymMaps": { + "$id": "7602", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7603", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7604", + "name": { + "$id": "7605", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "ownerId" + }, + "type": { + "$id": "7606", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "7607", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7608", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "7609", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7610", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7611", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7612", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "7613", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "7614", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + }, + "synonymMaps": { + "$id": "7615", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7616", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7617", + "name": { + "$id": "7618", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "price" + }, + "type": { + "$id": "7619", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.Double" + }, + "searchable": { + "$id": "7620", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": false + }, + "filterable": { + "$id": "7621", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "7622", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7623", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7624", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7625", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "7626", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "synonymMaps": { + "$id": "7627", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + } + ] + }, + "scoringProfiles": { + "$id": "7628", + "kind": "array", + "type": { + "$ref": "2998" + }, + "value": [ + { + "$id": "7629", + "kind": "model", + "type": { + "$ref": "2999" + }, + "value": { + "$id": "7630", + "name": { + "$id": "7631", + "kind": "string", + "type": { + "$ref": "3001" + }, + "value": "stringFieldBoost" + }, + "functionAggregation": { + "$id": "7632", + "kind": "string", + "type": { + "$ref": "524" + }, + "value": "sum" + }, + "text": { + "$id": "7633", + "kind": "model", + "type": { + "$ref": "3005" + }, + "value": { + "$id": "7634", + "weights": { + "$id": "7635", + "kind": "dict", + "type": { + "$ref": "3007" + }, + "value": { + "$id": "7636", + "name": { + "$id": "7637", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 3 + }, + "description": { + "$id": "7638", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 1 + }, + "category": { + "$id": "7639", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 2 + }, + "ownerId": { + "$id": "7640", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 1 + } + } + } + } + }, + "functions": { + "$id": "7641", + "kind": "array", + "type": { + "$ref": "3015" + }, + "value": [ + { + "$id": "7642", + "kind": "model", + "type": { + "$ref": "3088" + }, + "value": { + "$id": "7643", + "fieldName": { + "$id": "7644", + "kind": "string", + "type": { + "$ref": "3022" + }, + "value": "category" + }, + "interpolation": { + "$id": "7645", + "kind": "string", + "type": { + "$ref": "514" + }, + "value": "linear" + }, + "type": { + "$id": "7646", + "kind": "string", + "type": { + "$ref": "3098" + }, + "value": "tag" + }, + "boost": { + "$id": "7647", + "kind": "number", + "type": { + "$ref": "3026" + }, + "value": 2 + }, + "tag": { + "$id": "7648", + "kind": "model", + "type": { + "$ref": "3090" + }, + "value": { + "$id": "7649", + "tagsParameter": { + "$id": "7650", + "kind": "string", + "type": { + "$ref": "3092" + }, + "value": "categoryTag" + } + } + } + } + } + ] + } + } + } + ] + }, + "corsOptions": { + "$id": "7651", + "kind": "model", + "type": { + "$ref": "3114" + }, + "value": { + "$id": "7652", + "allowedOrigins": { + "$id": "7653", + "kind": "array", + "type": { + "$ref": "3116" + }, + "value": [ + { + "$id": "7654", + "kind": "string", + "type": { + "$ref": "3117" + }, + "value": "https://www.example.com/foo" + } + ] + }, + "maxAgeInSeconds": { + "$id": "7655", + "kind": "number", + "type": { + "$ref": "3121" + }, + "value": 10 + } + } + }, + "suggesters": { + "$id": "7656", + "kind": "array", + "type": { + "$ref": "3127" + }, + "value": [ + { + "$id": "7657", + "kind": "model", + "type": { + "$ref": "3128" + }, + "value": { + "$id": "7658", + "name": { + "$id": "7659", + "kind": "string", + "type": { + "$ref": "3130" + }, + "value": "sg" + }, + "searchMode": { + "$id": "7660", + "kind": "string", + "type": { + "$ref": "3134" + }, + "value": "analyzingInfixMatching" + }, + "sourceFields": { + "$id": "7661", + "kind": "array", + "type": { + "$ref": "3138" + }, + "value": [ + { + "$id": "7662", + "kind": "string", + "type": { + "$ref": "3139" + }, + "value": "category" + }, + { + "$id": "7663", + "kind": "string", + "type": { + "$ref": "3139" + }, + "value": "ownerId" + } + ] + } + } + } + ] + }, + "analyzers": { + "$id": "7664", + "kind": "array", + "type": { + "$ref": "3145" + }, + "value": [] + }, + "normalizers": { + "$id": "7665", + "kind": "array", + "type": { + "$ref": "3823" + }, + "value": [] + }, + "tokenizers": { + "$id": "7666", + "kind": "array", + "type": { + "$ref": "3224" + }, + "value": [] + }, + "tokenFilters": { + "$id": "7667", + "kind": "array", + "type": { + "$ref": "3391" + }, + "value": [] + }, + "charFilters": { + "$id": "7668", + "kind": "array", + "type": { + "$ref": "3784" + }, + "value": [] + }, + "semantic": { + "$id": "7669", + "kind": "model", + "type": { + "$ref": "3933" + }, + "value": { + "$id": "7670", + "defaultConfiguration": { + "$id": "7671", + "kind": "string", + "type": { + "$ref": "3935" + }, + "value": "testconfig" + }, + "configurations": { + "$id": "7672", + "kind": "array", + "type": { + "$ref": "3939" + }, + "value": [ + { + "$id": "7673", + "kind": "model", + "type": { + "$ref": "3940" + }, + "value": { + "$id": "7674", + "name": { + "$id": "7675", + "kind": "string", + "type": { + "$ref": "3942" + }, + "value": "testconfig" + }, + "flightingOptIn": { + "$id": "7676", + "kind": "boolean", + "type": { + "$ref": "3966" + }, + "value": false + }, + "prioritizedFields": { + "$id": "7677", + "kind": "model", + "type": { + "$ref": "3946" + }, + "value": { + "$id": "7678", + "titleField": { + "$id": "7679", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "7680", + "fieldName": { + "$id": "7681", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "category" + } + } + }, + "prioritizedContentFields": { + "$id": "7682", + "kind": "array", + "type": { + "$ref": "3956" + }, + "value": [ + { + "$id": "7683", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "7684", + "fieldName": { + "$id": "7685", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "description" + } + } + } + ] + }, + "prioritizedKeywordsFields": { + "$id": "7686", + "kind": "array", + "type": { + "$ref": "3960" + }, + "value": [ + { + "$id": "7687", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "7688", + "fieldName": { + "$id": "7689", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "ownerId" + } + } + } + ] + } + } + } + } + } + ] + } + } + }, + "vectorSearch": { + "$id": "7690", + "kind": "model", + "type": { + "$ref": "3974" + }, + "value": { + "$id": "7691", + "algorithms": { + "$id": "7692", + "kind": "array", + "type": { + "$ref": "3997" + }, + "value": [ + { + "$id": "7693", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "7694", + "name": { + "$id": "7695", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "cosine" + }, + "kind": { + "$id": "7696", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + }, + "hnswParameters": { + "$id": "7697", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "7698", + "metric": { + "$id": "7699", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "cosine" + }, + "m": { + "$id": "7700", + "kind": "number", + "type": { + "$ref": "4011" + }, + "value": 4 + }, + "efConstruction": { + "$id": "7701", + "kind": "number", + "type": { + "$ref": "4015" + }, + "value": 400 + }, + "efSearch": { + "$id": "7702", + "kind": "number", + "type": { + "$ref": "4019" + }, + "value": 500 + } + } + } + } + }, + { + "$id": "7703", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "7704", + "name": { + "$id": "7705", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "euclidean" + }, + "kind": { + "$id": "7706", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + }, + "hnswParameters": { + "$id": "7707", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "7708", + "metric": { + "$id": "7709", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "euclidean" + }, + "m": { + "$id": "7710", + "kind": "number", + "type": { + "$ref": "4011" + }, + "value": 4 + }, + "efConstruction": { + "$id": "7711", + "kind": "number", + "type": { + "$ref": "4015" + }, + "value": 400 + }, + "efSearch": { + "$id": "7712", + "kind": "number", + "type": { + "$ref": "4019" + }, + "value": 500 + } + } + } + } + }, + { + "$id": "7713", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "7714", + "name": { + "$id": "7715", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "dotProduct" + }, + "kind": { + "$id": "7716", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + }, + "hnswParameters": { + "$id": "7717", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "7718", + "metric": { + "$id": "7719", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "dotProduct" + }, + "m": { + "$id": "7720", + "kind": "number", + "type": { + "$ref": "4011" + }, + "value": 4 + }, + "efConstruction": { + "$id": "7721", + "kind": "number", + "type": { + "$ref": "4015" + }, + "value": 400 + }, + "efSearch": { + "$id": "7722", + "kind": "number", + "type": { + "$ref": "4019" + }, + "value": 500 + } + } + } + } + } + ] + }, + "profiles": { + "$id": "7723", + "kind": "array", + "type": { + "$ref": "3976" + }, + "value": [ + { + "$id": "7724", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "7725", + "name": { + "$id": "7726", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config1" + }, + "algorithm": { + "$id": "7727", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "cosine" + }, + "vectorizer": { + "$id": "7728", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "openai" + }, + "compression": { + "$id": "7729", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "mySQ8" + } + } + }, + { + "$id": "7730", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "7731", + "name": { + "$id": "7732", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config2" + }, + "algorithm": { + "$id": "7733", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "euclidean" + }, + "vectorizer": { + "$id": "7734", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "7735", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "mySQ8" + } + } + }, + { + "$id": "7736", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "7737", + "name": { + "$id": "7738", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config3" + }, + "algorithm": { + "$id": "7739", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "dotProduct" + }, + "vectorizer": { + "$id": "7740", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "7741", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "myBQC" + } + } + }, + { + "$id": "7742", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "7743", + "name": { + "$id": "7744", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config4" + }, + "algorithm": { + "$id": "7745", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "dotProduct" + }, + "vectorizer": { + "$id": "7746", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "7747", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "myBQWithoutOriginals" + } + } + } + ] + }, + "vectorizers": { + "$id": "7748", + "kind": "array", + "type": { + "$ref": "4048" + }, + "value": [ + { + "$id": "7749", + "kind": "model", + "type": { + "$ref": "4058" + }, + "value": { + "$id": "7750", + "name": { + "$id": "7751", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "openai" + }, + "kind": { + "$id": "7752", + "kind": "string", + "type": { + "$ref": "4082" + }, + "value": "azureOpenAI" + }, + "azureOpenAIParameters": { + "$id": "7753", + "kind": "model", + "type": { + "$ref": "4060" + }, + "value": { + "$id": "7754", + "resourceUri": { + "$id": "7755", + "kind": "string", + "type": { + "$ref": "4062" + }, + "value": "https://test-sample.openai.azure.com" + }, + "deploymentId": { + "$id": "7756", + "kind": "string", + "type": { + "$ref": "4066" + }, + "value": "model" + }, + "apiKey": { + "$id": "7757", + "kind": "string", + "type": { + "$ref": "4070" + }, + "value": "api-key" + }, + "modelName": { + "$id": "7758", + "kind": "string", + "type": { + "$ref": "1135" + }, + "value": "text-embedding-3-large" + } + } + } + } + }, + { + "$id": "7759", + "kind": "model", + "type": { + "$ref": "4086" + }, + "value": { + "$id": "7760", + "name": { + "$id": "7761", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "custom-web-api" + }, + "kind": { + "$id": "7762", + "kind": "string", + "type": { + "$ref": "4118" + }, + "value": "customWebApi" + }, + "customWebApiParameters": { + "$id": "7763", + "kind": "model", + "type": { + "$ref": "4088" + }, + "value": { + "$id": "7764", + "httpMethod": { + "$id": "7765", + "kind": "string", + "type": { + "$ref": "4100" + }, + "value": "POST" + }, + "uri": { + "$id": "7766", + "kind": "string", + "type": { + "$ref": "4090" + }, + "value": "https://my-custom-endpoint.org/" + }, + "timeout": { + "$id": "7767", + "kind": "string", + "type": { + "$ref": "4104" + }, + "value": "PT1M" + }, + "authResourceId": { + "$id": "7768", + "kind": "string", + "type": { + "$ref": "4109" + }, + "value": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b" + }, + "httpHeaders": { + "$id": "7769", + "kind": "dict", + "type": { + "$ref": "4094" + }, + "value": { + "$id": "7770", + "header1": { + "$id": "7771", + "kind": "string", + "type": { + "$ref": "4096" + }, + "value": "value1" + }, + "header2": { + "$id": "7772", + "kind": "string", + "type": { + "$ref": "4096" + }, + "value": "value2" + } + } + } + } + } + } + }, + { + "$id": "7773", + "kind": "model", + "type": { + "$ref": "4147" + }, + "value": { + "$id": "7774", + "name": { + "$id": "7775", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "aml" + }, + "kind": { + "$id": "7776", + "kind": "string", + "type": { + "$ref": "4177" + }, + "value": "aml" + }, + "amlParameters": { + "$id": "7777", + "kind": "model", + "type": { + "$ref": "4149" + }, + "value": { + "$id": "7778", + "resourceId": { + "$id": "7779", + "kind": "string", + "type": { + "$ref": "4159" + }, + "value": "aml resource id" + }, + "region": { + "$id": "7780", + "kind": "string", + "type": { + "$ref": "4168" + }, + "value": "aml region" + }, + "uri": { + "$id": "7781", + "kind": "string", + "type": { + "$ref": "4151" + }, + "value": "https://my-custom-endpoint.org/" + }, + "timeout": { + "$id": "7782", + "kind": "string", + "type": { + "$ref": "4163" + }, + "value": "PT1M" + }, + "modelName": { + "$id": "7783", + "kind": "string", + "type": { + "$ref": "1143" + }, + "value": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + } + } + } + ] + }, + "compressions": { + "$id": "7784", + "kind": "array", + "type": { + "$ref": "4184" + }, + "value": [ + { + "$id": "7785", + "kind": "model", + "type": { + "$ref": "4221" + }, + "value": { + "$id": "7786", + "name": { + "$id": "7787", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "mySQ8" + }, + "kind": { + "$id": "7788", + "kind": "string", + "type": { + "$ref": "4230" + }, + "value": "scalarQuantization" + }, + "truncationDimension": { + "$id": "7789", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + }, + "scalarQuantizationParameters": { + "$id": "7790", + "kind": "model", + "type": { + "$ref": "4223" + }, + "value": { + "$id": "7791", + "quantizedDataType": { + "$id": "7792", + "kind": "string", + "type": { + "$ref": "1169" + }, + "value": "int8" + } + } + }, + "rescoringOptions": { + "$id": "7793", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "7794", + "enableRescoring": { + "$id": "7795", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "7796", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "7797", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "preserveOriginals" + } + } + } + } + }, + { + "$id": "7798", + "kind": "model", + "type": { + "$ref": "4234" + }, + "value": { + "$id": "7799", + "name": { + "$id": "7800", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "myBQC" + }, + "kind": { + "$id": "7801", + "kind": "string", + "type": { + "$ref": "4236" + }, + "value": "binaryQuantization" + }, + "truncationDimension": { + "$id": "7802", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + }, + "rescoringOptions": { + "$id": "7803", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "7804", + "enableRescoring": { + "$id": "7805", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "7806", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "7807", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "preserveOriginals" + } + } + } + } + }, + { + "$id": "7808", + "kind": "model", + "type": { + "$ref": "4234" + }, + "value": { + "$id": "7809", + "name": { + "$id": "7810", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "myBQWithoutOriginals" + }, + "kind": { + "$id": "7811", + "kind": "string", + "type": { + "$ref": "4236" + }, + "value": "binaryQuantization" + }, + "truncationDimension": { + "$id": "7812", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + }, + "rescoringOptions": { + "$id": "7813", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "7814", + "enableRescoring": { + "$id": "7815", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "7816", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "7817", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "discardOriginals" + } + } + } + } + } + ] + } + } + } + } + } + } + ] + } + ] + }, + { + "$id": "7818", + "name": "list", + "resourceName": "Indexes", + "doc": "Lists all indexes available for a search service.", + "accessibility": "public", + "parameters": [ + { + "$id": "7819", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "7820", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "7821", + "type": { + "$id": "7822", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7823", + "name": "$select", + "nameInRequest": "$select", + "doc": "Selects which top-level properties to retrieve.\nSpecified as a comma-separated list of JSON property names,\nor '*' for all properties. The default is all properties.", + "type": { + "$id": "7824", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7825", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "7826", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "7827", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "7828", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "7829", + "kind": "constant", + "valueType": { + "$id": "7830", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "7831", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "4248" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/indexes", + "bufferResponse": true, + "paging": { + "$id": "7832", + "itemPropertySegments": [ + "indexes" + ] + }, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexes.list", + "decorators": [], + "examples": [ + { + "$id": "7833", + "kind": "http", + "name": "SearchServiceListIndexes", + "description": "SearchServiceListIndexes", + "filePath": "2025-03-01-preview/SearchServiceListIndexes.json", + "parameters": [ + { + "$id": "7834", + "parameter": { + "$ref": "7819" + }, + "value": { + "$id": "7835", + "kind": "string", + "type": { + "$ref": "7820" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "7836", + "parameter": { + "$ref": "7825" + }, + "value": { + "$id": "7837", + "kind": "string", + "type": { + "$ref": "7826" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "7838", + "response": { + "$ref": "7831" + }, + "statusCode": 200, + "bodyValue": { + "$id": "7839", + "kind": "model", + "type": { + "$ref": "4248" + }, + "value": { + "$id": "7840", + "value": { + "$id": "7841", + "kind": "array", + "type": { + "$ref": "4250" + }, + "value": [ + { + "$id": "7842", + "kind": "model", + "type": { + "$ref": "2920" + }, + "value": { + "$id": "7843", + "@odata.etag": { + "$id": "7844", + "kind": "string", + "type": { + "$ref": "4245" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "7845", + "kind": "string", + "type": { + "$ref": "2922" + }, + "value": "preview-test" + }, + "defaultScoringProfile": { + "$id": "7846", + "kind": "string", + "type": { + "$ref": "3110" + }, + "value": "stringFieldBoost" + }, + "fields": { + "$id": "7847", + "kind": "array", + "type": { + "$ref": "2926" + }, + "value": [ + { + "$id": "7848", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7849", + "name": { + "$id": "7850", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "id" + }, + "type": { + "$id": "7851", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "7852", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7853", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "7854", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7855", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7856", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7857", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "7858", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": true + }, + "synonymMaps": { + "$id": "7859", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7860", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7861", + "name": { + "$id": "7862", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector1" + }, + "type": { + "$id": "7863", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "7864", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7865", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "7866", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7867", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7868", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "7869", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "7870", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "7871", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 20 + }, + "vectorSearchProfile": { + "$id": "7872", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config1" + }, + "synonymMaps": { + "$id": "7873", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7874", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7875", + "name": { + "$id": "7876", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector1b" + }, + "type": { + "$id": "7877", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "7878", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7879", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "7880", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7881", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7882", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "7883", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "7884", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "7885", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 10 + }, + "vectorSearchProfile": { + "$id": "7886", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config2" + }, + "synonymMaps": { + "$id": "7887", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7888", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7889", + "name": { + "$id": "7890", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector2" + }, + "type": { + "$id": "7891", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "7892", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7893", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "7894", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7895", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7896", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "7897", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "7898", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "7899", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 5 + }, + "vectorSearchProfile": { + "$id": "7900", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config3" + }, + "synonymMaps": { + "$id": "7901", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7902", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7903", + "name": { + "$id": "7904", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector3" + }, + "type": { + "$id": "7905", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "7906", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7907", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "7908", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7909", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7910", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "7911", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "7912", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "7913", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 5 + }, + "vectorSearchProfile": { + "$id": "7914", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config3" + }, + "synonymMaps": { + "$id": "7915", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7916", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7917", + "name": { + "$id": "7918", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector22" + }, + "type": { + "$id": "7919", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "7920", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7921", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "7922", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7923", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7924", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "7925", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "7926", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "7927", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 10 + }, + "vectorSearchProfile": { + "$id": "7928", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config2" + }, + "synonymMaps": { + "$id": "7929", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7930", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7931", + "name": { + "$id": "7932", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector4" + }, + "type": { + "$id": "7933", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "7934", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7935", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "7936", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7937", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7938", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "7939", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "7940", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "7941", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 32 + }, + "vectorSearchProfile": { + "$id": "7942", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config4" + }, + "synonymMaps": { + "$id": "7943", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7944", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7945", + "name": { + "$id": "7946", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "name" + }, + "type": { + "$id": "7947", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "7948", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7949", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "7950", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7951", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7952", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7953", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "7954", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "7955", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + }, + "synonymMaps": { + "$id": "7956", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7957", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7958", + "name": { + "$id": "7959", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "description" + }, + "type": { + "$id": "7960", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "7961", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7962", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "7963", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7964", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7965", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7966", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "7967", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "7968", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "standard.lucene" + }, + "synonymMaps": { + "$id": "7969", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7970", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7971", + "name": { + "$id": "7972", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "category" + }, + "type": { + "$id": "7973", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "7974", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7975", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "7976", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7977", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7978", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7979", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "7980", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "7981", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + }, + "synonymMaps": { + "$id": "7982", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7983", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7984", + "name": { + "$id": "7985", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "ownerId" + }, + "type": { + "$id": "7986", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "7987", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "7988", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "7989", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "7990", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "7991", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "7992", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "7993", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "7994", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + }, + "synonymMaps": { + "$id": "7995", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "7996", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "7997", + "name": { + "$id": "7998", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "price" + }, + "type": { + "$id": "7999", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.Double" + }, + "searchable": { + "$id": "8000", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": false + }, + "filterable": { + "$id": "8001", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "8002", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8003", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8004", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "8005", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "8006", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "synonymMaps": { + "$id": "8007", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + } + ] + }, + "scoringProfiles": { + "$id": "8008", + "kind": "array", + "type": { + "$ref": "2998" + }, + "value": [ + { + "$id": "8009", + "kind": "model", + "type": { + "$ref": "2999" + }, + "value": { + "$id": "8010", + "name": { + "$id": "8011", + "kind": "string", + "type": { + "$ref": "3001" + }, + "value": "stringFieldBoost" + }, + "functionAggregation": { + "$id": "8012", + "kind": "string", + "type": { + "$ref": "524" + }, + "value": "sum" + }, + "text": { + "$id": "8013", + "kind": "model", + "type": { + "$ref": "3005" + }, + "value": { + "$id": "8014", + "weights": { + "$id": "8015", + "kind": "dict", + "type": { + "$ref": "3007" + }, + "value": { + "$id": "8016", + "name": { + "$id": "8017", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 3 + }, + "description": { + "$id": "8018", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 1 + }, + "category": { + "$id": "8019", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 2 + }, + "ownerId": { + "$id": "8020", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 1 + } + } + } + } + }, + "functions": { + "$id": "8021", + "kind": "array", + "type": { + "$ref": "3015" + }, + "value": [ + { + "$id": "8022", + "kind": "model", + "type": { + "$ref": "3088" + }, + "value": { + "$id": "8023", + "fieldName": { + "$id": "8024", + "kind": "string", + "type": { + "$ref": "3022" + }, + "value": "category" + }, + "interpolation": { + "$id": "8025", + "kind": "string", + "type": { + "$ref": "514" + }, + "value": "linear" + }, + "type": { + "$id": "8026", + "kind": "string", + "type": { + "$ref": "3098" + }, + "value": "tag" + }, + "boost": { + "$id": "8027", + "kind": "number", + "type": { + "$ref": "3026" + }, + "value": 2 + }, + "tag": { + "$id": "8028", + "kind": "model", + "type": { + "$ref": "3090" + }, + "value": { + "$id": "8029", + "tagsParameter": { + "$id": "8030", + "kind": "string", + "type": { + "$ref": "3092" + }, + "value": "categoryTag" + } + } + } + } + } + ] + } + } + } + ] + }, + "corsOptions": { + "$id": "8031", + "kind": "model", + "type": { + "$ref": "3114" + }, + "value": { + "$id": "8032", + "allowedOrigins": { + "$id": "8033", + "kind": "array", + "type": { + "$ref": "3116" + }, + "value": [ + { + "$id": "8034", + "kind": "string", + "type": { + "$ref": "3117" + }, + "value": "https://www.example.com/foo" + } + ] + }, + "maxAgeInSeconds": { + "$id": "8035", + "kind": "number", + "type": { + "$ref": "3121" + }, + "value": 10 + } + } + }, + "suggesters": { + "$id": "8036", + "kind": "array", + "type": { + "$ref": "3127" + }, + "value": [ + { + "$id": "8037", + "kind": "model", + "type": { + "$ref": "3128" + }, + "value": { + "$id": "8038", + "name": { + "$id": "8039", + "kind": "string", + "type": { + "$ref": "3130" + }, + "value": "sg" + }, + "searchMode": { + "$id": "8040", + "kind": "string", + "type": { + "$ref": "3134" + }, + "value": "analyzingInfixMatching" + }, + "sourceFields": { + "$id": "8041", + "kind": "array", + "type": { + "$ref": "3138" + }, + "value": [ + { + "$id": "8042", + "kind": "string", + "type": { + "$ref": "3139" + }, + "value": "category" + }, + { + "$id": "8043", + "kind": "string", + "type": { + "$ref": "3139" + }, + "value": "ownerId" + } + ] + } + } + } + ] + }, + "analyzers": { + "$id": "8044", + "kind": "array", + "type": { + "$ref": "3145" + }, + "value": [] + }, + "normalizers": { + "$id": "8045", + "kind": "array", + "type": { + "$ref": "3823" + }, + "value": [] + }, + "tokenizers": { + "$id": "8046", + "kind": "array", + "type": { + "$ref": "3224" + }, + "value": [] + }, + "tokenFilters": { + "$id": "8047", + "kind": "array", + "type": { + "$ref": "3391" + }, + "value": [] + }, + "charFilters": { + "$id": "8048", + "kind": "array", + "type": { + "$ref": "3784" + }, + "value": [] + }, + "semantic": { + "$id": "8049", + "kind": "model", + "type": { + "$ref": "3933" + }, + "value": { + "$id": "8050", + "defaultConfiguration": { + "$id": "8051", + "kind": "string", + "type": { + "$ref": "3935" + }, + "value": "testconfig" + }, + "configurations": { + "$id": "8052", + "kind": "array", + "type": { + "$ref": "3939" + }, + "value": [ + { + "$id": "8053", + "kind": "model", + "type": { + "$ref": "3940" + }, + "value": { + "$id": "8054", + "name": { + "$id": "8055", + "kind": "string", + "type": { + "$ref": "3942" + }, + "value": "testconfig" + }, + "flightingOptIn": { + "$id": "8056", + "kind": "boolean", + "type": { + "$ref": "3966" + }, + "value": false + }, + "prioritizedFields": { + "$id": "8057", + "kind": "model", + "type": { + "$ref": "3946" + }, + "value": { + "$id": "8058", + "titleField": { + "$id": "8059", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "8060", + "fieldName": { + "$id": "8061", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "category" + } + } + }, + "prioritizedContentFields": { + "$id": "8062", + "kind": "array", + "type": { + "$ref": "3956" + }, + "value": [ + { + "$id": "8063", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "8064", + "fieldName": { + "$id": "8065", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "description" + } + } + } + ] + }, + "prioritizedKeywordsFields": { + "$id": "8066", + "kind": "array", + "type": { + "$ref": "3960" + }, + "value": [ + { + "$id": "8067", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "8068", + "fieldName": { + "$id": "8069", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "ownerId" + } + } + } + ] + } + } + } + } + } + ] + } + } + }, + "vectorSearch": { + "$id": "8070", + "kind": "model", + "type": { + "$ref": "3974" + }, + "value": { + "$id": "8071", + "algorithms": { + "$id": "8072", + "kind": "array", + "type": { + "$ref": "3997" + }, + "value": [ + { + "$id": "8073", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "8074", + "name": { + "$id": "8075", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "cosine" + }, + "kind": { + "$id": "8076", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + }, + "hnswParameters": { + "$id": "8077", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "8078", + "metric": { + "$id": "8079", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "cosine" + }, + "m": { + "$id": "8080", + "kind": "number", + "type": { + "$ref": "4011" + }, + "value": 4 + }, + "efConstruction": { + "$id": "8081", + "kind": "number", + "type": { + "$ref": "4015" + }, + "value": 400 + }, + "efSearch": { + "$id": "8082", + "kind": "number", + "type": { + "$ref": "4019" + }, + "value": 500 + } + } + } + } + }, + { + "$id": "8083", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "8084", + "name": { + "$id": "8085", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "euclidean" + }, + "kind": { + "$id": "8086", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + }, + "hnswParameters": { + "$id": "8087", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "8088", + "metric": { + "$id": "8089", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "euclidean" + }, + "m": { + "$id": "8090", + "kind": "number", + "type": { + "$ref": "4011" + }, + "value": 4 + }, + "efConstruction": { + "$id": "8091", + "kind": "number", + "type": { + "$ref": "4015" + }, + "value": 400 + }, + "efSearch": { + "$id": "8092", + "kind": "number", + "type": { + "$ref": "4019" + }, + "value": 500 + } + } + } + } + }, + { + "$id": "8093", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "8094", + "name": { + "$id": "8095", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "dotProduct" + }, + "kind": { + "$id": "8096", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + }, + "hnswParameters": { + "$id": "8097", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "8098", + "metric": { + "$id": "8099", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "dotProduct" + }, + "m": { + "$id": "8100", + "kind": "number", + "type": { + "$ref": "4011" + }, + "value": 4 + }, + "efConstruction": { + "$id": "8101", + "kind": "number", + "type": { + "$ref": "4015" + }, + "value": 400 + }, + "efSearch": { + "$id": "8102", + "kind": "number", + "type": { + "$ref": "4019" + }, + "value": 500 + } + } + } + } + } + ] + }, + "profiles": { + "$id": "8103", + "kind": "array", + "type": { + "$ref": "3976" + }, + "value": [ + { + "$id": "8104", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "8105", + "name": { + "$id": "8106", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config1" + }, + "algorithm": { + "$id": "8107", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "cosine" + }, + "vectorizer": { + "$id": "8108", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "openai" + }, + "compression": { + "$id": "8109", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "mySQ8" + } + } + }, + { + "$id": "8110", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "8111", + "name": { + "$id": "8112", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config2" + }, + "algorithm": { + "$id": "8113", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "euclidean" + }, + "vectorizer": { + "$id": "8114", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "8115", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "mySQ8" + } + } + }, + { + "$id": "8116", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "8117", + "name": { + "$id": "8118", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config3" + }, + "algorithm": { + "$id": "8119", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "dotProduct" + }, + "vectorizer": { + "$id": "8120", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "8121", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "myBQC" + } + } + }, + { + "$id": "8122", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "8123", + "name": { + "$id": "8124", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config4" + }, + "algorithm": { + "$id": "8125", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "dotProduct" + }, + "vectorizer": { + "$id": "8126", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "8127", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "myBQWithoutOriginals" + } + } + } + ] + }, + "vectorizers": { + "$id": "8128", + "kind": "array", + "type": { + "$ref": "4048" + }, + "value": [ + { + "$id": "8129", + "kind": "model", + "type": { + "$ref": "4058" + }, + "value": { + "$id": "8130", + "name": { + "$id": "8131", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "openai" + }, + "kind": { + "$id": "8132", + "kind": "string", + "type": { + "$ref": "4082" + }, + "value": "azureOpenAI" + }, + "azureOpenAIParameters": { + "$id": "8133", + "kind": "model", + "type": { + "$ref": "4060" + }, + "value": { + "$id": "8134", + "resourceUri": { + "$id": "8135", + "kind": "string", + "type": { + "$ref": "4062" + }, + "value": "https://test-sample.openai.azure.com" + }, + "deploymentId": { + "$id": "8136", + "kind": "string", + "type": { + "$ref": "4066" + }, + "value": "model" + }, + "apiKey": { + "$id": "8137", + "kind": "string", + "type": { + "$ref": "4070" + }, + "value": "" + }, + "modelName": { + "$id": "8138", + "kind": "string", + "type": { + "$ref": "1135" + }, + "value": "text-embedding-3-large" + } + } + } + } + }, + { + "$id": "8139", + "kind": "model", + "type": { + "$ref": "4086" + }, + "value": { + "$id": "8140", + "name": { + "$id": "8141", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "custom-web-api" + }, + "kind": { + "$id": "8142", + "kind": "string", + "type": { + "$ref": "4118" + }, + "value": "customWebApi" + }, + "customWebApiParameters": { + "$id": "8143", + "kind": "model", + "type": { + "$ref": "4088" + }, + "value": { + "$id": "8144", + "httpMethod": { + "$id": "8145", + "kind": "string", + "type": { + "$ref": "4100" + }, + "value": "POST" + }, + "uri": { + "$id": "8146", + "kind": "string", + "type": { + "$ref": "4090" + }, + "value": "https://my-custom-endpoint.org/" + }, + "timeout": { + "$id": "8147", + "kind": "string", + "type": { + "$ref": "4104" + }, + "value": "PT1M" + }, + "authResourceId": { + "$id": "8148", + "kind": "string", + "type": { + "$ref": "4109" + }, + "value": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b" + }, + "httpHeaders": { + "$id": "8149", + "kind": "dict", + "type": { + "$ref": "4094" + }, + "value": { + "$id": "8150", + "header1": { + "$id": "8151", + "kind": "string", + "type": { + "$ref": "4096" + }, + "value": "value1" + }, + "header2": { + "$id": "8152", + "kind": "string", + "type": { + "$ref": "4096" + }, + "value": "value2" + } + } + } + } + } + } + }, + { + "$id": "8153", + "kind": "model", + "type": { + "$ref": "4147" + }, + "value": { + "$id": "8154", + "name": { + "$id": "8155", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "aml" + }, + "kind": { + "$id": "8156", + "kind": "string", + "type": { + "$ref": "4177" + }, + "value": "aml" + }, + "amlParameters": { + "$id": "8157", + "kind": "model", + "type": { + "$ref": "4149" + }, + "value": { + "$id": "8158", + "resourceId": { + "$id": "8159", + "kind": "string", + "type": { + "$ref": "4159" + }, + "value": "aml resource id" + }, + "region": { + "$id": "8160", + "kind": "string", + "type": { + "$ref": "4168" + }, + "value": "aml region" + }, + "uri": { + "$id": "8161", + "kind": "string", + "type": { + "$ref": "4151" + }, + "value": "https://my-custom-endpoint.org/" + }, + "timeout": { + "$id": "8162", + "kind": "string", + "type": { + "$ref": "4163" + }, + "value": "PT1M" + }, + "modelName": { + "$id": "8163", + "kind": "string", + "type": { + "$ref": "1143" + }, + "value": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + } + } + } + ] + }, + "compressions": { + "$id": "8164", + "kind": "array", + "type": { + "$ref": "4184" + }, + "value": [ + { + "$id": "8165", + "kind": "model", + "type": { + "$ref": "4221" + }, + "value": { + "$id": "8166", + "name": { + "$id": "8167", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "mySQ8" + }, + "kind": { + "$id": "8168", + "kind": "string", + "type": { + "$ref": "4230" + }, + "value": "scalarQuantization" + }, + "truncationDimension": { + "$id": "8169", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + }, + "scalarQuantizationParameters": { + "$id": "8170", + "kind": "model", + "type": { + "$ref": "4223" + }, + "value": { + "$id": "8171", + "quantizedDataType": { + "$id": "8172", + "kind": "string", + "type": { + "$ref": "1169" + }, + "value": "int8" + } + } + }, + "rescoringOptions": { + "$id": "8173", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "8174", + "enableRescoring": { + "$id": "8175", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "8176", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "8177", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "preserveOriginals" + } + } + } + } + }, + { + "$id": "8178", + "kind": "model", + "type": { + "$ref": "4234" + }, + "value": { + "$id": "8179", + "name": { + "$id": "8180", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "myBQC" + }, + "kind": { + "$id": "8181", + "kind": "string", + "type": { + "$ref": "4236" + }, + "value": "binaryQuantization" + }, + "truncationDimension": { + "$id": "8182", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + }, + "rescoringOptions": { + "$id": "8183", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "8184", + "enableRescoring": { + "$id": "8185", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "8186", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "8187", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "preserveOriginals" + } + } + } + } + }, + { + "$id": "8188", + "kind": "model", + "type": { + "$ref": "4234" + }, + "value": { + "$id": "8189", + "name": { + "$id": "8190", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "myBQWithoutOriginals" + }, + "kind": { + "$id": "8191", + "kind": "string", + "type": { + "$ref": "4236" + }, + "value": "binaryQuantization" + }, + "truncationDimension": { + "$id": "8192", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + }, + "rescoringOptions": { + "$id": "8193", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "8194", + "enableRescoring": { + "$id": "8195", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "8196", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "8197", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "discardOriginals" + } + } + } + } + } + ] + } + } + } + } + } + ] + } + } + } + } + ] + } + ] + }, + { + "$id": "8198", + "name": "createOrUpdate", + "resourceName": "Indexes", + "doc": "Creates a new search index or updates an index if it already exists.", + "accessibility": "public", + "parameters": [ + { + "$id": "8199", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "8200", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "8201", + "type": { + "$id": "8202", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "8203", + "name": "ifMatch", + "nameInRequest": "If-Match", + "doc": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "type": { + "$id": "8204", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "8205", + "name": "ifNoneMatch", + "nameInRequest": "If-None-Match", + "doc": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "type": { + "$id": "8206", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "8207", + "name": "allowIndexDowntime", + "nameInRequest": "allowIndexDowntime", + "doc": "Allows new analyzers, tokenizers, token filters, or char filters to be added to\nan index by taking the index offline for at least a few seconds. This\ntemporarily causes indexing and query requests to fail. Performance and write\navailability of the index can be impaired for several minutes after the index\nis updated, or longer for very large indexes.", + "type": { + "$id": "8208", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "8209", + "name": "prefer", + "nameInRequest": "Prefer", + "doc": "For HTTP PUT requests, instructs the service to return the created/updated resource on success.", + "type": { + "$id": "8210", + "kind": "constant", + "valueType": { + "$id": "8211", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "return=representation", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "8212", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "8213", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "8214", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "8215", + "name": "indexName", + "nameInRequest": "indexName", + "doc": "The name of the index.", + "type": { + "$id": "8216", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "8217", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "8218", + "kind": "constant", + "valueType": { + "$id": "8219", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "8220", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "8221", + "kind": "constant", + "valueType": { + "$id": "8222", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "8223", + "name": "index", + "nameInRequest": "index", + "doc": "The definition of the index to create or update.", + "type": { + "$ref": "2920" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "8224", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "2920" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + }, + { + "$id": "8225", + "statusCodes": [ + 201 + ], + "bodyType": { + "$ref": "2920" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "PUT", + "uri": "{endpoint}", + "path": "/indexes('{indexName}')", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexes.createOrUpdate", + "decorators": [], + "examples": [ + { + "$id": "8226", + "kind": "http", + "name": "SearchServiceCreateOrUpdateIndex", + "description": "SearchServiceCreateOrUpdateIndex", + "filePath": "2025-03-01-preview/SearchServiceCreateOrUpdateIndex.json", + "parameters": [ + { + "$id": "8227", + "parameter": { + "$ref": "8215" + }, + "value": { + "$id": "8228", + "kind": "string", + "type": { + "$ref": "8216" + }, + "value": "temp-preview-test" + } + }, + { + "$id": "8229", + "parameter": { + "$ref": "8199" + }, + "value": { + "$id": "8230", + "kind": "string", + "type": { + "$ref": "8200" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "8231", + "parameter": { + "$ref": "8212" + }, + "value": { + "$id": "8232", + "kind": "string", + "type": { + "$ref": "8213" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "8233", + "parameter": { + "$ref": "8209" + }, + "value": { + "$id": "8234", + "kind": "string", + "type": { + "$ref": "8210" + }, + "value": "return=representation" + } + }, + { + "$id": "8235", + "parameter": { + "$ref": "8223" + }, + "value": { + "$id": "8236", + "kind": "model", + "type": { + "$ref": "2920" + }, + "value": { + "$id": "8237", + "name": { + "$id": "8238", + "kind": "string", + "type": { + "$ref": "2922" + }, + "value": "temp-preview-test" + }, + "fields": { + "$id": "8239", + "kind": "array", + "type": { + "$ref": "2926" + }, + "value": [ + { + "$id": "8240", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8241", + "name": { + "$id": "8242", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "id" + }, + "type": { + "$id": "8243", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "key": { + "$id": "8244", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": true + }, + "sortable": { + "$id": "8245", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + } + } + }, + { + "$id": "8246", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8247", + "name": { + "$id": "8248", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector1" + }, + "type": { + "$id": "8249", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "retrievable": { + "$id": "8250", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "8251", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "dimensions": { + "$id": "8252", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 20 + }, + "vectorSearchProfile": { + "$id": "8253", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config1" + } + } + }, + { + "$id": "8254", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8255", + "name": { + "$id": "8256", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector1b" + }, + "type": { + "$id": "8257", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "retrievable": { + "$id": "8258", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "8259", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "dimensions": { + "$id": "8260", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 10 + }, + "vectorSearchProfile": { + "$id": "8261", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config2" + } + } + }, + { + "$id": "8262", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8263", + "name": { + "$id": "8264", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector2" + }, + "type": { + "$id": "8265", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "retrievable": { + "$id": "8266", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "8267", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "dimensions": { + "$id": "8268", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 5 + }, + "vectorSearchProfile": { + "$id": "8269", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config3" + } + } + }, + { + "$id": "8270", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8271", + "name": { + "$id": "8272", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector3" + }, + "type": { + "$id": "8273", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "retrievable": { + "$id": "8274", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "8275", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "dimensions": { + "$id": "8276", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 5 + }, + "vectorSearchProfile": { + "$id": "8277", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config3" + } + } + }, + { + "$id": "8278", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8279", + "name": { + "$id": "8280", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector22" + }, + "type": { + "$id": "8281", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "retrievable": { + "$id": "8282", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "8283", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "dimensions": { + "$id": "8284", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 10 + }, + "vectorSearchProfile": { + "$id": "8285", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config2" + } + } + }, + { + "$id": "8286", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8287", + "name": { + "$id": "8288", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector4" + }, + "type": { + "$id": "8289", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "retrievable": { + "$id": "8290", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "8291", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "dimensions": { + "$id": "8292", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 32 + }, + "vectorSearchProfile": { + "$id": "8293", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config4" + } + } + }, + { + "$id": "8294", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8295", + "name": { + "$id": "8296", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "name" + }, + "type": { + "$id": "8297", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "retrievable": { + "$id": "8298", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "8299", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8300", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "sortable": { + "$id": "8301", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "8302", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "analyzer": { + "$id": "8303", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + } + } + }, + { + "$id": "8304", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8305", + "name": { + "$id": "8306", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "description" + }, + "type": { + "$id": "8307", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "retrievable": { + "$id": "8308", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "8309", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8310", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "sortable": { + "$id": "8311", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "8312", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "analyzer": { + "$id": "8313", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "standard.lucene" + } + } + }, + { + "$id": "8314", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8315", + "name": { + "$id": "8316", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "category" + }, + "type": { + "$id": "8317", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "retrievable": { + "$id": "8318", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "8319", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8320", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "sortable": { + "$id": "8321", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "8322", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "analyzer": { + "$id": "8323", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + } + } + }, + { + "$id": "8324", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8325", + "name": { + "$id": "8326", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "ownerId" + }, + "type": { + "$id": "8327", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "retrievable": { + "$id": "8328", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "searchable": { + "$id": "8329", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8330", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "sortable": { + "$id": "8331", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "8332", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "analyzer": { + "$id": "8333", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + } + } + }, + { + "$id": "8334", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8335", + "name": { + "$id": "8336", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "price" + }, + "type": { + "$id": "8337", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.Double" + }, + "retrievable": { + "$id": "8338", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "filterable": { + "$id": "8339", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "sortable": { + "$id": "8340", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "8341", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + } + } + } + ] + }, + "scoringProfiles": { + "$id": "8342", + "kind": "array", + "type": { + "$ref": "2998" + }, + "value": [ + { + "$id": "8343", + "kind": "model", + "type": { + "$ref": "2999" + }, + "value": { + "$id": "8344", + "name": { + "$id": "8345", + "kind": "string", + "type": { + "$ref": "3001" + }, + "value": "stringFieldBoost" + }, + "text": { + "$id": "8346", + "kind": "model", + "type": { + "$ref": "3005" + }, + "value": { + "$id": "8347", + "weights": { + "$id": "8348", + "kind": "dict", + "type": { + "$ref": "3007" + }, + "value": { + "$id": "8349", + "name": { + "$id": "8350", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 3 + }, + "description": { + "$id": "8351", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 1 + }, + "category": { + "$id": "8352", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 2 + }, + "ownerId": { + "$id": "8353", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 1 + } + } + } + } + }, + "functions": { + "$id": "8354", + "kind": "array", + "type": { + "$ref": "3015" + }, + "value": [ + { + "$id": "8355", + "kind": "model", + "type": { + "$ref": "3088" + }, + "value": { + "$id": "8356", + "tag": { + "$id": "8357", + "kind": "model", + "type": { + "$ref": "3090" + }, + "value": { + "$id": "8358", + "tagsParameter": { + "$id": "8359", + "kind": "string", + "type": { + "$ref": "3092" + }, + "value": "categoryTag" + } + } + }, + "type": { + "$id": "8360", + "kind": "string", + "type": { + "$ref": "3098" + }, + "value": "tag" + }, + "fieldName": { + "$id": "8361", + "kind": "string", + "type": { + "$ref": "3022" + }, + "value": "category" + }, + "boost": { + "$id": "8362", + "kind": "number", + "type": { + "$ref": "3026" + }, + "value": 2 + } + } + } + ] + } + } + } + ] + }, + "defaultScoringProfile": { + "$id": "8363", + "kind": "string", + "type": { + "$ref": "3110" + }, + "value": "stringFieldBoost" + }, + "corsOptions": { + "$id": "8364", + "kind": "model", + "type": { + "$ref": "3114" + }, + "value": { + "$id": "8365", + "allowedOrigins": { + "$id": "8366", + "kind": "array", + "type": { + "$ref": "3116" + }, + "value": [ + { + "$id": "8367", + "kind": "string", + "type": { + "$ref": "3117" + }, + "value": "https://www.example.com/foo" + } + ] + }, + "maxAgeInSeconds": { + "$id": "8368", + "kind": "number", + "type": { + "$ref": "3121" + }, + "value": 10 + } + } + }, + "suggesters": { + "$id": "8369", + "kind": "array", + "type": { + "$ref": "3127" + }, + "value": [ + { + "$id": "8370", + "kind": "model", + "type": { + "$ref": "3128" + }, + "value": { + "$id": "8371", + "name": { + "$id": "8372", + "kind": "string", + "type": { + "$ref": "3130" + }, + "value": "sg" + }, + "searchMode": { + "$id": "8373", + "kind": "string", + "type": { + "$ref": "3134" + }, + "value": "analyzingInfixMatching" + }, + "sourceFields": { + "$id": "8374", + "kind": "array", + "type": { + "$ref": "3138" + }, + "value": [ + { + "$id": "8375", + "kind": "string", + "type": { + "$ref": "3139" + }, + "value": "category" + }, + { + "$id": "8376", + "kind": "string", + "type": { + "$ref": "3139" + }, + "value": "ownerId" + } + ] + } + } + } + ] + }, + "analyzers": { + "$id": "8377", + "kind": "array", + "type": { + "$ref": "3145" + }, + "value": [] + }, + "tokenizers": { + "$id": "8378", + "kind": "array", + "type": { + "$ref": "3224" + }, + "value": [] + }, + "tokenFilters": { + "$id": "8379", + "kind": "array", + "type": { + "$ref": "3391" + }, + "value": [] + }, + "charFilters": { + "$id": "8380", + "kind": "array", + "type": { + "$ref": "3784" + }, + "value": [] + }, + "normalizers": { + "$id": "8381", + "kind": "array", + "type": { + "$ref": "3823" + }, + "value": [] + }, + "semantic": { + "$id": "8382", + "kind": "model", + "type": { + "$ref": "3933" + }, + "value": { + "$id": "8383", + "defaultConfiguration": { + "$id": "8384", + "kind": "string", + "type": { + "$ref": "3935" + }, + "value": "testconfig" + }, + "configurations": { + "$id": "8385", + "kind": "array", + "type": { + "$ref": "3939" + }, + "value": [ + { + "$id": "8386", + "kind": "model", + "type": { + "$ref": "3940" + }, + "value": { + "$id": "8387", + "name": { + "$id": "8388", + "kind": "string", + "type": { + "$ref": "3942" + }, + "value": "testconfig" + }, + "prioritizedFields": { + "$id": "8389", + "kind": "model", + "type": { + "$ref": "3946" + }, + "value": { + "$id": "8390", + "titleField": { + "$id": "8391", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "8392", + "fieldName": { + "$id": "8393", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "category" + } + } + }, + "prioritizedContentFields": { + "$id": "8394", + "kind": "array", + "type": { + "$ref": "3956" + }, + "value": [ + { + "$id": "8395", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "8396", + "fieldName": { + "$id": "8397", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "description" + } + } + } + ] + }, + "prioritizedKeywordsFields": { + "$id": "8398", + "kind": "array", + "type": { + "$ref": "3960" + }, + "value": [ + { + "$id": "8399", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "8400", + "fieldName": { + "$id": "8401", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "ownerId" + } + } + } + ] + } + } + }, + "flightingOptIn": { + "$id": "8402", + "kind": "boolean", + "type": { + "$ref": "3966" + }, + "value": true + } + } + } + ] + } + } + }, + "vectorSearch": { + "$id": "8403", + "kind": "model", + "type": { + "$ref": "3974" + }, + "value": { + "$id": "8404", + "profiles": { + "$id": "8405", + "kind": "array", + "type": { + "$ref": "3976" + }, + "value": [ + { + "$id": "8406", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "8407", + "name": { + "$id": "8408", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config1" + }, + "algorithm": { + "$id": "8409", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "cosine" + }, + "vectorizer": { + "$id": "8410", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "openai" + }, + "compression": { + "$id": "8411", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "mySQ8" + } + } + }, + { + "$id": "8412", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "8413", + "name": { + "$id": "8414", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config2" + }, + "algorithm": { + "$id": "8415", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "euclidean" + }, + "vectorizer": { + "$id": "8416", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "8417", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "mySQ8" + } + } + }, + { + "$id": "8418", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "8419", + "name": { + "$id": "8420", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config3" + }, + "algorithm": { + "$id": "8421", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "dotProduct" + }, + "vectorizer": { + "$id": "8422", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "8423", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "myBQC" + } + } + }, + { + "$id": "8424", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "8425", + "name": { + "$id": "8426", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config4" + }, + "algorithm": { + "$id": "8427", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "dotProduct" + }, + "vectorizer": { + "$id": "8428", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "8429", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "myBQWithoutOriginals" + } + } + } + ] + }, + "algorithms": { + "$id": "8430", + "kind": "array", + "type": { + "$ref": "3997" + }, + "value": [ + { + "$id": "8431", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "8432", + "hnswParameters": { + "$id": "8433", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "8434", + "metric": { + "$id": "8435", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "cosine" + } + } + }, + "name": { + "$id": "8436", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "cosine" + }, + "kind": { + "$id": "8437", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + } + } + }, + { + "$id": "8438", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "8439", + "hnswParameters": { + "$id": "8440", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "8441", + "metric": { + "$id": "8442", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "euclidean" + } + } + }, + "name": { + "$id": "8443", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "euclidean" + }, + "kind": { + "$id": "8444", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + } + } + }, + { + "$id": "8445", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "8446", + "hnswParameters": { + "$id": "8447", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "8448", + "metric": { + "$id": "8449", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "dotProduct" + } + } + }, + "name": { + "$id": "8450", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "dotProduct" + }, + "kind": { + "$id": "8451", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + } + } + } + ] + }, + "vectorizers": { + "$id": "8452", + "kind": "array", + "type": { + "$ref": "4048" + }, + "value": [ + { + "$id": "8453", + "kind": "model", + "type": { + "$ref": "4058" + }, + "value": { + "$id": "8454", + "azureOpenAIParameters": { + "$id": "8455", + "kind": "model", + "type": { + "$ref": "4060" + }, + "value": { + "$id": "8456", + "resourceUri": { + "$id": "8457", + "kind": "string", + "type": { + "$ref": "4062" + }, + "value": "https://test-sample.openai.azure.com/" + }, + "deploymentId": { + "$id": "8458", + "kind": "string", + "type": { + "$ref": "4066" + }, + "value": "model" + }, + "apiKey": { + "$id": "8459", + "kind": "string", + "type": { + "$ref": "4070" + }, + "value": "api-key" + }, + "modelName": { + "$id": "8460", + "kind": "string", + "type": { + "$ref": "1135" + }, + "value": "text-embedding-3-large" + } + } + }, + "name": { + "$id": "8461", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "openai" + }, + "kind": { + "$id": "8462", + "kind": "string", + "type": { + "$ref": "4082" + }, + "value": "azureOpenAI" + } + } + }, + { + "$id": "8463", + "kind": "model", + "type": { + "$ref": "4086" + }, + "value": { + "$id": "8464", + "customWebApiParameters": { + "$id": "8465", + "kind": "model", + "type": { + "$ref": "4088" + }, + "value": { + "$id": "8466", + "uri": { + "$id": "8467", + "kind": "string", + "type": { + "$ref": "4090" + }, + "value": "https://my-custom-endpoint.org/" + }, + "httpHeaders": { + "$id": "8468", + "kind": "dict", + "type": { + "$ref": "4094" + }, + "value": { + "$id": "8469", + "header1": { + "$id": "8470", + "kind": "string", + "type": { + "$ref": "4096" + }, + "value": "value1" + }, + "header2": { + "$id": "8471", + "kind": "string", + "type": { + "$ref": "4096" + }, + "value": "value2" + } + } + }, + "httpMethod": { + "$id": "8472", + "kind": "string", + "type": { + "$ref": "4100" + }, + "value": "POST" + }, + "timeout": { + "$id": "8473", + "kind": "string", + "type": { + "$ref": "4104" + }, + "value": "PT1M" + }, + "authResourceId": { + "$id": "8474", + "kind": "string", + "type": { + "$ref": "4109" + }, + "value": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b" + } + } + }, + "name": { + "$id": "8475", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "custom-web-api" + }, + "kind": { + "$id": "8476", + "kind": "string", + "type": { + "$ref": "4118" + }, + "value": "customWebApi" + } + } + }, + { + "$id": "8477", + "kind": "model", + "type": { + "$ref": "4147" + }, + "value": { + "$id": "8478", + "amlParameters": { + "$id": "8479", + "kind": "model", + "type": { + "$ref": "4149" + }, + "value": { + "$id": "8480", + "uri": { + "$id": "8481", + "kind": "string", + "type": { + "$ref": "4151" + }, + "value": "https://my-custom-endpoint.org/" + }, + "resourceId": { + "$id": "8482", + "kind": "string", + "type": { + "$ref": "4159" + }, + "value": "aml resource id" + }, + "timeout": { + "$id": "8483", + "kind": "string", + "type": { + "$ref": "4163" + }, + "value": "PT1M" + }, + "region": { + "$id": "8484", + "kind": "string", + "type": { + "$ref": "4168" + }, + "value": "aml region" + }, + "modelName": { + "$id": "8485", + "kind": "string", + "type": { + "$ref": "1143" + }, + "value": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + }, + "name": { + "$id": "8486", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "aml" + }, + "kind": { + "$id": "8487", + "kind": "string", + "type": { + "$ref": "4177" + }, + "value": "aml" + } + } + } + ] + }, + "compressions": { + "$id": "8488", + "kind": "array", + "type": { + "$ref": "4184" + }, + "value": [ + { + "$id": "8489", + "kind": "model", + "type": { + "$ref": "4221" + }, + "value": { + "$id": "8490", + "scalarQuantizationParameters": { + "$id": "8491", + "kind": "model", + "type": { + "$ref": "4223" + }, + "value": { + "$id": "8492", + "quantizedDataType": { + "$id": "8493", + "kind": "string", + "type": { + "$ref": "1169" + }, + "value": "int8" + } + } + }, + "name": { + "$id": "8494", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "mySQ8" + }, + "kind": { + "$id": "8495", + "kind": "string", + "type": { + "$ref": "4230" + }, + "value": "scalarQuantization" + }, + "rescoringOptions": { + "$id": "8496", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "8497", + "enableRescoring": { + "$id": "8498", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "8499", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "8500", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "preserveOriginals" + } + } + }, + "truncationDimension": { + "$id": "8501", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + } + } + }, + { + "$id": "8502", + "kind": "model", + "type": { + "$ref": "4234" + }, + "value": { + "$id": "8503", + "name": { + "$id": "8504", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "myBQC" + }, + "kind": { + "$id": "8505", + "kind": "string", + "type": { + "$ref": "4236" + }, + "value": "binaryQuantization" + }, + "rescoringOptions": { + "$id": "8506", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "8507", + "enableRescoring": { + "$id": "8508", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "8509", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "8510", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "preserveOriginals" + } + } + }, + "truncationDimension": { + "$id": "8511", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + } + } + }, + { + "$id": "8512", + "kind": "model", + "type": { + "$ref": "4234" + }, + "value": { + "$id": "8513", + "name": { + "$id": "8514", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "myBQWithoutOriginals" + }, + "kind": { + "$id": "8515", + "kind": "string", + "type": { + "$ref": "4236" + }, + "value": "binaryQuantization" + }, + "rescoringOptions": { + "$id": "8516", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "8517", + "enableRescoring": { + "$id": "8518", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "8519", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "8520", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "discardOriginals" + } + } + }, + "truncationDimension": { + "$id": "8521", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + } + } + } + ] + } + } + }, + "@odata.etag": { + "$id": "8522", + "kind": "string", + "type": { + "$ref": "4245" + }, + "value": "0x1234568AE7E58A1" + } + } + } + } + ], + "responses": [ + { + "$id": "8523", + "response": { + "$ref": "8224" + }, + "statusCode": 200, + "bodyValue": { + "$id": "8524", + "kind": "model", + "type": { + "$ref": "2920" + }, + "value": { + "$id": "8525", + "name": { + "$id": "8526", + "kind": "string", + "type": { + "$ref": "2922" + }, + "value": "temp-preview-test" + }, + "defaultScoringProfile": { + "$id": "8527", + "kind": "string", + "type": { + "$ref": "3110" + }, + "value": "stringFieldBoost" + }, + "fields": { + "$id": "8528", + "kind": "array", + "type": { + "$ref": "2926" + }, + "value": [ + { + "$id": "8529", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8530", + "name": { + "$id": "8531", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "id" + }, + "type": { + "$id": "8532", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "8533", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8534", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "8535", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8536", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8537", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "8538", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "8539", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": true + }, + "synonymMaps": { + "$id": "8540", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8541", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8542", + "name": { + "$id": "8543", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector1" + }, + "type": { + "$id": "8544", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "8545", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8546", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "8547", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8548", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8549", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "8550", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "8551", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "8552", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 20 + }, + "vectorSearchProfile": { + "$id": "8553", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config1" + }, + "synonymMaps": { + "$id": "8554", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8555", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8556", + "name": { + "$id": "8557", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector1b" + }, + "type": { + "$id": "8558", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "8559", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8560", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "8561", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8562", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8563", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "8564", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "8565", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "8566", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 10 + }, + "vectorSearchProfile": { + "$id": "8567", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config2" + }, + "synonymMaps": { + "$id": "8568", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8569", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8570", + "name": { + "$id": "8571", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector2" + }, + "type": { + "$id": "8572", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "8573", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8574", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "8575", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8576", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8577", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "8578", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "8579", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "8580", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 5 + }, + "vectorSearchProfile": { + "$id": "8581", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config3" + }, + "synonymMaps": { + "$id": "8582", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8583", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8584", + "name": { + "$id": "8585", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector3" + }, + "type": { + "$id": "8586", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "8587", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8588", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "8589", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8590", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8591", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "8592", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "8593", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "8594", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 5 + }, + "vectorSearchProfile": { + "$id": "8595", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config3" + }, + "synonymMaps": { + "$id": "8596", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8597", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8598", + "name": { + "$id": "8599", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector22" + }, + "type": { + "$id": "8600", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "8601", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8602", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "8603", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8604", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8605", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "8606", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "8607", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "8608", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 10 + }, + "vectorSearchProfile": { + "$id": "8609", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config2" + }, + "synonymMaps": { + "$id": "8610", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8611", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8612", + "name": { + "$id": "8613", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector4" + }, + "type": { + "$id": "8614", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "8615", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8616", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "8617", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8618", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8619", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "8620", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "8621", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "8622", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 32 + }, + "vectorSearchProfile": { + "$id": "8623", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config4" + }, + "synonymMaps": { + "$id": "8624", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8625", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8626", + "name": { + "$id": "8627", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "name" + }, + "type": { + "$id": "8628", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "8629", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8630", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "8631", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8632", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8633", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "8634", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "8635", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "8636", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + }, + "synonymMaps": { + "$id": "8637", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8638", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8639", + "name": { + "$id": "8640", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "description" + }, + "type": { + "$id": "8641", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "8642", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8643", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "8644", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8645", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8646", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "8647", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "8648", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "8649", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "standard.lucene" + }, + "synonymMaps": { + "$id": "8650", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8651", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8652", + "name": { + "$id": "8653", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "category" + }, + "type": { + "$id": "8654", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "8655", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8656", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "8657", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8658", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8659", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "8660", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "8661", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "8662", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + }, + "synonymMaps": { + "$id": "8663", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8664", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8665", + "name": { + "$id": "8666", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "ownerId" + }, + "type": { + "$id": "8667", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "8668", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8669", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "8670", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8671", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8672", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "8673", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "8674", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "8675", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + }, + "synonymMaps": { + "$id": "8676", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8677", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8678", + "name": { + "$id": "8679", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "price" + }, + "type": { + "$id": "8680", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.Double" + }, + "searchable": { + "$id": "8681", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": false + }, + "filterable": { + "$id": "8682", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "8683", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8684", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8685", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "8686", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "8687", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "synonymMaps": { + "$id": "8688", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + } + ] + }, + "scoringProfiles": { + "$id": "8689", + "kind": "array", + "type": { + "$ref": "2998" + }, + "value": [ + { + "$id": "8690", + "kind": "model", + "type": { + "$ref": "2999" + }, + "value": { + "$id": "8691", + "name": { + "$id": "8692", + "kind": "string", + "type": { + "$ref": "3001" + }, + "value": "stringFieldBoost" + }, + "functionAggregation": { + "$id": "8693", + "kind": "string", + "type": { + "$ref": "524" + }, + "value": "sum" + }, + "text": { + "$id": "8694", + "kind": "model", + "type": { + "$ref": "3005" + }, + "value": { + "$id": "8695", + "weights": { + "$id": "8696", + "kind": "dict", + "type": { + "$ref": "3007" + }, + "value": { + "$id": "8697", + "name": { + "$id": "8698", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 3 + }, + "description": { + "$id": "8699", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 1 + }, + "category": { + "$id": "8700", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 2 + }, + "ownerId": { + "$id": "8701", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 1 + } + } + } + } + }, + "functions": { + "$id": "8702", + "kind": "array", + "type": { + "$ref": "3015" + }, + "value": [ + { + "$id": "8703", + "kind": "model", + "type": { + "$ref": "3088" + }, + "value": { + "$id": "8704", + "fieldName": { + "$id": "8705", + "kind": "string", + "type": { + "$ref": "3022" + }, + "value": "category" + }, + "interpolation": { + "$id": "8706", + "kind": "string", + "type": { + "$ref": "514" + }, + "value": "linear" + }, + "type": { + "$id": "8707", + "kind": "string", + "type": { + "$ref": "3098" + }, + "value": "tag" + }, + "boost": { + "$id": "8708", + "kind": "number", + "type": { + "$ref": "3026" + }, + "value": 2 + }, + "tag": { + "$id": "8709", + "kind": "model", + "type": { + "$ref": "3090" + }, + "value": { + "$id": "8710", + "tagsParameter": { + "$id": "8711", + "kind": "string", + "type": { + "$ref": "3092" + }, + "value": "categoryTag" + } + } + } + } + } + ] + } + } + } + ] + }, + "corsOptions": { + "$id": "8712", + "kind": "model", + "type": { + "$ref": "3114" + }, + "value": { + "$id": "8713", + "allowedOrigins": { + "$id": "8714", + "kind": "array", + "type": { + "$ref": "3116" + }, + "value": [ + { + "$id": "8715", + "kind": "string", + "type": { + "$ref": "3117" + }, + "value": "https://www.example.com/foo" + } + ] + }, + "maxAgeInSeconds": { + "$id": "8716", + "kind": "number", + "type": { + "$ref": "3121" + }, + "value": 10 + } + } + }, + "suggesters": { + "$id": "8717", + "kind": "array", + "type": { + "$ref": "3127" + }, + "value": [ + { + "$id": "8718", + "kind": "model", + "type": { + "$ref": "3128" + }, + "value": { + "$id": "8719", + "name": { + "$id": "8720", + "kind": "string", + "type": { + "$ref": "3130" + }, + "value": "sg" + }, + "searchMode": { + "$id": "8721", + "kind": "string", + "type": { + "$ref": "3134" + }, + "value": "analyzingInfixMatching" + }, + "sourceFields": { + "$id": "8722", + "kind": "array", + "type": { + "$ref": "3138" + }, + "value": [ + { + "$id": "8723", + "kind": "string", + "type": { + "$ref": "3139" + }, + "value": "category" + }, + { + "$id": "8724", + "kind": "string", + "type": { + "$ref": "3139" + }, + "value": "ownerId" + } + ] + } + } + } + ] + }, + "analyzers": { + "$id": "8725", + "kind": "array", + "type": { + "$ref": "3145" + }, + "value": [] + }, + "normalizers": { + "$id": "8726", + "kind": "array", + "type": { + "$ref": "3823" + }, + "value": [] + }, + "tokenizers": { + "$id": "8727", + "kind": "array", + "type": { + "$ref": "3224" + }, + "value": [] + }, + "tokenFilters": { + "$id": "8728", + "kind": "array", + "type": { + "$ref": "3391" + }, + "value": [] + }, + "charFilters": { + "$id": "8729", + "kind": "array", + "type": { + "$ref": "3784" + }, + "value": [] + }, + "semantic": { + "$id": "8730", + "kind": "model", + "type": { + "$ref": "3933" + }, + "value": { + "$id": "8731", + "defaultConfiguration": { + "$id": "8732", + "kind": "string", + "type": { + "$ref": "3935" + }, + "value": "testconfig" + }, + "configurations": { + "$id": "8733", + "kind": "array", + "type": { + "$ref": "3939" + }, + "value": [ + { + "$id": "8734", + "kind": "model", + "type": { + "$ref": "3940" + }, + "value": { + "$id": "8735", + "name": { + "$id": "8736", + "kind": "string", + "type": { + "$ref": "3942" + }, + "value": "testconfig" + }, + "flightingOptIn": { + "$id": "8737", + "kind": "boolean", + "type": { + "$ref": "3966" + }, + "value": false + }, + "prioritizedFields": { + "$id": "8738", + "kind": "model", + "type": { + "$ref": "3946" + }, + "value": { + "$id": "8739", + "titleField": { + "$id": "8740", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "8741", + "fieldName": { + "$id": "8742", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "category" + } + } + }, + "prioritizedContentFields": { + "$id": "8743", + "kind": "array", + "type": { + "$ref": "3956" + }, + "value": [ + { + "$id": "8744", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "8745", + "fieldName": { + "$id": "8746", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "description" + } + } + } + ] + }, + "prioritizedKeywordsFields": { + "$id": "8747", + "kind": "array", + "type": { + "$ref": "3960" + }, + "value": [ + { + "$id": "8748", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "8749", + "fieldName": { + "$id": "8750", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "ownerId" + } + } + } + ] + } + } + } + } + } + ] + } + } + }, + "vectorSearch": { + "$id": "8751", + "kind": "model", + "type": { + "$ref": "3974" + }, + "value": { + "$id": "8752", + "algorithms": { + "$id": "8753", + "kind": "array", + "type": { + "$ref": "3997" + }, + "value": [ + { + "$id": "8754", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "8755", + "name": { + "$id": "8756", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "cosine" + }, + "kind": { + "$id": "8757", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + }, + "hnswParameters": { + "$id": "8758", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "8759", + "metric": { + "$id": "8760", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "cosine" + }, + "m": { + "$id": "8761", + "kind": "number", + "type": { + "$ref": "4011" + }, + "value": 4 + }, + "efConstruction": { + "$id": "8762", + "kind": "number", + "type": { + "$ref": "4015" + }, + "value": 400 + }, + "efSearch": { + "$id": "8763", + "kind": "number", + "type": { + "$ref": "4019" + }, + "value": 500 + } + } + } + } + }, + { + "$id": "8764", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "8765", + "name": { + "$id": "8766", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "euclidean" + }, + "kind": { + "$id": "8767", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + }, + "hnswParameters": { + "$id": "8768", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "8769", + "metric": { + "$id": "8770", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "euclidean" + }, + "m": { + "$id": "8771", + "kind": "number", + "type": { + "$ref": "4011" + }, + "value": 4 + }, + "efConstruction": { + "$id": "8772", + "kind": "number", + "type": { + "$ref": "4015" + }, + "value": 400 + }, + "efSearch": { + "$id": "8773", + "kind": "number", + "type": { + "$ref": "4019" + }, + "value": 500 + } + } + } + } + }, + { + "$id": "8774", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "8775", + "name": { + "$id": "8776", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "dotProduct" + }, + "kind": { + "$id": "8777", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + }, + "hnswParameters": { + "$id": "8778", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "8779", + "metric": { + "$id": "8780", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "dotProduct" + }, + "m": { + "$id": "8781", + "kind": "number", + "type": { + "$ref": "4011" + }, + "value": 4 + }, + "efConstruction": { + "$id": "8782", + "kind": "number", + "type": { + "$ref": "4015" + }, + "value": 400 + }, + "efSearch": { + "$id": "8783", + "kind": "number", + "type": { + "$ref": "4019" + }, + "value": 500 + } + } + } + } + } + ] + }, + "profiles": { + "$id": "8784", + "kind": "array", + "type": { + "$ref": "3976" + }, + "value": [ + { + "$id": "8785", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "8786", + "name": { + "$id": "8787", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config1" + }, + "algorithm": { + "$id": "8788", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "cosine" + }, + "vectorizer": { + "$id": "8789", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "openai" + }, + "compression": { + "$id": "8790", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "mySQ8" + } + } + }, + { + "$id": "8791", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "8792", + "name": { + "$id": "8793", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config2" + }, + "algorithm": { + "$id": "8794", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "euclidean" + }, + "vectorizer": { + "$id": "8795", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "8796", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "mySQ8" + } + } + }, + { + "$id": "8797", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "8798", + "name": { + "$id": "8799", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config3" + }, + "algorithm": { + "$id": "8800", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "dotProduct" + }, + "vectorizer": { + "$id": "8801", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "8802", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "myBQC" + } + } + }, + { + "$id": "8803", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "8804", + "name": { + "$id": "8805", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config4" + }, + "algorithm": { + "$id": "8806", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "dotProduct" + }, + "vectorizer": { + "$id": "8807", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "8808", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "myBQWithoutOriginals" + } + } + } + ] + }, + "vectorizers": { + "$id": "8809", + "kind": "array", + "type": { + "$ref": "4048" + }, + "value": [ + { + "$id": "8810", + "kind": "model", + "type": { + "$ref": "4058" + }, + "value": { + "$id": "8811", + "name": { + "$id": "8812", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "openai" + }, + "kind": { + "$id": "8813", + "kind": "string", + "type": { + "$ref": "4082" + }, + "value": "azureOpenAI" + }, + "azureOpenAIParameters": { + "$id": "8814", + "kind": "model", + "type": { + "$ref": "4060" + }, + "value": { + "$id": "8815", + "resourceUri": { + "$id": "8816", + "kind": "string", + "type": { + "$ref": "4062" + }, + "value": "https://test-sample.openai.azure.com" + }, + "deploymentId": { + "$id": "8817", + "kind": "string", + "type": { + "$ref": "4066" + }, + "value": "model" + }, + "apiKey": { + "$id": "8818", + "kind": "string", + "type": { + "$ref": "4070" + }, + "value": "api-key" + }, + "modelName": { + "$id": "8819", + "kind": "string", + "type": { + "$ref": "1135" + }, + "value": "text-embedding-3-large" + } + } + } + } + }, + { + "$id": "8820", + "kind": "model", + "type": { + "$ref": "4086" + }, + "value": { + "$id": "8821", + "name": { + "$id": "8822", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "custom-web-api" + }, + "kind": { + "$id": "8823", + "kind": "string", + "type": { + "$ref": "4118" + }, + "value": "customWebApi" + }, + "customWebApiParameters": { + "$id": "8824", + "kind": "model", + "type": { + "$ref": "4088" + }, + "value": { + "$id": "8825", + "httpMethod": { + "$id": "8826", + "kind": "string", + "type": { + "$ref": "4100" + }, + "value": "POST" + }, + "uri": { + "$id": "8827", + "kind": "string", + "type": { + "$ref": "4090" + }, + "value": "https://my-custom-endpoint.org/" + }, + "timeout": { + "$id": "8828", + "kind": "string", + "type": { + "$ref": "4104" + }, + "value": "PT1M" + }, + "authResourceId": { + "$id": "8829", + "kind": "string", + "type": { + "$ref": "4109" + }, + "value": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b" + }, + "httpHeaders": { + "$id": "8830", + "kind": "dict", + "type": { + "$ref": "4094" + }, + "value": { + "$id": "8831", + "header1": { + "$id": "8832", + "kind": "string", + "type": { + "$ref": "4096" + }, + "value": "value1" + }, + "header2": { + "$id": "8833", + "kind": "string", + "type": { + "$ref": "4096" + }, + "value": "value2" + } + } + } + } + } + } + }, + { + "$id": "8834", + "kind": "model", + "type": { + "$ref": "4147" + }, + "value": { + "$id": "8835", + "name": { + "$id": "8836", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "aml" + }, + "kind": { + "$id": "8837", + "kind": "string", + "type": { + "$ref": "4177" + }, + "value": "aml" + }, + "amlParameters": { + "$id": "8838", + "kind": "model", + "type": { + "$ref": "4149" + }, + "value": { + "$id": "8839", + "resourceId": { + "$id": "8840", + "kind": "string", + "type": { + "$ref": "4159" + }, + "value": "aml resource id" + }, + "region": { + "$id": "8841", + "kind": "string", + "type": { + "$ref": "4168" + }, + "value": "aml region" + }, + "uri": { + "$id": "8842", + "kind": "string", + "type": { + "$ref": "4151" + }, + "value": "https://my-custom-endpoint.org/" + }, + "timeout": { + "$id": "8843", + "kind": "string", + "type": { + "$ref": "4163" + }, + "value": "PT1M" + }, + "modelName": { + "$id": "8844", + "kind": "string", + "type": { + "$ref": "1143" + }, + "value": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + } + } + } + ] + }, + "compressions": { + "$id": "8845", + "kind": "array", + "type": { + "$ref": "4184" + }, + "value": [ + { + "$id": "8846", + "kind": "model", + "type": { + "$ref": "4221" + }, + "value": { + "$id": "8847", + "name": { + "$id": "8848", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "mySQ8" + }, + "kind": { + "$id": "8849", + "kind": "string", + "type": { + "$ref": "4230" + }, + "value": "scalarQuantization" + }, + "truncationDimension": { + "$id": "8850", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + }, + "scalarQuantizationParameters": { + "$id": "8851", + "kind": "model", + "type": { + "$ref": "4223" + }, + "value": { + "$id": "8852", + "quantizedDataType": { + "$id": "8853", + "kind": "string", + "type": { + "$ref": "1169" + }, + "value": "int8" + } + } + }, + "rescoringOptions": { + "$id": "8854", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "8855", + "enableRescoring": { + "$id": "8856", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "8857", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "8858", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "preserveOriginals" + } + } + } + } + }, + { + "$id": "8859", + "kind": "model", + "type": { + "$ref": "4234" + }, + "value": { + "$id": "8860", + "name": { + "$id": "8861", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "myBQC" + }, + "kind": { + "$id": "8862", + "kind": "string", + "type": { + "$ref": "4236" + }, + "value": "binaryQuantization" + }, + "truncationDimension": { + "$id": "8863", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + }, + "rescoringOptions": { + "$id": "8864", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "8865", + "enableRescoring": { + "$id": "8866", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "8867", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "8868", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "preserveOriginals" + } + } + } + } + }, + { + "$id": "8869", + "kind": "model", + "type": { + "$ref": "4234" + }, + "value": { + "$id": "8870", + "name": { + "$id": "8871", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "myBQWithoutOriginals" + }, + "kind": { + "$id": "8872", + "kind": "string", + "type": { + "$ref": "4236" + }, + "value": "binaryQuantization" + }, + "truncationDimension": { + "$id": "8873", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + }, + "rescoringOptions": { + "$id": "8874", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "8875", + "enableRescoring": { + "$id": "8876", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "8877", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "8878", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "discardOriginals" + } + } + } + } + } + ] + } + } + } + } + } + }, + { + "$id": "8879", + "response": { + "$ref": "8225" + }, + "statusCode": 201, + "bodyValue": { + "$id": "8880", + "kind": "model", + "type": { + "$ref": "2920" + }, + "value": { + "$id": "8881", + "name": { + "$id": "8882", + "kind": "string", + "type": { + "$ref": "2922" + }, + "value": "temp-preview-test" + }, + "defaultScoringProfile": { + "$id": "8883", + "kind": "string", + "type": { + "$ref": "3110" + }, + "value": "stringFieldBoost" + }, + "fields": { + "$id": "8884", + "kind": "array", + "type": { + "$ref": "2926" + }, + "value": [ + { + "$id": "8885", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8886", + "name": { + "$id": "8887", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "id" + }, + "type": { + "$id": "8888", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "8889", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8890", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "8891", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8892", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8893", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "8894", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "8895", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": true + }, + "synonymMaps": { + "$id": "8896", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8897", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8898", + "name": { + "$id": "8899", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector1" + }, + "type": { + "$id": "8900", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "8901", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8902", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "8903", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8904", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8905", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "8906", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "8907", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "8908", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 20 + }, + "vectorSearchProfile": { + "$id": "8909", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config1" + }, + "synonymMaps": { + "$id": "8910", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8911", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8912", + "name": { + "$id": "8913", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector1b" + }, + "type": { + "$id": "8914", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "8915", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8916", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "8917", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8918", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8919", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "8920", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "8921", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "8922", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 10 + }, + "vectorSearchProfile": { + "$id": "8923", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config2" + }, + "synonymMaps": { + "$id": "8924", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8925", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8926", + "name": { + "$id": "8927", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector2" + }, + "type": { + "$id": "8928", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "8929", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8930", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "8931", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8932", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8933", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "8934", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "8935", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "8936", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 5 + }, + "vectorSearchProfile": { + "$id": "8937", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config3" + }, + "synonymMaps": { + "$id": "8938", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8939", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8940", + "name": { + "$id": "8941", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector3" + }, + "type": { + "$id": "8942", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "8943", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8944", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "8945", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8946", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8947", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "8948", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "8949", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "8950", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 5 + }, + "vectorSearchProfile": { + "$id": "8951", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config3" + }, + "synonymMaps": { + "$id": "8952", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8953", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8954", + "name": { + "$id": "8955", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector22" + }, + "type": { + "$id": "8956", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "8957", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8958", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "8959", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8960", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8961", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "8962", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "8963", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "8964", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 10 + }, + "vectorSearchProfile": { + "$id": "8965", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config2" + }, + "synonymMaps": { + "$id": "8966", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8967", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8968", + "name": { + "$id": "8969", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector4" + }, + "type": { + "$id": "8970", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "8971", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8972", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "8973", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8974", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8975", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "8976", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "8977", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "8978", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 32 + }, + "vectorSearchProfile": { + "$id": "8979", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config4" + }, + "synonymMaps": { + "$id": "8980", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8981", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8982", + "name": { + "$id": "8983", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "name" + }, + "type": { + "$id": "8984", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "8985", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8986", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "8987", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "8988", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "8989", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "8990", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "8991", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "8992", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + }, + "synonymMaps": { + "$id": "8993", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "8994", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "8995", + "name": { + "$id": "8996", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "description" + }, + "type": { + "$id": "8997", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "8998", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "8999", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "9000", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9001", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9002", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "9003", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "9004", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "9005", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "standard.lucene" + }, + "synonymMaps": { + "$id": "9006", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "9007", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "9008", + "name": { + "$id": "9009", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "category" + }, + "type": { + "$id": "9010", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "9011", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "9012", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "9013", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9014", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9015", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "9016", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "9017", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "9018", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + }, + "synonymMaps": { + "$id": "9019", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "9020", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "9021", + "name": { + "$id": "9022", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "ownerId" + }, + "type": { + "$id": "9023", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "9024", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "9025", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "9026", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9027", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9028", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "9029", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "9030", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "9031", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + }, + "synonymMaps": { + "$id": "9032", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "9033", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "9034", + "name": { + "$id": "9035", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "price" + }, + "type": { + "$id": "9036", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.Double" + }, + "searchable": { + "$id": "9037", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": false + }, + "filterable": { + "$id": "9038", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "9039", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9040", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9041", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "9042", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "9043", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "synonymMaps": { + "$id": "9044", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + } + ] + }, + "scoringProfiles": { + "$id": "9045", + "kind": "array", + "type": { + "$ref": "2998" + }, + "value": [ + { + "$id": "9046", + "kind": "model", + "type": { + "$ref": "2999" + }, + "value": { + "$id": "9047", + "name": { + "$id": "9048", + "kind": "string", + "type": { + "$ref": "3001" + }, + "value": "stringFieldBoost" + }, + "functionAggregation": { + "$id": "9049", + "kind": "string", + "type": { + "$ref": "524" + }, + "value": "sum" + }, + "text": { + "$id": "9050", + "kind": "model", + "type": { + "$ref": "3005" + }, + "value": { + "$id": "9051", + "weights": { + "$id": "9052", + "kind": "dict", + "type": { + "$ref": "3007" + }, + "value": { + "$id": "9053", + "name": { + "$id": "9054", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 3 + }, + "description": { + "$id": "9055", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 1 + }, + "category": { + "$id": "9056", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 2 + }, + "ownerId": { + "$id": "9057", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 1 + } + } + } + } + }, + "functions": { + "$id": "9058", + "kind": "array", + "type": { + "$ref": "3015" + }, + "value": [ + { + "$id": "9059", + "kind": "model", + "type": { + "$ref": "3088" + }, + "value": { + "$id": "9060", + "fieldName": { + "$id": "9061", + "kind": "string", + "type": { + "$ref": "3022" + }, + "value": "category" + }, + "interpolation": { + "$id": "9062", + "kind": "string", + "type": { + "$ref": "514" + }, + "value": "linear" + }, + "type": { + "$id": "9063", + "kind": "string", + "type": { + "$ref": "3098" + }, + "value": "tag" + }, + "boost": { + "$id": "9064", + "kind": "number", + "type": { + "$ref": "3026" + }, + "value": 2 + }, + "tag": { + "$id": "9065", + "kind": "model", + "type": { + "$ref": "3090" + }, + "value": { + "$id": "9066", + "tagsParameter": { + "$id": "9067", + "kind": "string", + "type": { + "$ref": "3092" + }, + "value": "categoryTag" + } + } + } + } + } + ] + } + } + } + ] + }, + "corsOptions": { + "$id": "9068", + "kind": "model", + "type": { + "$ref": "3114" + }, + "value": { + "$id": "9069", + "allowedOrigins": { + "$id": "9070", + "kind": "array", + "type": { + "$ref": "3116" + }, + "value": [ + { + "$id": "9071", + "kind": "string", + "type": { + "$ref": "3117" + }, + "value": "https://www.example.com/foo" + } + ] + }, + "maxAgeInSeconds": { + "$id": "9072", + "kind": "number", + "type": { + "$ref": "3121" + }, + "value": 10 + } + } + }, + "suggesters": { + "$id": "9073", + "kind": "array", + "type": { + "$ref": "3127" + }, + "value": [ + { + "$id": "9074", + "kind": "model", + "type": { + "$ref": "3128" + }, + "value": { + "$id": "9075", + "name": { + "$id": "9076", + "kind": "string", + "type": { + "$ref": "3130" + }, + "value": "sg" + }, + "searchMode": { + "$id": "9077", + "kind": "string", + "type": { + "$ref": "3134" + }, + "value": "analyzingInfixMatching" + }, + "sourceFields": { + "$id": "9078", + "kind": "array", + "type": { + "$ref": "3138" + }, + "value": [ + { + "$id": "9079", + "kind": "string", + "type": { + "$ref": "3139" + }, + "value": "category" + }, + { + "$id": "9080", + "kind": "string", + "type": { + "$ref": "3139" + }, + "value": "ownerId" + } + ] + } + } + } + ] + }, + "analyzers": { + "$id": "9081", + "kind": "array", + "type": { + "$ref": "3145" + }, + "value": [] + }, + "normalizers": { + "$id": "9082", + "kind": "array", + "type": { + "$ref": "3823" + }, + "value": [] + }, + "tokenizers": { + "$id": "9083", + "kind": "array", + "type": { + "$ref": "3224" + }, + "value": [] + }, + "tokenFilters": { + "$id": "9084", + "kind": "array", + "type": { + "$ref": "3391" + }, + "value": [] + }, + "charFilters": { + "$id": "9085", + "kind": "array", + "type": { + "$ref": "3784" + }, + "value": [] + }, + "semantic": { + "$id": "9086", + "kind": "model", + "type": { + "$ref": "3933" + }, + "value": { + "$id": "9087", + "defaultConfiguration": { + "$id": "9088", + "kind": "string", + "type": { + "$ref": "3935" + }, + "value": "testconfig" + }, + "configurations": { + "$id": "9089", + "kind": "array", + "type": { + "$ref": "3939" + }, + "value": [ + { + "$id": "9090", + "kind": "model", + "type": { + "$ref": "3940" + }, + "value": { + "$id": "9091", + "name": { + "$id": "9092", + "kind": "string", + "type": { + "$ref": "3942" + }, + "value": "testconfig" + }, + "flightingOptIn": { + "$id": "9093", + "kind": "boolean", + "type": { + "$ref": "3966" + }, + "value": false + }, + "prioritizedFields": { + "$id": "9094", + "kind": "model", + "type": { + "$ref": "3946" + }, + "value": { + "$id": "9095", + "titleField": { + "$id": "9096", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "9097", + "fieldName": { + "$id": "9098", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "category" + } + } + }, + "prioritizedContentFields": { + "$id": "9099", + "kind": "array", + "type": { + "$ref": "3956" + }, + "value": [ + { + "$id": "9100", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "9101", + "fieldName": { + "$id": "9102", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "description" + } + } + } + ] + }, + "prioritizedKeywordsFields": { + "$id": "9103", + "kind": "array", + "type": { + "$ref": "3960" + }, + "value": [ + { + "$id": "9104", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "9105", + "fieldName": { + "$id": "9106", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "ownerId" + } + } + } + ] + } + } + } + } + } + ] + } + } + }, + "vectorSearch": { + "$id": "9107", + "kind": "model", + "type": { + "$ref": "3974" + }, + "value": { + "$id": "9108", + "algorithms": { + "$id": "9109", + "kind": "array", + "type": { + "$ref": "3997" + }, + "value": [ + { + "$id": "9110", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "9111", + "name": { + "$id": "9112", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "cosine" + }, + "kind": { + "$id": "9113", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + }, + "hnswParameters": { + "$id": "9114", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "9115", + "metric": { + "$id": "9116", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "cosine" + }, + "m": { + "$id": "9117", + "kind": "number", + "type": { + "$ref": "4011" + }, + "value": 4 + }, + "efConstruction": { + "$id": "9118", + "kind": "number", + "type": { + "$ref": "4015" + }, + "value": 400 + }, + "efSearch": { + "$id": "9119", + "kind": "number", + "type": { + "$ref": "4019" + }, + "value": 500 + } + } + } + } + }, + { + "$id": "9120", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "9121", + "name": { + "$id": "9122", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "euclidean" + }, + "kind": { + "$id": "9123", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + }, + "hnswParameters": { + "$id": "9124", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "9125", + "metric": { + "$id": "9126", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "euclidean" + }, + "m": { + "$id": "9127", + "kind": "number", + "type": { + "$ref": "4011" + }, + "value": 4 + }, + "efConstruction": { + "$id": "9128", + "kind": "number", + "type": { + "$ref": "4015" + }, + "value": 400 + }, + "efSearch": { + "$id": "9129", + "kind": "number", + "type": { + "$ref": "4019" + }, + "value": 500 + } + } + } + } + }, + { + "$id": "9130", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "9131", + "name": { + "$id": "9132", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "dotProduct" + }, + "kind": { + "$id": "9133", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + }, + "hnswParameters": { + "$id": "9134", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "9135", + "metric": { + "$id": "9136", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "dotProduct" + }, + "m": { + "$id": "9137", + "kind": "number", + "type": { + "$ref": "4011" + }, + "value": 4 + }, + "efConstruction": { + "$id": "9138", + "kind": "number", + "type": { + "$ref": "4015" + }, + "value": 400 + }, + "efSearch": { + "$id": "9139", + "kind": "number", + "type": { + "$ref": "4019" + }, + "value": 500 + } + } + } + } + } + ] + }, + "profiles": { + "$id": "9140", + "kind": "array", + "type": { + "$ref": "3976" + }, + "value": [ + { + "$id": "9141", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "9142", + "name": { + "$id": "9143", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config1" + }, + "algorithm": { + "$id": "9144", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "cosine" + }, + "vectorizer": { + "$id": "9145", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "openai" + }, + "compression": { + "$id": "9146", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "mySQ8" + } + } + }, + { + "$id": "9147", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "9148", + "name": { + "$id": "9149", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config2" + }, + "algorithm": { + "$id": "9150", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "euclidean" + }, + "vectorizer": { + "$id": "9151", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "9152", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "mySQ8" + } + } + }, + { + "$id": "9153", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "9154", + "name": { + "$id": "9155", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config3" + }, + "algorithm": { + "$id": "9156", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "dotProduct" + }, + "vectorizer": { + "$id": "9157", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "9158", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "myBQC" + } + } + }, + { + "$id": "9159", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "9160", + "name": { + "$id": "9161", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config4" + }, + "algorithm": { + "$id": "9162", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "dotProduct" + }, + "vectorizer": { + "$id": "9163", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "9164", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "myBQWithoutOriginals" + } + } + } + ] + }, + "vectorizers": { + "$id": "9165", + "kind": "array", + "type": { + "$ref": "4048" + }, + "value": [ + { + "$id": "9166", + "kind": "model", + "type": { + "$ref": "4058" + }, + "value": { + "$id": "9167", + "name": { + "$id": "9168", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "openai" + }, + "kind": { + "$id": "9169", + "kind": "string", + "type": { + "$ref": "4082" + }, + "value": "azureOpenAI" + }, + "azureOpenAIParameters": { + "$id": "9170", + "kind": "model", + "type": { + "$ref": "4060" + }, + "value": { + "$id": "9171", + "resourceUri": { + "$id": "9172", + "kind": "string", + "type": { + "$ref": "4062" + }, + "value": "https://test-sample.openai.azure.com" + }, + "deploymentId": { + "$id": "9173", + "kind": "string", + "type": { + "$ref": "4066" + }, + "value": "model" + }, + "apiKey": { + "$id": "9174", + "kind": "string", + "type": { + "$ref": "4070" + }, + "value": "api-key" + }, + "modelName": { + "$id": "9175", + "kind": "string", + "type": { + "$ref": "1135" + }, + "value": "text-embedding-3-large" + } + } + } + } + }, + { + "$id": "9176", + "kind": "model", + "type": { + "$ref": "4086" + }, + "value": { + "$id": "9177", + "name": { + "$id": "9178", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "custom-web-api" + }, + "kind": { + "$id": "9179", + "kind": "string", + "type": { + "$ref": "4118" + }, + "value": "customWebApi" + }, + "customWebApiParameters": { + "$id": "9180", + "kind": "model", + "type": { + "$ref": "4088" + }, + "value": { + "$id": "9181", + "httpMethod": { + "$id": "9182", + "kind": "string", + "type": { + "$ref": "4100" + }, + "value": "POST" + }, + "uri": { + "$id": "9183", + "kind": "string", + "type": { + "$ref": "4090" + }, + "value": "https://my-custom-endpoint.org/" + }, + "timeout": { + "$id": "9184", + "kind": "string", + "type": { + "$ref": "4104" + }, + "value": "PT1M" + }, + "authResourceId": { + "$id": "9185", + "kind": "string", + "type": { + "$ref": "4109" + }, + "value": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b" + }, + "httpHeaders": { + "$id": "9186", + "kind": "dict", + "type": { + "$ref": "4094" + }, + "value": { + "$id": "9187", + "header1": { + "$id": "9188", + "kind": "string", + "type": { + "$ref": "4096" + }, + "value": "value1" + }, + "header2": { + "$id": "9189", + "kind": "string", + "type": { + "$ref": "4096" + }, + "value": "value2" + } + } + } + } + } + } + }, + { + "$id": "9190", + "kind": "model", + "type": { + "$ref": "4147" + }, + "value": { + "$id": "9191", + "name": { + "$id": "9192", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "aml" + }, + "kind": { + "$id": "9193", + "kind": "string", + "type": { + "$ref": "4177" + }, + "value": "aml" + }, + "amlParameters": { + "$id": "9194", + "kind": "model", + "type": { + "$ref": "4149" + }, + "value": { + "$id": "9195", + "resourceId": { + "$id": "9196", + "kind": "string", + "type": { + "$ref": "4159" + }, + "value": "aml resource id" + }, + "region": { + "$id": "9197", + "kind": "string", + "type": { + "$ref": "4168" + }, + "value": "aml region" + }, + "uri": { + "$id": "9198", + "kind": "string", + "type": { + "$ref": "4151" + }, + "value": "https://my-custom-endpoint.org/" + }, + "timeout": { + "$id": "9199", + "kind": "string", + "type": { + "$ref": "4163" + }, + "value": "PT1M" + }, + "modelName": { + "$id": "9200", + "kind": "string", + "type": { + "$ref": "1143" + }, + "value": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + } + } + } + ] + }, + "compressions": { + "$id": "9201", + "kind": "array", + "type": { + "$ref": "4184" + }, + "value": [ + { + "$id": "9202", + "kind": "model", + "type": { + "$ref": "4221" + }, + "value": { + "$id": "9203", + "name": { + "$id": "9204", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "mySQ8" + }, + "kind": { + "$id": "9205", + "kind": "string", + "type": { + "$ref": "4230" + }, + "value": "scalarQuantization" + }, + "truncationDimension": { + "$id": "9206", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + }, + "scalarQuantizationParameters": { + "$id": "9207", + "kind": "model", + "type": { + "$ref": "4223" + }, + "value": { + "$id": "9208", + "quantizedDataType": { + "$id": "9209", + "kind": "string", + "type": { + "$ref": "1169" + }, + "value": "int8" + } + } + }, + "rescoringOptions": { + "$id": "9210", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "9211", + "enableRescoring": { + "$id": "9212", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "9213", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "9214", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "preserveOriginals" + } + } + } + } + }, + { + "$id": "9215", + "kind": "model", + "type": { + "$ref": "4234" + }, + "value": { + "$id": "9216", + "name": { + "$id": "9217", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "myBQC" + }, + "kind": { + "$id": "9218", + "kind": "string", + "type": { + "$ref": "4236" + }, + "value": "binaryQuantization" + }, + "truncationDimension": { + "$id": "9219", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + }, + "rescoringOptions": { + "$id": "9220", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "9221", + "enableRescoring": { + "$id": "9222", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "9223", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "9224", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "preserveOriginals" + } + } + } + } + }, + { + "$id": "9225", + "kind": "model", + "type": { + "$ref": "4234" + }, + "value": { + "$id": "9226", + "name": { + "$id": "9227", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "myBQWithoutOriginals" + }, + "kind": { + "$id": "9228", + "kind": "string", + "type": { + "$ref": "4236" + }, + "value": "binaryQuantization" + }, + "truncationDimension": { + "$id": "9229", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + }, + "rescoringOptions": { + "$id": "9230", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "9231", + "enableRescoring": { + "$id": "9232", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "9233", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "9234", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "discardOriginals" + } + } + } + } + } + ] + } + } + } + } + } + } + ] + } + ] + }, + { + "$id": "9235", + "name": "delete", + "resourceName": "Indexes", + "doc": "Deletes a search index and all the documents it contains. This operation is\npermanent, with no recovery option. Make sure you have a master copy of your\nindex definition, data ingestion code, and a backup of the primary data source\nin case you need to re-build the index.", + "accessibility": "public", + "parameters": [ + { + "$id": "9236", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "9237", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "9238", + "type": { + "$id": "9239", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9240", + "name": "ifMatch", + "nameInRequest": "If-Match", + "doc": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "type": { + "$id": "9241", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9242", + "name": "ifNoneMatch", + "nameInRequest": "If-None-Match", + "doc": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "type": { + "$id": "9243", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9244", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "9245", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "9246", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9247", + "name": "indexName", + "nameInRequest": "indexName", + "doc": "The name of the index.", + "type": { + "$id": "9248", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9249", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "9250", + "kind": "constant", + "valueType": { + "$id": "9251", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "9252", + "statusCodes": [ + 204 + ], + "headers": [], + "isErrorResponse": false + }, + { + "$id": "9253", + "statusCodes": [ + 404 + ], + "headers": [], + "isErrorResponse": false + } + ], + "httpMethod": "DELETE", + "uri": "{endpoint}", + "path": "/indexes('{indexName}')", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexes.delete", + "decorators": [], + "examples": [ + { + "$id": "9254", + "kind": "http", + "name": "SearchServiceDeleteIndex", + "description": "SearchServiceDeleteIndex", + "filePath": "2025-03-01-preview/SearchServiceDeleteIndex.json", + "parameters": [ + { + "$id": "9255", + "parameter": { + "$ref": "9247" + }, + "value": { + "$id": "9256", + "kind": "string", + "type": { + "$ref": "9248" + }, + "value": "temp-preview-test" + } + }, + { + "$id": "9257", + "parameter": { + "$ref": "9236" + }, + "value": { + "$id": "9258", + "kind": "string", + "type": { + "$ref": "9237" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "9259", + "parameter": { + "$ref": "9244" + }, + "value": { + "$id": "9260", + "kind": "string", + "type": { + "$ref": "9245" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "9261", + "response": { + "$ref": "9252" + }, + "statusCode": 204 + }, + { + "$id": "9262", + "response": { + "$ref": "9253" + }, + "statusCode": 404 + } + ] + } + ] + }, + { + "$id": "9263", + "name": "get", + "resourceName": "Indexes", + "doc": "Retrieves an index definition.", + "accessibility": "public", + "parameters": [ + { + "$id": "9264", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "9265", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "9266", + "type": { + "$id": "9267", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9268", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "9269", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "9270", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9271", + "name": "indexName", + "nameInRequest": "indexName", + "doc": "The name of the index.", + "type": { + "$id": "9272", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9273", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "9274", + "kind": "constant", + "valueType": { + "$id": "9275", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "9276", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "2920" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/indexes('{indexName}')", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexes.get", + "decorators": [], + "examples": [ + { + "$id": "9277", + "kind": "http", + "name": "SearchServiceGetIndex", + "description": "SearchServiceGetIndex", + "filePath": "2025-03-01-preview/SearchServiceGetIndex.json", + "parameters": [ + { + "$id": "9278", + "parameter": { + "$ref": "9271" + }, + "value": { + "$id": "9279", + "kind": "string", + "type": { + "$ref": "9272" + }, + "value": "preview-test" + } + }, + { + "$id": "9280", + "parameter": { + "$ref": "9264" + }, + "value": { + "$id": "9281", + "kind": "string", + "type": { + "$ref": "9265" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "9282", + "parameter": { + "$ref": "9268" + }, + "value": { + "$id": "9283", + "kind": "string", + "type": { + "$ref": "9269" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "9284", + "response": { + "$ref": "9276" + }, + "statusCode": 200, + "bodyValue": { + "$id": "9285", + "kind": "model", + "type": { + "$ref": "2920" + }, + "value": { + "$id": "9286", + "@odata.etag": { + "$id": "9287", + "kind": "string", + "type": { + "$ref": "4245" + }, + "value": "0x1234568AE7E58A1" + }, + "name": { + "$id": "9288", + "kind": "string", + "type": { + "$ref": "2922" + }, + "value": "preview-test" + }, + "defaultScoringProfile": { + "$id": "9289", + "kind": "string", + "type": { + "$ref": "3110" + }, + "value": "stringFieldBoost" + }, + "fields": { + "$id": "9290", + "kind": "array", + "type": { + "$ref": "2926" + }, + "value": [ + { + "$id": "9291", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "9292", + "name": { + "$id": "9293", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "id" + }, + "type": { + "$id": "9294", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "9295", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "9296", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "9297", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9298", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9299", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "9300", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "9301", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": true + }, + "synonymMaps": { + "$id": "9302", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "9303", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "9304", + "name": { + "$id": "9305", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector1" + }, + "type": { + "$id": "9306", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "9307", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "9308", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "9309", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9310", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9311", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "9312", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "9313", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "9314", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 20 + }, + "vectorSearchProfile": { + "$id": "9315", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config1" + }, + "synonymMaps": { + "$id": "9316", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "9317", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "9318", + "name": { + "$id": "9319", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector1b" + }, + "type": { + "$id": "9320", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "9321", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "9322", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "9323", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9324", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9325", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "9326", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "9327", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "9328", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 10 + }, + "vectorSearchProfile": { + "$id": "9329", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config2" + }, + "synonymMaps": { + "$id": "9330", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "9331", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "9332", + "name": { + "$id": "9333", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector2" + }, + "type": { + "$id": "9334", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "9335", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "9336", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "9337", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9338", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9339", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "9340", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "9341", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "9342", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 5 + }, + "vectorSearchProfile": { + "$id": "9343", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config3" + }, + "synonymMaps": { + "$id": "9344", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "9345", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "9346", + "name": { + "$id": "9347", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector3" + }, + "type": { + "$id": "9348", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "9349", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "9350", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "9351", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9352", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9353", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "9354", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "9355", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "9356", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 5 + }, + "vectorSearchProfile": { + "$id": "9357", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config3" + }, + "synonymMaps": { + "$id": "9358", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "9359", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "9360", + "name": { + "$id": "9361", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector22" + }, + "type": { + "$id": "9362", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "9363", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "9364", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "9365", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9366", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9367", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "9368", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "9369", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "9370", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 10 + }, + "vectorSearchProfile": { + "$id": "9371", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config2" + }, + "synonymMaps": { + "$id": "9372", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "9373", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "9374", + "name": { + "$id": "9375", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "vector4" + }, + "type": { + "$id": "9376", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Collection(Edm.Single)" + }, + "searchable": { + "$id": "9377", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "9378", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": false + }, + "retrievable": { + "$id": "9379", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9380", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9381", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": false + }, + "facetable": { + "$id": "9382", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": false + }, + "key": { + "$id": "9383", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "dimensions": { + "$id": "9384", + "kind": "number", + "type": { + "$ref": "2976" + }, + "value": 32 + }, + "vectorSearchProfile": { + "$id": "9385", + "kind": "string", + "type": { + "$ref": "2980" + }, + "value": "config4" + }, + "synonymMaps": { + "$id": "9386", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "9387", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "9388", + "name": { + "$id": "9389", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "name" + }, + "type": { + "$id": "9390", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "9391", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "9392", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "9393", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9394", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9395", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "9396", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "9397", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "9398", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + }, + "synonymMaps": { + "$id": "9399", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "9400", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "9401", + "name": { + "$id": "9402", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "description" + }, + "type": { + "$id": "9403", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "9404", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "9405", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "9406", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9407", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9408", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "9409", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "9410", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "9411", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "standard.lucene" + }, + "synonymMaps": { + "$id": "9412", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "9413", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "9414", + "name": { + "$id": "9415", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "category" + }, + "type": { + "$id": "9416", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "9417", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "9418", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "9419", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9420", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9421", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "9422", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "9423", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "9424", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + }, + "synonymMaps": { + "$id": "9425", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "9426", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "9427", + "name": { + "$id": "9428", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "ownerId" + }, + "type": { + "$id": "9429", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.String" + }, + "searchable": { + "$id": "9430", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": true + }, + "filterable": { + "$id": "9431", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "9432", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9433", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9434", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "9435", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "9436", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "analyzer": { + "$id": "9437", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "en.lucene" + }, + "synonymMaps": { + "$id": "9438", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + }, + { + "$id": "9439", + "kind": "model", + "type": { + "$ref": "2927" + }, + "value": { + "$id": "9440", + "name": { + "$id": "9441", + "kind": "string", + "type": { + "$ref": "2929" + }, + "value": "price" + }, + "type": { + "$id": "9442", + "kind": "string", + "type": { + "$ref": "282" + }, + "value": "Edm.Double" + }, + "searchable": { + "$id": "9443", + "kind": "boolean", + "type": { + "$ref": "2948" + }, + "value": false + }, + "filterable": { + "$id": "9444", + "kind": "boolean", + "type": { + "$ref": "2952" + }, + "value": true + }, + "retrievable": { + "$id": "9445", + "kind": "boolean", + "type": { + "$ref": "2940" + }, + "value": true + }, + "stored": { + "$id": "9446", + "kind": "boolean", + "type": { + "$ref": "2944" + }, + "value": true + }, + "sortable": { + "$id": "9447", + "kind": "boolean", + "type": { + "$ref": "2956" + }, + "value": true + }, + "facetable": { + "$id": "9448", + "kind": "boolean", + "type": { + "$ref": "2960" + }, + "value": true + }, + "key": { + "$id": "9449", + "kind": "boolean", + "type": { + "$ref": "2936" + }, + "value": false + }, + "synonymMaps": { + "$id": "9450", + "kind": "array", + "type": { + "$ref": "2987" + }, + "value": [] + } + } + } + ] + }, + "scoringProfiles": { + "$id": "9451", + "kind": "array", + "type": { + "$ref": "2998" + }, + "value": [ + { + "$id": "9452", + "kind": "model", + "type": { + "$ref": "2999" + }, + "value": { + "$id": "9453", + "name": { + "$id": "9454", + "kind": "string", + "type": { + "$ref": "3001" + }, + "value": "stringFieldBoost" + }, + "functionAggregation": { + "$id": "9455", + "kind": "string", + "type": { + "$ref": "524" + }, + "value": "sum" + }, + "text": { + "$id": "9456", + "kind": "model", + "type": { + "$ref": "3005" + }, + "value": { + "$id": "9457", + "weights": { + "$id": "9458", + "kind": "dict", + "type": { + "$ref": "3007" + }, + "value": { + "$id": "9459", + "name": { + "$id": "9460", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 3 + }, + "description": { + "$id": "9461", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 1 + }, + "category": { + "$id": "9462", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 2 + }, + "ownerId": { + "$id": "9463", + "kind": "number", + "type": { + "$ref": "3009" + }, + "value": 1 + } + } + } + } + }, + "functions": { + "$id": "9464", + "kind": "array", + "type": { + "$ref": "3015" + }, + "value": [ + { + "$id": "9465", + "kind": "model", + "type": { + "$ref": "3088" + }, + "value": { + "$id": "9466", + "fieldName": { + "$id": "9467", + "kind": "string", + "type": { + "$ref": "3022" + }, + "value": "category" + }, + "interpolation": { + "$id": "9468", + "kind": "string", + "type": { + "$ref": "514" + }, + "value": "linear" + }, + "type": { + "$id": "9469", + "kind": "string", + "type": { + "$ref": "3098" + }, + "value": "tag" + }, + "boost": { + "$id": "9470", + "kind": "number", + "type": { + "$ref": "3026" + }, + "value": 2 + }, + "tag": { + "$id": "9471", + "kind": "model", + "type": { + "$ref": "3090" + }, + "value": { + "$id": "9472", + "tagsParameter": { + "$id": "9473", + "kind": "string", + "type": { + "$ref": "3092" + }, + "value": "categoryTag" + } + } + } + } + } + ] + } + } + } + ] + }, + "corsOptions": { + "$id": "9474", + "kind": "model", + "type": { + "$ref": "3114" + }, + "value": { + "$id": "9475", + "allowedOrigins": { + "$id": "9476", + "kind": "array", + "type": { + "$ref": "3116" + }, + "value": [ + { + "$id": "9477", + "kind": "string", + "type": { + "$ref": "3117" + }, + "value": "https://www.example.com/foo" + } + ] + }, + "maxAgeInSeconds": { + "$id": "9478", + "kind": "number", + "type": { + "$ref": "3121" + }, + "value": 10 + } + } + }, + "suggesters": { + "$id": "9479", + "kind": "array", + "type": { + "$ref": "3127" + }, + "value": [ + { + "$id": "9480", + "kind": "model", + "type": { + "$ref": "3128" + }, + "value": { + "$id": "9481", + "name": { + "$id": "9482", + "kind": "string", + "type": { + "$ref": "3130" + }, + "value": "sg" + }, + "searchMode": { + "$id": "9483", + "kind": "string", + "type": { + "$ref": "3134" + }, + "value": "analyzingInfixMatching" + }, + "sourceFields": { + "$id": "9484", + "kind": "array", + "type": { + "$ref": "3138" + }, + "value": [ + { + "$id": "9485", + "kind": "string", + "type": { + "$ref": "3139" + }, + "value": "category" + }, + { + "$id": "9486", + "kind": "string", + "type": { + "$ref": "3139" + }, + "value": "ownerId" + } + ] + } + } + } + ] + }, + "analyzers": { + "$id": "9487", + "kind": "array", + "type": { + "$ref": "3145" + }, + "value": [] + }, + "normalizers": { + "$id": "9488", + "kind": "array", + "type": { + "$ref": "3823" + }, + "value": [] + }, + "tokenizers": { + "$id": "9489", + "kind": "array", + "type": { + "$ref": "3224" + }, + "value": [] + }, + "tokenFilters": { + "$id": "9490", + "kind": "array", + "type": { + "$ref": "3391" + }, + "value": [] + }, + "charFilters": { + "$id": "9491", + "kind": "array", + "type": { + "$ref": "3784" + }, + "value": [] + }, + "semantic": { + "$id": "9492", + "kind": "model", + "type": { + "$ref": "3933" + }, + "value": { + "$id": "9493", + "defaultConfiguration": { + "$id": "9494", + "kind": "string", + "type": { + "$ref": "3935" + }, + "value": "testconfig" + }, + "configurations": { + "$id": "9495", + "kind": "array", + "type": { + "$ref": "3939" + }, + "value": [ + { + "$id": "9496", + "kind": "model", + "type": { + "$ref": "3940" + }, + "value": { + "$id": "9497", + "name": { + "$id": "9498", + "kind": "string", + "type": { + "$ref": "3942" + }, + "value": "testconfig" + }, + "flightingOptIn": { + "$id": "9499", + "kind": "boolean", + "type": { + "$ref": "3966" + }, + "value": false + }, + "prioritizedFields": { + "$id": "9500", + "kind": "model", + "type": { + "$ref": "3946" + }, + "value": { + "$id": "9501", + "titleField": { + "$id": "9502", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "9503", + "fieldName": { + "$id": "9504", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "category" + } + } + }, + "prioritizedContentFields": { + "$id": "9505", + "kind": "array", + "type": { + "$ref": "3956" + }, + "value": [ + { + "$id": "9506", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "9507", + "fieldName": { + "$id": "9508", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "description" + } + } + } + ] + }, + "prioritizedKeywordsFields": { + "$id": "9509", + "kind": "array", + "type": { + "$ref": "3960" + }, + "value": [ + { + "$id": "9510", + "kind": "model", + "type": { + "$ref": "3948" + }, + "value": { + "$id": "9511", + "fieldName": { + "$id": "9512", + "kind": "string", + "type": { + "$ref": "3950" + }, + "value": "ownerId" + } + } + } + ] + } + } + } + } + } + ] + } + } + }, + "vectorSearch": { + "$id": "9513", + "kind": "model", + "type": { + "$ref": "3974" + }, + "value": { + "$id": "9514", + "algorithms": { + "$id": "9515", + "kind": "array", + "type": { + "$ref": "3997" + }, + "value": [ + { + "$id": "9516", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "9517", + "name": { + "$id": "9518", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "cosine" + }, + "kind": { + "$id": "9519", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + }, + "hnswParameters": { + "$id": "9520", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "9521", + "metric": { + "$id": "9522", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "cosine" + }, + "m": { + "$id": "9523", + "kind": "number", + "type": { + "$ref": "4011" + }, + "value": 4 + }, + "efConstruction": { + "$id": "9524", + "kind": "number", + "type": { + "$ref": "4015" + }, + "value": 400 + }, + "efSearch": { + "$id": "9525", + "kind": "number", + "type": { + "$ref": "4019" + }, + "value": 500 + } + } + } + } + }, + { + "$id": "9526", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "9527", + "name": { + "$id": "9528", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "euclidean" + }, + "kind": { + "$id": "9529", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + }, + "hnswParameters": { + "$id": "9530", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "9531", + "metric": { + "$id": "9532", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "euclidean" + }, + "m": { + "$id": "9533", + "kind": "number", + "type": { + "$ref": "4011" + }, + "value": 4 + }, + "efConstruction": { + "$id": "9534", + "kind": "number", + "type": { + "$ref": "4015" + }, + "value": 400 + }, + "efSearch": { + "$id": "9535", + "kind": "number", + "type": { + "$ref": "4019" + }, + "value": 500 + } + } + } + } + }, + { + "$id": "9536", + "kind": "model", + "type": { + "$ref": "4007" + }, + "value": { + "$id": "9537", + "name": { + "$id": "9538", + "kind": "string", + "type": { + "$ref": "4003" + }, + "value": "dotProduct" + }, + "kind": { + "$id": "9539", + "kind": "string", + "type": { + "$ref": "4028" + }, + "value": "hnsw" + }, + "hnswParameters": { + "$id": "9540", + "kind": "model", + "type": { + "$ref": "4009" + }, + "value": { + "$id": "9541", + "metric": { + "$id": "9542", + "kind": "string", + "type": { + "$ref": "1115" + }, + "value": "dotProduct" + }, + "m": { + "$id": "9543", + "kind": "number", + "type": { + "$ref": "4011" + }, + "value": 4 + }, + "efConstruction": { + "$id": "9544", + "kind": "number", + "type": { + "$ref": "4015" + }, + "value": 400 + }, + "efSearch": { + "$id": "9545", + "kind": "number", + "type": { + "$ref": "4019" + }, + "value": 500 + } + } + } + } + } + ] + }, + "profiles": { + "$id": "9546", + "kind": "array", + "type": { + "$ref": "3976" + }, + "value": [ + { + "$id": "9547", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "9548", + "name": { + "$id": "9549", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config1" + }, + "algorithm": { + "$id": "9550", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "cosine" + }, + "vectorizer": { + "$id": "9551", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "openai" + }, + "compression": { + "$id": "9552", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "mySQ8" + } + } + }, + { + "$id": "9553", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "9554", + "name": { + "$id": "9555", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config2" + }, + "algorithm": { + "$id": "9556", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "euclidean" + }, + "vectorizer": { + "$id": "9557", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "9558", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "mySQ8" + } + } + }, + { + "$id": "9559", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "9560", + "name": { + "$id": "9561", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config3" + }, + "algorithm": { + "$id": "9562", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "dotProduct" + }, + "vectorizer": { + "$id": "9563", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "9564", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "myBQC" + } + } + }, + { + "$id": "9565", + "kind": "model", + "type": { + "$ref": "3977" + }, + "value": { + "$id": "9566", + "name": { + "$id": "9567", + "kind": "string", + "type": { + "$ref": "3979" + }, + "value": "config4" + }, + "algorithm": { + "$id": "9568", + "kind": "string", + "type": { + "$ref": "3983" + }, + "value": "dotProduct" + }, + "vectorizer": { + "$id": "9569", + "kind": "string", + "type": { + "$ref": "3987" + }, + "value": "custom-web-api" + }, + "compression": { + "$id": "9570", + "kind": "string", + "type": { + "$ref": "3991" + }, + "value": "myBQWithoutOriginals" + } + } + } + ] + }, + "vectorizers": { + "$id": "9571", + "kind": "array", + "type": { + "$ref": "4048" + }, + "value": [ + { + "$id": "9572", + "kind": "model", + "type": { + "$ref": "4058" + }, + "value": { + "$id": "9573", + "name": { + "$id": "9574", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "openai" + }, + "kind": { + "$id": "9575", + "kind": "string", + "type": { + "$ref": "4082" + }, + "value": "azureOpenAI" + }, + "azureOpenAIParameters": { + "$id": "9576", + "kind": "model", + "type": { + "$ref": "4060" + }, + "value": { + "$id": "9577", + "resourceUri": { + "$id": "9578", + "kind": "string", + "type": { + "$ref": "4062" + }, + "value": "https://test-sample.openai.azure.com" + }, + "deploymentId": { + "$id": "9579", + "kind": "string", + "type": { + "$ref": "4066" + }, + "value": "model" + }, + "apiKey": { + "$id": "9580", + "kind": "string", + "type": { + "$ref": "4070" + }, + "value": "" + }, + "modelName": { + "$id": "9581", + "kind": "string", + "type": { + "$ref": "1135" + }, + "value": "text-embedding-3-large" + } + } + } + } + }, + { + "$id": "9582", + "kind": "model", + "type": { + "$ref": "4086" + }, + "value": { + "$id": "9583", + "name": { + "$id": "9584", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "custom-web-api" + }, + "kind": { + "$id": "9585", + "kind": "string", + "type": { + "$ref": "4118" + }, + "value": "customWebApi" + }, + "customWebApiParameters": { + "$id": "9586", + "kind": "model", + "type": { + "$ref": "4088" + }, + "value": { + "$id": "9587", + "httpMethod": { + "$id": "9588", + "kind": "string", + "type": { + "$ref": "4100" + }, + "value": "POST" + }, + "uri": { + "$id": "9589", + "kind": "string", + "type": { + "$ref": "4090" + }, + "value": "https://my-custom-endpoint.org/" + }, + "timeout": { + "$id": "9590", + "kind": "string", + "type": { + "$ref": "4104" + }, + "value": "PT1M" + }, + "authResourceId": { + "$id": "9591", + "kind": "string", + "type": { + "$ref": "4109" + }, + "value": "api://f89d1c93-58a7-4b07-9a5b-5f89048b927b" + }, + "httpHeaders": { + "$id": "9592", + "kind": "dict", + "type": { + "$ref": "4094" + }, + "value": { + "$id": "9593", + "header1": { + "$id": "9594", + "kind": "string", + "type": { + "$ref": "4096" + }, + "value": "value1" + }, + "header2": { + "$id": "9595", + "kind": "string", + "type": { + "$ref": "4096" + }, + "value": "value2" + } + } + } + } + } + } + }, + { + "$id": "9596", + "kind": "model", + "type": { + "$ref": "4147" + }, + "value": { + "$id": "9597", + "name": { + "$id": "9598", + "kind": "string", + "type": { + "$ref": "4054" + }, + "value": "aml" + }, + "kind": { + "$id": "9599", + "kind": "string", + "type": { + "$ref": "4177" + }, + "value": "aml" + }, + "amlParameters": { + "$id": "9600", + "kind": "model", + "type": { + "$ref": "4149" + }, + "value": { + "$id": "9601", + "resourceId": { + "$id": "9602", + "kind": "string", + "type": { + "$ref": "4159" + }, + "value": "aml resource id" + }, + "region": { + "$id": "9603", + "kind": "string", + "type": { + "$ref": "4168" + }, + "value": "aml region" + }, + "uri": { + "$id": "9604", + "kind": "string", + "type": { + "$ref": "4151" + }, + "value": "https://my-custom-endpoint.org/" + }, + "timeout": { + "$id": "9605", + "kind": "string", + "type": { + "$ref": "4163" + }, + "value": "PT1M" + }, + "modelName": { + "$id": "9606", + "kind": "string", + "type": { + "$ref": "1143" + }, + "value": "OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32" + } + } + } + } + } + ] + }, + "compressions": { + "$id": "9607", + "kind": "array", + "type": { + "$ref": "4184" + }, + "value": [ + { + "$id": "9608", + "kind": "model", + "type": { + "$ref": "4221" + }, + "value": { + "$id": "9609", + "name": { + "$id": "9610", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "mySQ8" + }, + "kind": { + "$id": "9611", + "kind": "string", + "type": { + "$ref": "4230" + }, + "value": "scalarQuantization" + }, + "truncationDimension": { + "$id": "9612", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + }, + "scalarQuantizationParameters": { + "$id": "9613", + "kind": "model", + "type": { + "$ref": "4223" + }, + "value": { + "$id": "9614", + "quantizedDataType": { + "$id": "9615", + "kind": "string", + "type": { + "$ref": "1169" + }, + "value": "int8" + } + } + }, + "rescoringOptions": { + "$id": "9616", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "9617", + "enableRescoring": { + "$id": "9618", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "9619", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "9620", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "preserveOriginals" + } + } + } + } + }, + { + "$id": "9621", + "kind": "model", + "type": { + "$ref": "4234" + }, + "value": { + "$id": "9622", + "name": { + "$id": "9623", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "myBQC" + }, + "kind": { + "$id": "9624", + "kind": "string", + "type": { + "$ref": "4236" + }, + "value": "binaryQuantization" + }, + "truncationDimension": { + "$id": "9625", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + }, + "rescoringOptions": { + "$id": "9626", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "9627", + "enableRescoring": { + "$id": "9628", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "9629", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "9630", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "preserveOriginals" + } + } + } + } + }, + { + "$id": "9631", + "kind": "model", + "type": { + "$ref": "4234" + }, + "value": { + "$id": "9632", + "name": { + "$id": "9633", + "kind": "string", + "type": { + "$ref": "4190" + }, + "value": "myBQWithoutOriginals" + }, + "kind": { + "$id": "9634", + "kind": "string", + "type": { + "$ref": "4236" + }, + "value": "binaryQuantization" + }, + "truncationDimension": { + "$id": "9635", + "kind": "number", + "type": { + "$ref": "4217" + }, + "value": 2 + }, + "rescoringOptions": { + "$id": "9636", + "kind": "model", + "type": { + "$ref": "4202" + }, + "value": { + "$id": "9637", + "enableRescoring": { + "$id": "9638", + "kind": "boolean", + "type": { + "$ref": "4204" + }, + "value": true + }, + "defaultOversampling": { + "$id": "9639", + "kind": "number", + "type": { + "$ref": "4208" + }, + "value": 10 + }, + "rescoreStorageMethod": { + "$id": "9640", + "kind": "string", + "type": { + "$ref": "1157" + }, + "value": "discardOriginals" + } + } + } + } + } + ] + } + } + } + } + } + } + ] + } + ] + }, + { + "$id": "9641", + "name": "getStatistics", + "resourceName": "Indexes", + "doc": "Returns statistics for the given index, including a document count and storage\nusage.", + "accessibility": "public", + "parameters": [ + { + "$id": "9642", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "9643", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "9644", + "type": { + "$id": "9645", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9646", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "9647", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "9648", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9649", + "name": "indexName", + "nameInRequest": "indexName", + "doc": "The name of the index.", + "type": { + "$id": "9650", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9651", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "9652", + "kind": "constant", + "valueType": { + "$id": "9653", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "9654", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "4253" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/indexes('{indexName}')/search.stats", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexes.getStatistics", + "decorators": [], + "examples": [ + { + "$id": "9655", + "kind": "http", + "name": "SearchServiceGetIndexStatistics", + "description": "SearchServiceGetIndexStatistics", + "filePath": "2025-03-01-preview/SearchServiceGetIndexStatistics.json", + "parameters": [ + { + "$id": "9656", + "parameter": { + "$ref": "9649" + }, + "value": { + "$id": "9657", + "kind": "string", + "type": { + "$ref": "9650" + }, + "value": "preview-test" + } + }, + { + "$id": "9658", + "parameter": { + "$ref": "9642" + }, + "value": { + "$id": "9659", + "kind": "string", + "type": { + "$ref": "9643" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "9660", + "parameter": { + "$ref": "9646" + }, + "value": { + "$id": "9661", + "kind": "string", + "type": { + "$ref": "9647" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "9662", + "response": { + "$ref": "9654" + }, + "statusCode": 200, + "bodyValue": { + "$id": "9663", + "kind": "model", + "type": { + "$ref": "4253" + }, + "value": { + "$id": "9664", + "documentCount": { + "$id": "9665", + "kind": "number", + "type": { + "$ref": "4255" + }, + "value": 12 + }, + "storageSize": { + "$id": "9666", + "kind": "number", + "type": { + "$ref": "4259" + }, + "value": 123456 + }, + "vectorIndexSize": { + "$id": "9667", + "kind": "number", + "type": { + "$ref": "4263" + }, + "value": 123456 + } + } + } + } + ] + } + ] + }, + { + "$id": "9668", + "name": "analyze", + "resourceName": "Indexes", + "doc": "Shows how an analyzer breaks text into tokens.", + "accessibility": "public", + "parameters": [ + { + "$id": "9669", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "9670", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "9671", + "type": { + "$id": "9672", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9673", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "9674", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "9675", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9676", + "name": "indexName", + "nameInRequest": "indexName", + "doc": "The name of the index.", + "type": { + "$id": "9677", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9678", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "9679", + "kind": "constant", + "valueType": { + "$id": "9680", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9681", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "9682", + "kind": "constant", + "valueType": { + "$id": "9683", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9684", + "name": "request", + "nameInRequest": "request", + "doc": "The text and analyzer or analysis components to test.", + "type": { + "$ref": "4266" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "9685", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "4288" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "POST", + "uri": "{endpoint}", + "path": "/indexes('{indexName}')/search.analyze", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Indexes.analyze", + "decorators": [], + "examples": [ + { + "$id": "9686", + "kind": "http", + "name": "SearchServiceIndexAnalyze", + "description": "SearchServiceIndexAnalyze", + "filePath": "2025-03-01-preview/SearchServiceIndexAnalyze.json", + "parameters": [ + { + "$id": "9687", + "parameter": { + "$ref": "9676" + }, + "value": { + "$id": "9688", + "kind": "string", + "type": { + "$ref": "9677" + }, + "value": "preview-test" + } + }, + { + "$id": "9689", + "parameter": { + "$ref": "9669" + }, + "value": { + "$id": "9690", + "kind": "string", + "type": { + "$ref": "9670" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "9691", + "parameter": { + "$ref": "9673" + }, + "value": { + "$id": "9692", + "kind": "string", + "type": { + "$ref": "9674" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "9693", + "parameter": { + "$ref": "9684" + }, + "value": { + "$id": "9694", + "kind": "model", + "type": { + "$ref": "4266" + }, + "value": { + "$id": "9695", + "text": { + "$id": "9696", + "kind": "string", + "type": { + "$ref": "4268" + }, + "value": "Text to analyze" + }, + "analyzer": { + "$id": "9697", + "kind": "string", + "type": { + "$ref": "310" + }, + "value": "ar.lucene" + } + } + } + } + ], + "responses": [ + { + "$id": "9698", + "response": { + "$ref": "9685" + }, + "statusCode": 200, + "bodyValue": { + "$id": "9699", + "kind": "model", + "type": { + "$ref": "4288" + }, + "value": { + "$id": "9700", + "tokens": { + "$id": "9701", + "kind": "array", + "type": { + "$ref": "4290" + }, + "value": [ + { + "$id": "9702", + "kind": "model", + "type": { + "$ref": "4291" + }, + "value": { + "$id": "9703", + "token": { + "$id": "9704", + "kind": "string", + "type": { + "$ref": "4293" + }, + "value": "text" + }, + "startOffset": { + "$id": "9705", + "kind": "number", + "type": { + "$ref": "4297" + }, + "value": 0 + }, + "endOffset": { + "$id": "9706", + "kind": "number", + "type": { + "$ref": "4301" + }, + "value": 4 + }, + "position": { + "$id": "9707", + "kind": "number", + "type": { + "$ref": "4305" + }, + "value": 0 + } + } + }, + { + "$id": "9708", + "kind": "model", + "type": { + "$ref": "4291" + }, + "value": { + "$id": "9709", + "token": { + "$id": "9710", + "kind": "string", + "type": { + "$ref": "4293" + }, + "value": "to" + }, + "startOffset": { + "$id": "9711", + "kind": "number", + "type": { + "$ref": "4297" + }, + "value": 5 + }, + "endOffset": { + "$id": "9712", + "kind": "number", + "type": { + "$ref": "4301" + }, + "value": 7 + }, + "position": { + "$id": "9713", + "kind": "number", + "type": { + "$ref": "4305" + }, + "value": 1 + } + } + }, + { + "$id": "9714", + "kind": "model", + "type": { + "$ref": "4291" + }, + "value": { + "$id": "9715", + "token": { + "$id": "9716", + "kind": "string", + "type": { + "$ref": "4293" + }, + "value": "analyze" + }, + "startOffset": { + "$id": "9717", + "kind": "number", + "type": { + "$ref": "4297" + }, + "value": 8 + }, + "endOffset": { + "$id": "9718", + "kind": "number", + "type": { + "$ref": "4301" + }, + "value": 15 + }, + "position": { + "$id": "9719", + "kind": "number", + "type": { + "$ref": "4305" + }, + "value": 2 + } + } + } + ] + } + } + } + } + ] + } + ] + } + ], + "parameters": [ + { + "$id": "9720", + "name": "endpoint", + "nameInRequest": "endpoint", + "doc": "Service host", + "type": { + "$id": "9721", + "kind": "url", + "name": "url", + "crossLanguageDefinitionId": "TypeSpec.url" + }, + "location": "Uri", + "isApiVersion": false, + "isContentType": false, + "isRequired": true, + "isEndpoint": true, + "skipUrlEncoding": false, + "explode": false, + "kind": "Client" + } + ], + "decorators": [], + "crossLanguageDefinitionId": "Search.Indexes", + "apiVersions": [ + "2024-07-01", + "2025-03-01-preview" + ], + "parent": { + "$ref": "5531" + } + }, + { + "$id": "9722", + "kind": "client", + "name": "Aliases", + "namespace": "Azure.Search.Documents", + "operations": [ + { + "$id": "9723", + "name": "create", + "resourceName": "Aliases", + "doc": "Creates a new search alias.", + "accessibility": "public", + "parameters": [ + { + "$id": "9724", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "9725", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "9726", + "type": { + "$id": "9727", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9728", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "9729", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "9730", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9731", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "9732", + "kind": "constant", + "valueType": { + "$id": "9733", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9734", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "9735", + "kind": "constant", + "valueType": { + "$id": "9736", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9737", + "name": "alias", + "nameInRequest": "alias", + "doc": "The definition of the alias to create.", + "type": { + "$ref": "2901" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "9738", + "statusCodes": [ + 201 + ], + "bodyType": { + "$ref": "2901" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "POST", + "uri": "{endpoint}", + "path": "/aliases", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Aliases.create", + "decorators": [], + "examples": [ + { + "$id": "9739", + "kind": "http", + "name": "SearchServiceCreateAlias", + "description": "SearchServiceCreateAlias", + "filePath": "2025-03-01-preview/SearchServiceCreateAlias.json", + "parameters": [ + { + "$id": "9740", + "parameter": { + "$ref": "9724" + }, + "value": { + "$id": "9741", + "kind": "string", + "type": { + "$ref": "9725" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "9742", + "parameter": { + "$ref": "9728" + }, + "value": { + "$id": "9743", + "kind": "string", + "type": { + "$ref": "9729" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "9744", + "parameter": { + "$ref": "9737" + }, + "value": { + "$id": "9745", + "kind": "model", + "type": { + "$ref": "2901" + }, + "value": { + "$id": "9746", + "name": { + "$id": "9747", + "kind": "string", + "type": { + "$ref": "2903" + }, + "value": "tempalias" + }, + "indexes": { + "$id": "9748", + "kind": "array", + "type": { + "$ref": "2907" + }, + "value": [ + { + "$id": "9749", + "kind": "string", + "type": { + "$ref": "2908" + }, + "value": "preview-test" + } + ] + }, + "@odata.etag": { + "$id": "9750", + "kind": "string", + "type": { + "$ref": "2912" + }, + "value": "0x1234568AE7E58A1" + } + } + } + } + ], + "responses": [ + { + "$id": "9751", + "response": { + "$ref": "9738" + }, + "statusCode": 201, + "bodyValue": { + "$id": "9752", + "kind": "model", + "type": { + "$ref": "2901" + }, + "value": { + "$id": "9753", + "name": { + "$id": "9754", + "kind": "string", + "type": { + "$ref": "2903" + }, + "value": "tempalias" + }, + "indexes": { + "$id": "9755", + "kind": "array", + "type": { + "$ref": "2907" + }, + "value": [ + { + "$id": "9756", + "kind": "string", + "type": { + "$ref": "2908" + }, + "value": "preview-test" + } + ] + } + } + } + } + ] + } + ] + }, + { + "$id": "9757", + "name": "list", + "resourceName": "Aliases", + "doc": "Lists all aliases available for a search service.", + "accessibility": "public", + "parameters": [ + { + "$id": "9758", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "9759", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "9760", + "type": { + "$id": "9761", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9762", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "9763", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "9764", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9765", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "9766", + "kind": "constant", + "valueType": { + "$id": "9767", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "9768", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "2915" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/aliases", + "bufferResponse": true, + "paging": { + "$id": "9769", + "itemPropertySegments": [ + "aliases" + ] + }, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Aliases.list", + "decorators": [], + "examples": [ + { + "$id": "9770", + "kind": "http", + "name": "SearchServiceListAliases", + "description": "SearchServiceListAliases", + "filePath": "2025-03-01-preview/SearchServiceListAliases.json", + "parameters": [ + { + "$id": "9771", + "parameter": { + "$ref": "9758" + }, + "value": { + "$id": "9772", + "kind": "string", + "type": { + "$ref": "9759" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "9773", + "parameter": { + "$ref": "9762" + }, + "value": { + "$id": "9774", + "kind": "string", + "type": { + "$ref": "9763" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "9775", + "response": { + "$ref": "9768" + }, + "statusCode": 200, + "bodyValue": { + "$id": "9776", + "kind": "model", + "type": { + "$ref": "2915" + }, + "value": { + "$id": "9777", + "value": { + "$id": "9778", + "kind": "array", + "type": { + "$ref": "2917" + }, + "value": [ + { + "$id": "9779", + "kind": "model", + "type": { + "$ref": "2901" + }, + "value": { + "$id": "9780", + "name": { + "$id": "9781", + "kind": "string", + "type": { + "$ref": "2903" + }, + "value": "myalias" + }, + "indexes": { + "$id": "9782", + "kind": "array", + "type": { + "$ref": "2907" + }, + "value": [ + { + "$id": "9783", + "kind": "string", + "type": { + "$ref": "2908" + }, + "value": "preview-test" + } + ] + } + } + } + ] + } + } + } + } + ] + } + ] + }, + { + "$id": "9784", + "name": "createOrUpdate", + "resourceName": "Aliases", + "doc": "Creates a new search alias or updates an alias if it already exists.", + "accessibility": "public", + "parameters": [ + { + "$id": "9785", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "9786", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "9787", + "type": { + "$id": "9788", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9789", + "name": "ifMatch", + "nameInRequest": "If-Match", + "doc": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "type": { + "$id": "9790", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9791", + "name": "ifNoneMatch", + "nameInRequest": "If-None-Match", + "doc": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "type": { + "$id": "9792", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9793", + "name": "prefer", + "nameInRequest": "Prefer", + "doc": "For HTTP PUT requests, instructs the service to return the created/updated resource on success.", + "type": { + "$id": "9794", + "kind": "constant", + "valueType": { + "$id": "9795", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "return=representation", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9796", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "9797", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "9798", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9799", + "name": "aliasName", + "nameInRequest": "aliasName", + "doc": "The name of the alias.", + "type": { + "$id": "9800", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9801", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "9802", + "kind": "constant", + "valueType": { + "$id": "9803", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9804", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "9805", + "kind": "constant", + "valueType": { + "$id": "9806", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9807", + "name": "alias", + "nameInRequest": "alias", + "doc": "The definition of the alias to create or update.", + "type": { + "$ref": "2901" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "9808", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "2901" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + }, + { + "$id": "9809", + "statusCodes": [ + 201 + ], + "bodyType": { + "$ref": "2901" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "PUT", + "uri": "{endpoint}", + "path": "/aliases('{aliasName}')", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Aliases.createOrUpdate", + "decorators": [], + "examples": [ + { + "$id": "9810", + "kind": "http", + "name": "SearchServiceCreateOrUpdateAlias", + "description": "SearchServiceCreateOrUpdateAlias", + "filePath": "2025-03-01-preview/SearchServiceCreateOrUpdateAlias.json", + "parameters": [ + { + "$id": "9811", + "parameter": { + "$ref": "9799" + }, + "value": { + "$id": "9812", + "kind": "string", + "type": { + "$ref": "9800" + }, + "value": "myalias" + } + }, + { + "$id": "9813", + "parameter": { + "$ref": "9785" + }, + "value": { + "$id": "9814", + "kind": "string", + "type": { + "$ref": "9786" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "9815", + "parameter": { + "$ref": "9796" + }, + "value": { + "$id": "9816", + "kind": "string", + "type": { + "$ref": "9797" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "9817", + "parameter": { + "$ref": "9793" + }, + "value": { + "$id": "9818", + "kind": "string", + "type": { + "$ref": "9794" + }, + "value": "return=representation" + } + }, + { + "$id": "9819", + "parameter": { + "$ref": "9807" + }, + "value": { + "$id": "9820", + "kind": "model", + "type": { + "$ref": "2901" + }, + "value": { + "$id": "9821", + "name": { + "$id": "9822", + "kind": "string", + "type": { + "$ref": "2903" + }, + "value": "myalias" + }, + "indexes": { + "$id": "9823", + "kind": "array", + "type": { + "$ref": "2907" + }, + "value": [ + { + "$id": "9824", + "kind": "string", + "type": { + "$ref": "2908" + }, + "value": "preview-test" + } + ] + }, + "@odata.etag": { + "$id": "9825", + "kind": "string", + "type": { + "$ref": "2912" + }, + "value": "0x1234568AE7E58A1" + } + } + } + } + ], + "responses": [ + { + "$id": "9826", + "response": { + "$ref": "9808" + }, + "statusCode": 200, + "bodyValue": { + "$id": "9827", + "kind": "model", + "type": { + "$ref": "2901" + }, + "value": { + "$id": "9828", + "name": { + "$id": "9829", + "kind": "string", + "type": { + "$ref": "2903" + }, + "value": "myalias" + }, + "indexes": { + "$id": "9830", + "kind": "array", + "type": { + "$ref": "2907" + }, + "value": [ + { + "$id": "9831", + "kind": "string", + "type": { + "$ref": "2908" + }, + "value": "preview-test" + } + ] + } + } + } + }, + { + "$id": "9832", + "response": { + "$ref": "9809" + }, + "statusCode": 201, + "bodyValue": { + "$id": "9833", + "kind": "model", + "type": { + "$ref": "2901" + }, + "value": { + "$id": "9834", + "name": { + "$id": "9835", + "kind": "string", + "type": { + "$ref": "2903" + }, + "value": "myalias" + }, + "indexes": { + "$id": "9836", + "kind": "array", + "type": { + "$ref": "2907" + }, + "value": [ + { + "$id": "9837", + "kind": "string", + "type": { + "$ref": "2908" + }, + "value": "preview-test" + } + ] + } + } + } + } + ] + } + ] + }, + { + "$id": "9838", + "name": "delete", + "resourceName": "Aliases", + "doc": "Deletes a search alias and its associated mapping to an index. This operation\nis permanent, with no recovery option. The mapped index is untouched by this\noperation.", + "accessibility": "public", + "parameters": [ + { + "$id": "9839", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "9840", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "9841", + "type": { + "$id": "9842", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9843", + "name": "ifMatch", + "nameInRequest": "If-Match", + "doc": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "type": { + "$id": "9844", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9845", + "name": "ifNoneMatch", + "nameInRequest": "If-None-Match", + "doc": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "type": { + "$id": "9846", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9847", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "9848", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "9849", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9850", + "name": "aliasName", + "nameInRequest": "aliasName", + "doc": "The name of the alias.", + "type": { + "$id": "9851", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9852", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "9853", + "kind": "constant", + "valueType": { + "$id": "9854", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "9855", + "statusCodes": [ + 204 + ], + "headers": [], + "isErrorResponse": false + }, + { + "$id": "9856", + "statusCodes": [ + 404 + ], + "headers": [], + "isErrorResponse": false + } + ], + "httpMethod": "DELETE", + "uri": "{endpoint}", + "path": "/aliases('{aliasName}')", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Aliases.delete", + "decorators": [], + "examples": [ + { + "$id": "9857", + "kind": "http", + "name": "SearchServiceDeleteAlias", + "description": "SearchServiceDeleteAlias", + "filePath": "2025-03-01-preview/SearchServiceDeleteAlias.json", + "parameters": [ + { + "$id": "9858", + "parameter": { + "$ref": "9850" + }, + "value": { + "$id": "9859", + "kind": "string", + "type": { + "$ref": "9851" + }, + "value": "tempalias" + } + }, + { + "$id": "9860", + "parameter": { + "$ref": "9839" + }, + "value": { + "$id": "9861", + "kind": "string", + "type": { + "$ref": "9840" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "9862", + "parameter": { + "$ref": "9847" + }, + "value": { + "$id": "9863", + "kind": "string", + "type": { + "$ref": "9848" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "9864", + "response": { + "$ref": "9855" + }, + "statusCode": 204 + }, + { + "$id": "9865", + "response": { + "$ref": "9856" + }, + "statusCode": 404 + } + ] + } + ] + }, + { + "$id": "9866", + "name": "get", + "resourceName": "Aliases", + "doc": "Retrieves an alias definition.", + "accessibility": "public", + "parameters": [ + { + "$id": "9867", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "9868", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "9869", + "type": { + "$id": "9870", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9871", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "9872", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "9873", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9874", + "name": "aliasName", + "nameInRequest": "aliasName", + "doc": "The name of the alias.", + "type": { + "$id": "9875", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9876", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "9877", + "kind": "constant", + "valueType": { + "$id": "9878", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "9879", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "2901" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/aliases('{aliasName}')", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Aliases.get", + "decorators": [], + "examples": [ + { + "$id": "9880", + "kind": "http", + "name": "SearchServiceGetAlias", + "description": "SearchServiceGetAlias", + "filePath": "2025-03-01-preview/SearchServiceGetAlias.json", + "parameters": [ + { + "$id": "9881", + "parameter": { + "$ref": "9874" + }, + "value": { + "$id": "9882", + "kind": "string", + "type": { + "$ref": "9875" + }, + "value": "myalias" + } + }, + { + "$id": "9883", + "parameter": { + "$ref": "9867" + }, + "value": { + "$id": "9884", + "kind": "string", + "type": { + "$ref": "9868" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "9885", + "parameter": { + "$ref": "9871" + }, + "value": { + "$id": "9886", + "kind": "string", + "type": { + "$ref": "9872" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "9887", + "response": { + "$ref": "9879" + }, + "statusCode": 200, + "bodyValue": { + "$id": "9888", + "kind": "model", + "type": { + "$ref": "2901" + }, + "value": { + "$id": "9889", + "name": { + "$id": "9890", + "kind": "string", + "type": { + "$ref": "2903" + }, + "value": "myalias" + }, + "indexes": { + "$id": "9891", + "kind": "array", + "type": { + "$ref": "2907" + }, + "value": [ + { + "$id": "9892", + "kind": "string", + "type": { + "$ref": "2908" + }, + "value": "preview-test" + } + ] + } + } + } + } + ] + } + ] + } + ], + "parameters": [ + { + "$id": "9893", + "name": "endpoint", + "nameInRequest": "endpoint", + "doc": "Service host", + "type": { + "$id": "9894", + "kind": "url", + "name": "url", + "crossLanguageDefinitionId": "TypeSpec.url" + }, + "location": "Uri", + "isApiVersion": false, + "isContentType": false, + "isRequired": true, + "isEndpoint": true, + "skipUrlEncoding": false, + "explode": false, + "kind": "Client" + } + ], + "decorators": [], + "crossLanguageDefinitionId": "Search.Aliases", + "apiVersions": [ + "2025-03-01-preview" + ], + "parent": { + "$ref": "5531" + } + }, + { + "$id": "9895", + "kind": "client", + "name": "Documents", + "namespace": "Azure.Search.Documents", + "operations": [ + { + "$id": "9896", + "name": "count", + "resourceName": "Documents", + "doc": "Queries the number of documents in the index.", + "accessibility": "public", + "parameters": [ + { + "$id": "9897", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "9898", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "9899", + "type": { + "$id": "9900", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9901", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "9902", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "9903", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9904", + "name": "indexName", + "nameInRequest": "indexName", + "doc": "The name of the index.", + "type": { + "$id": "9905", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9906", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "9907", + "kind": "constant", + "valueType": { + "$id": "9908", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "text/plain", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "9909", + "statusCodes": [ + 200 + ], + "bodyType": { + "$id": "9910", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "text/plain" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/indexes('{indexName}')/docs/$count", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Documents.count", + "decorators": [], + "examples": [ + { + "$id": "9911", + "kind": "http", + "name": "SearchIndexCountDocuments", + "description": "SearchIndexCountDocuments", + "filePath": "2025-03-01-preview/SearchIndexCountDocuments.json", + "parameters": [ + { + "$id": "9912", + "parameter": { + "$ref": "9904" + }, + "value": { + "$id": "9913", + "kind": "string", + "type": { + "$ref": "9905" + }, + "value": "preview-test" + } + }, + { + "$id": "9914", + "parameter": { + "$ref": "9897" + }, + "value": { + "$id": "9915", + "kind": "string", + "type": { + "$ref": "9898" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "9916", + "parameter": { + "$ref": "9901" + }, + "value": { + "$id": "9917", + "kind": "string", + "type": { + "$ref": "9902" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "9918", + "response": { + "$ref": "9909" + }, + "statusCode": 200, + "bodyValue": { + "$id": "9919", + "kind": "number", + "type": { + "$ref": "9910" + }, + "value": 50 + } + } + ] + } + ] + }, + { + "$id": "9920", + "name": "searchGet", + "resourceName": "Documents", + "doc": "Searches for documents in the index.", + "accessibility": "public", + "parameters": [ + { + "$id": "9921", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "9922", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "9923", + "type": { + "$id": "9924", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9925", + "name": "searchText", + "nameInRequest": "search", + "doc": "A full-text search query expression; Use \"*\" or omit this parameter to match\nall documents.", + "type": { + "$id": "9926", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9927", + "name": "includeTotalResultCount", + "nameInRequest": "$count", + "doc": "A value that specifies whether to fetch the total count of results. Default is\nfalse. Setting this value to true may have a performance impact. Note that the\ncount returned is an approximation.", + "type": { + "$id": "9928", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9929", + "name": "facets", + "nameInRequest": "facet", + "doc": "The list of facet expressions to apply to the search query. Each facet\nexpression contains a field name, optionally followed by a comma-separated list\nof name:value pairs.", + "type": { + "$id": "9930", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "9931", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": true, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9932", + "name": "$filter", + "nameInRequest": "$filter", + "doc": "The OData $filter expression to apply to the search query.", + "type": { + "$id": "9933", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9934", + "name": "highlightFields", + "nameInRequest": "highlight", + "doc": "The list of field names to use for hit highlights. Only searchable fields can\nbe used for hit highlighting.", + "type": { + "$id": "9935", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "9936", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "arraySerializationDelimiter": ",", + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9937", + "name": "highlightPostTag", + "nameInRequest": "highlightPostTag", + "doc": "A string tag that is appended to hit highlights. Must be set with\nhighlightPreTag. Default is </em>.", + "type": { + "$id": "9938", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9939", + "name": "highlightPreTag", + "nameInRequest": "highlightPreTag", + "doc": "A string tag that is prepended to hit highlights. Must be set with\nhighlightPostTag. Default is <em>.", + "type": { + "$id": "9940", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9941", + "name": "minimumCoverage", + "nameInRequest": "minimumCoverage", + "doc": "A number between 0 and 100 indicating the percentage of the index that must be\ncovered by a search query in order for the query to be reported as a success.\nThis parameter can be useful for ensuring search availability even for services\nwith only one replica. The default is 100.", + "type": { + "$id": "9942", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9943", + "name": "orderBy", + "nameInRequest": "$orderby", + "doc": "The list of OData $orderby expressions by which to sort the results. Each\nexpression can be either a field name or a call to either the geo.distance() or\nthe search.score() functions. Each expression can be followed by asc to\nindicate ascending, and desc to indicate descending. The default is ascending\norder. Ties will be broken by the match scores of documents. If no OrderBy is\nspecified, the default sort order is descending by document match score. There\ncan be at most 32 $orderby clauses.", + "type": { + "$id": "9944", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "9945", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "arraySerializationDelimiter": ",", + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9946", + "name": "queryType", + "nameInRequest": "queryType", + "doc": "A value that specifies the syntax of the search query. The default is 'simple'.\nUse 'full' if your query uses the Lucene query syntax.", + "type": { + "$ref": "2" + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9947", + "name": "scoringParameters", + "nameInRequest": "scoringParameter", + "doc": "The list of parameter values to be used in scoring functions (for example,\nreferencePointParameter) using the format name-values. For example, if the\nscoring profile defines a function with a parameter called 'mylocation' the\nparameter string would be \"mylocation--122.2,44.8\" (without the quotes).", + "type": { + "$id": "9948", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "9949", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": true, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9950", + "name": "scoringProfile", + "nameInRequest": "scoringProfile", + "doc": "The name of a scoring profile to evaluate match scores for matching documents\nin order to sort the results.", + "type": { + "$id": "9951", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9952", + "name": "searchFields", + "nameInRequest": "searchFields", + "doc": "The list of field names to which to scope the full-text search. When using\nfielded search (fieldName:searchExpression) in a full Lucene query, the field\nnames of each fielded search expression take precedence over any field names\nlisted in this parameter.", + "type": { + "$id": "9953", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "9954", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "arraySerializationDelimiter": ",", + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9955", + "name": "searchMode", + "nameInRequest": "searchMode", + "doc": "A value that specifies whether any or all of the search terms must be matched\nin order to count the document as a match.", + "type": { + "$ref": "10" + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9956", + "name": "scoringStatistics", + "nameInRequest": "scoringStatistics", + "doc": "A value that specifies whether we want to calculate scoring statistics (such as\ndocument frequency) globally for more consistent scoring, or locally, for lower\nlatency.", + "type": { + "$ref": "16" + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9957", + "name": "sessionId", + "nameInRequest": "sessionId", + "doc": "A value to be used to create a sticky session, which can help to get more\nconsistent results. As long as the same sessionId is used, a best-effort\nattempt will be made to target the same replica set. Be wary that reusing the\nsame sessionID values repeatedly can interfere with the load balancing of the\nrequests across replicas and adversely affect the performance of the search\nservice. The value used as sessionId cannot start with a '_' character.", + "type": { + "$id": "9958", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9959", + "name": "$select", + "nameInRequest": "$select", + "doc": "The list of fields to retrieve. If unspecified, all fields marked as\nretrievable in the schema are included.", + "type": { + "$id": "9960", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "9961", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "arraySerializationDelimiter": ",", + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9962", + "name": "$skip", + "nameInRequest": "$skip", + "doc": "The number of search results to skip. This value cannot be greater than\n100,000. If you need to scan documents in sequence, but cannot use $skip due to\nthis limitation, consider using $orderby on a totally-ordered key and $filter\nwith a range query instead.", + "type": { + "$id": "9963", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9964", + "name": "$top", + "nameInRequest": "$top", + "doc": "The number of search results to retrieve. This can be used in conjunction with\n$skip to implement client-side paging of search results. If results are\ntruncated due to server-side paging, the response will include a continuation\ntoken that can be used to issue another Search request for the next page of\nresults.", + "type": { + "$id": "9965", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9966", + "name": "semanticConfiguration", + "nameInRequest": "semanticConfiguration", + "doc": "The name of the semantic configuration that lists which fields should be used\nfor semantic ranking, captions, highlights, and answers", + "type": { + "$id": "9967", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9968", + "name": "semanticErrorHandling", + "nameInRequest": "semanticErrorHandling", + "doc": "Allows the user to choose whether a semantic call should fail completely, or to\nreturn partial results (default).", + "type": { + "$ref": "22" + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9969", + "name": "semanticMaxWaitInMilliseconds", + "nameInRequest": "semanticMaxWaitInMilliseconds", + "doc": "Allows the user to set an upper bound on the amount of time it takes for\nsemantic enrichment to finish processing before the request fails.", + "type": { + "$id": "9970", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9971", + "name": "answers", + "nameInRequest": "answers", + "doc": "This parameter is only valid if the query type is `semantic`. If set, the query\nreturns answers extracted from key passages in the highest ranked documents.\nThe number of answers returned can be configured by appending the pipe\ncharacter `|` followed by the `count-` option after the\nanswers parameter value, such as `extractive|count-3`. Default count is 1. The\nconfidence threshold can be configured by appending the pipe character `|`\nfollowed by the `threshold-` option after the answers\nparameter value, such as `extractive|threshold-0.9`. Default threshold is 0.7.\nThe maximum character length of answers can be configured by appending the pipe\ncharacter '|' followed by the 'count-',\nsuch as 'extractive|maxcharlength-600'.", + "type": { + "$ref": "28" + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9972", + "name": "captions", + "nameInRequest": "captions", + "doc": "This parameter is only valid if the query type is `semantic`. If set, the query\nreturns captions extracted from key passages in the highest ranked documents.\nWhen Captions is set to `extractive`, highlighting is enabled by default, and\ncan be configured by appending the pipe character `|` followed by the\n`highlight-` option, such as `extractive|highlight-true`. Defaults\nto `None`. The maximum character length of captions can be configured by\nappending the pipe character '|' followed by the 'count-', such as 'extractive|maxcharlength-600'.", + "type": { + "$ref": "34" + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9973", + "name": "semanticQuery", + "nameInRequest": "semanticQuery", + "doc": "Allows setting a separate search query that will be solely used for semantic\nreranking, semantic captions and semantic answers. Is useful for scenarios\nwhere there is a need to use different queries between the base retrieval and\nranking phase, and the L2 semantic phase.", + "type": { + "$id": "9974", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9975", + "name": "queryRewrites", + "nameInRequest": "queryRewrites", + "doc": "When QueryRewrites is set to `generative`, the query terms are sent to a\ngenerate model which will produce 10 (default) rewrites to help increase the\nrecall of the request. The requested count can be configured by appending the\npipe character `|` followed by the `count-` option, such as\n`generative|count-3`. Defaults to `None`. This parameter is only valid if the\nquery type is `semantic`.", + "type": { + "$ref": "40" + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9976", + "name": "debug", + "nameInRequest": "debug", + "doc": "Enables a debugging tool that can be used to further explore your search\nresults.", + "type": { + "$ref": "46" + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9977", + "name": "queryLanguage", + "nameInRequest": "queryLanguage", + "doc": "The language of the query.", + "type": { + "$ref": "58" + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9978", + "name": "speller", + "nameInRequest": "speller", + "doc": "Improve search recall by spell-correcting individual search query terms.", + "type": { + "$ref": "204" + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9979", + "name": "semanticFields", + "nameInRequest": "semanticFields", + "doc": "The list of field names used for semantic ranking.", + "type": { + "$id": "9980", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "9981", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "arraySerializationDelimiter": ",", + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9982", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "9983", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "9984", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9985", + "name": "indexName", + "nameInRequest": "indexName", + "doc": "The name of the index.", + "type": { + "$id": "9986", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "9987", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "9988", + "kind": "constant", + "valueType": { + "$id": "9989", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "9990", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "2309" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/indexes('{indexName}')/docs", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Documents.searchGet", + "decorators": [], + "examples": [ + { + "$id": "9991", + "kind": "http", + "name": "SearchIndexSearchDocumentsGet", + "description": "SearchIndexSearchDocumentsGet", + "filePath": "2025-03-01-preview/SearchIndexSearchDocumentsGet.json", + "parameters": [ + { + "$id": "9992", + "parameter": { + "$ref": "9985" + }, + "value": { + "$id": "9993", + "kind": "string", + "type": { + "$ref": "9986" + }, + "value": "myindex" + } + }, + { + "$id": "9994", + "parameter": { + "$ref": "9921" + }, + "value": { + "$id": "9995", + "kind": "string", + "type": { + "$ref": "9922" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "9996", + "parameter": { + "$ref": "9927" + }, + "value": { + "$id": "9997", + "kind": "boolean", + "type": { + "$ref": "9928" + }, + "value": true + } + }, + { + "$id": "9998", + "parameter": { + "$ref": "9929" + }, + "value": { + "$id": "9999", + "kind": "array", + "type": { + "$ref": "9930" + }, + "value": [ + { + "$id": "10000", + "kind": "string", + "type": { + "$ref": "9931" + }, + "value": "category,count:10,sort:count" + } + ] + } + }, + { + "$id": "10001", + "parameter": { + "$ref": "9932" + }, + "value": { + "$id": "10002", + "kind": "string", + "type": { + "$ref": "9933" + }, + "value": "rating gt 10" + } + }, + { + "$id": "10003", + "parameter": { + "$ref": "9934" + }, + "value": { + "$id": "10004", + "kind": "array", + "type": { + "$ref": "9935" + }, + "value": [ + { + "$id": "10005", + "kind": "string", + "type": { + "$ref": "9936" + }, + "value": "title" + } + ] + } + }, + { + "$id": "10006", + "parameter": { + "$ref": "9937" + }, + "value": { + "$id": "10007", + "kind": "string", + "type": { + "$ref": "9938" + }, + "value": "" + } + }, + { + "$id": "10008", + "parameter": { + "$ref": "9939" + }, + "value": { + "$id": "10009", + "kind": "string", + "type": { + "$ref": "9940" + }, + "value": "" + } + }, + { + "$id": "10010", + "parameter": { + "$ref": "9941" + }, + "value": { + "$id": "10011", + "kind": "number", + "type": { + "$ref": "9942" + }, + "value": 80 + } + }, + { + "$id": "10012", + "parameter": { + "$ref": "9943" + }, + "value": { + "$id": "10013", + "kind": "array", + "type": { + "$ref": "9944" + }, + "value": [ + { + "$id": "10014", + "kind": "string", + "type": { + "$ref": "9945" + }, + "value": "search.score() desc" + }, + { + "$id": "10015", + "kind": "string", + "type": { + "$ref": "9945" + }, + "value": "rating desc" + } + ] + } + }, + { + "$id": "10016", + "parameter": { + "$ref": "9946" + }, + "value": { + "$id": "10017", + "kind": "string", + "type": { + "$ref": "2" + }, + "value": "simple" + } + }, + { + "$id": "10018", + "parameter": { + "$ref": "9957" + }, + "value": { + "$id": "10019", + "kind": "string", + "type": { + "$ref": "9958" + }, + "value": "mysessionid" + } + }, + { + "$id": "10020", + "parameter": { + "$ref": "9956" + }, + "value": { + "$id": "10021", + "kind": "string", + "type": { + "$ref": "16" + }, + "value": "global" + } + }, + { + "$id": "10022", + "parameter": { + "$ref": "9950" + }, + "value": { + "$id": "10023", + "kind": "string", + "type": { + "$ref": "9951" + }, + "value": "sp" + } + }, + { + "$id": "10024", + "parameter": { + "$ref": "9925" + }, + "value": { + "$id": "10025", + "kind": "string", + "type": { + "$ref": "9926" + }, + "value": "nice hotels" + } + }, + { + "$id": "10026", + "parameter": { + "$ref": "9952" + }, + "value": { + "$id": "10027", + "kind": "array", + "type": { + "$ref": "9953" + }, + "value": [ + { + "$id": "10028", + "kind": "string", + "type": { + "$ref": "9954" + }, + "value": "title" + }, + { + "$id": "10029", + "kind": "string", + "type": { + "$ref": "9954" + }, + "value": "description" + } + ] + } + }, + { + "$id": "10030", + "parameter": { + "$ref": "9955" + }, + "value": { + "$id": "10031", + "kind": "string", + "type": { + "$ref": "10" + }, + "value": "any" + } + }, + { + "$id": "10032", + "parameter": { + "$ref": "9959" + }, + "value": { + "$id": "10033", + "kind": "array", + "type": { + "$ref": "9960" + }, + "value": [ + { + "$id": "10034", + "kind": "string", + "type": { + "$ref": "9961" + }, + "value": "docId" + }, + { + "$id": "10035", + "kind": "string", + "type": { + "$ref": "9961" + }, + "value": "title" + }, + { + "$id": "10036", + "kind": "string", + "type": { + "$ref": "9961" + }, + "value": "description" + } + ] + } + }, + { + "$id": "10037", + "parameter": { + "$ref": "9962" + }, + "value": { + "$id": "10038", + "kind": "number", + "type": { + "$ref": "9963" + }, + "value": 100 + } + }, + { + "$id": "10039", + "parameter": { + "$ref": "9964" + }, + "value": { + "$id": "10040", + "kind": "number", + "type": { + "$ref": "9965" + }, + "value": 10 + } + } + ], + "responses": [ + { + "$id": "10041", + "response": { + "$ref": "9990" + }, + "statusCode": 200, + "bodyValue": { + "$id": "10042", + "kind": "model", + "type": { + "$ref": "2309" + }, + "value": { + "$id": "10043", + "@odata.count": { + "$id": "10044", + "kind": "number", + "type": { + "$ref": "2311" + }, + "value": 25 + }, + "@search.coverage": { + "$id": "10045", + "kind": "number", + "type": { + "$ref": "2315" + }, + "value": 80 + }, + "@search.facets": { + "$id": "10046", + "kind": "dict", + "type": { + "$ref": "2319" + }, + "value": { + "$id": "10047", + "category": { + "$id": "10048", + "kind": "array", + "type": { + "$ref": "2321" + }, + "value": [ + { + "$id": "10049", + "kind": "model", + "type": { + "$ref": "2322" + }, + "value": { + "$id": "10050", + "count": { + "$id": "10051", + "kind": "number", + "type": { + "$ref": "2325" + }, + "value": 1 + } + }, + "additionalPropertiesValue": { + "$id": "10052", + "value": { + "$id": "10053", + "kind": "unknown", + "type": { + "$ref": "2323" + }, + "value": "Economy" + } + } + }, + { + "$id": "10054", + "kind": "model", + "type": { + "$ref": "2322" + }, + "value": { + "$id": "10055", + "count": { + "$id": "10056", + "kind": "number", + "type": { + "$ref": "2325" + }, + "value": 1 + } + }, + "additionalPropertiesValue": { + "$id": "10057", + "value": { + "$id": "10058", + "kind": "unknown", + "type": { + "$ref": "2323" + }, + "value": "Luxury" + } + } + } + ] + } + } + }, + "value": { + "$id": "10059", + "kind": "array", + "type": { + "$ref": "2623" + }, + "value": [ + { + "$id": "10060", + "kind": "model", + "type": { + "$ref": "2624" + }, + "value": { + "$id": "10061", + "@search.score": { + "$id": "10062", + "kind": "number", + "type": { + "$ref": "2627" + }, + "value": 1.5 + }, + "@search.highlights": { + "$id": "10063", + "kind": "dict", + "type": { + "$ref": "2635" + }, + "value": { + "$id": "10064", + "title": { + "$id": "10065", + "kind": "array", + "type": { + "$ref": "2637" + }, + "value": [ + { + "$id": "10066", + "kind": "string", + "type": { + "$ref": "2638" + }, + "value": "Nice Hotel" + } + ] + } + } + } + }, + "additionalPropertiesValue": { + "$id": "10067", + "description": { + "$id": "10068", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "Cheapest hotel in town" + }, + "docId": { + "$id": "10069", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "1" + }, + "title": { + "$id": "10070", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "Nice Hotel" + } + } + }, + { + "$id": "10071", + "kind": "model", + "type": { + "$ref": "2624" + }, + "value": { + "$id": "10072", + "@search.score": { + "$id": "10073", + "kind": "number", + "type": { + "$ref": "2627" + }, + "value": 0.7 + }, + "@search.highlights": { + "$id": "10074", + "kind": "dict", + "type": { + "$ref": "2635" + }, + "value": { + "$id": "10075", + "title": { + "$id": "10076", + "kind": "array", + "type": { + "$ref": "2637" + }, + "value": [ + { + "$id": "10077", + "kind": "string", + "type": { + "$ref": "2638" + }, + "value": "Fancy Hotel" + } + ] + } + } + } + }, + "additionalPropertiesValue": { + "$id": "10078", + "description": { + "$id": "10079", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "Best hotel in town" + }, + "docId": { + "$id": "10080", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "2" + }, + "title": { + "$id": "10081", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "Fancy Hotel" + } + } + } + ] + } + } + } + } + ] + }, + { + "$id": "10082", + "kind": "http", + "name": "SearchIndexSearchDocumentsSemanticGet", + "description": "SearchIndexSearchDocumentsSemanticGet", + "filePath": "2025-03-01-preview/SearchIndexSearchDocumentsSemanticGet.json", + "parameters": [ + { + "$id": "10083", + "parameter": { + "$ref": "9985" + }, + "value": { + "$id": "10084", + "kind": "string", + "type": { + "$ref": "9986" + }, + "value": "myindex" + } + }, + { + "$id": "10085", + "parameter": { + "$ref": "9921" + }, + "value": { + "$id": "10086", + "kind": "string", + "type": { + "$ref": "9922" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "10087", + "parameter": { + "$ref": "9927" + }, + "value": { + "$id": "10088", + "kind": "boolean", + "type": { + "$ref": "9928" + }, + "value": true + } + }, + { + "$id": "10089", + "parameter": { + "$ref": "9937" + }, + "value": { + "$id": "10090", + "kind": "string", + "type": { + "$ref": "9938" + }, + "value": "" + } + }, + { + "$id": "10091", + "parameter": { + "$ref": "9939" + }, + "value": { + "$id": "10092", + "kind": "string", + "type": { + "$ref": "9940" + }, + "value": "" + } + }, + { + "$id": "10093", + "parameter": { + "$ref": "9946" + }, + "value": { + "$id": "10094", + "kind": "string", + "type": { + "$ref": "2" + }, + "value": "semantic" + } + }, + { + "$id": "10095", + "parameter": { + "$ref": "9925" + }, + "value": { + "$id": "10096", + "kind": "string", + "type": { + "$ref": "9926" + }, + "value": "how do clouds form" + } + }, + { + "$id": "10097", + "parameter": { + "$ref": "9966" + }, + "value": { + "$id": "10098", + "kind": "string", + "type": { + "$ref": "9967" + }, + "value": "my-semantic-config" + } + }, + { + "$id": "10099", + "parameter": { + "$ref": "9971" + }, + "value": { + "$id": "10100", + "kind": "string", + "type": { + "$ref": "28" + }, + "value": "extractive|count-3" + } + }, + { + "$id": "10101", + "parameter": { + "$ref": "9972" + }, + "value": { + "$id": "10102", + "kind": "string", + "type": { + "$ref": "34" + }, + "value": "extractive|highlight-true" + } + }, + { + "$id": "10103", + "parameter": { + "$ref": "9968" + }, + "value": { + "$id": "10104", + "kind": "string", + "type": { + "$ref": "22" + }, + "value": "partial" + } + }, + { + "$id": "10105", + "parameter": { + "$ref": "9969" + }, + "value": { + "$id": "10106", + "kind": "number", + "type": { + "$ref": "9970" + }, + "value": 780 + } + } + ], + "responses": [ + { + "$id": "10107", + "response": { + "$ref": "9990" + }, + "statusCode": 200, + "bodyValue": { + "$id": "10108", + "kind": "model", + "type": { + "$ref": "2309" + }, + "value": { + "$id": "10109", + "@odata.count": { + "$id": "10110", + "kind": "number", + "type": { + "$ref": "2311" + }, + "value": 25 + }, + "@search.answers": { + "$id": "10111", + "kind": "array", + "type": { + "$ref": "2341" + }, + "value": [ + { + "$id": "10112", + "kind": "model", + "type": { + "$ref": "2342" + }, + "value": { + "$id": "10113", + "key": { + "$id": "10114", + "kind": "string", + "type": { + "$ref": "2349" + }, + "value": "4123" + }, + "text": { + "$id": "10115", + "kind": "string", + "type": { + "$ref": "2353" + }, + "value": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case), but not where it is descending (over the river)." + }, + "highlights": { + "$id": "10116", + "kind": "string", + "type": { + "$ref": "2357" + }, + "value": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case), but not where it is descending (over the river)." + }, + "score": { + "$id": "10117", + "kind": "number", + "type": { + "$ref": "2345" + }, + "value": 0.94639826 + } + } + } + ] + }, + "value": { + "$id": "10118", + "kind": "array", + "type": { + "$ref": "2623" + }, + "value": [ + { + "$id": "10119", + "kind": "model", + "type": { + "$ref": "2624" + }, + "value": { + "$id": "10120", + "@search.score": { + "$id": "10121", + "kind": "number", + "type": { + "$ref": "2627" + }, + "value": 0.5479723 + }, + "@search.rerankerScore": { + "$id": "10122", + "kind": "number", + "type": { + "$ref": "2631" + }, + "value": 1.0321671911515296 + }, + "@search.captions": { + "$id": "10123", + "kind": "array", + "type": { + "$ref": "2642" + }, + "value": [ + { + "$id": "10124", + "kind": "model", + "type": { + "$ref": "2643" + }, + "value": { + "$id": "10125", + "text": { + "$id": "10126", + "kind": "string", + "type": { + "$ref": "2646" + }, + "value": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America." + }, + "highlights": { + "$id": "10127", + "kind": "string", + "type": { + "$ref": "2650" + }, + "value": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America." + } + } + } + ] + } + }, + "additionalPropertiesValue": { + "$id": "10128", + "id": { + "$id": "10129", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "4123" + }, + "title": { + "$id": "10130", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "Earth Atmosphere" + }, + "content": { + "$id": "10131", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n" + }, + "locations": { + "$id": "10132", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": [ + "Pacific Northwest", + "North America", + "Vancouver" + ] + } + } + } + ] + } + } + } + } + ] + } + ] + }, + { + "$id": "10133", + "name": "searchPost", + "resourceName": "Documents", + "doc": "Searches for documents in the index.", + "accessibility": "public", + "parameters": [ + { + "$id": "10134", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "10135", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "10136", + "type": { + "$id": "10137", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10138", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "10139", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "10140", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10141", + "name": "indexName", + "nameInRequest": "indexName", + "doc": "The name of the index.", + "type": { + "$id": "10142", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10143", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "10144", + "kind": "constant", + "valueType": { + "$id": "10145", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10146", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "10147", + "kind": "constant", + "valueType": { + "$id": "10148", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10149", + "name": "searchRequest", + "nameInRequest": "searchRequest", + "doc": "The definition of the Search request.", + "type": { + "$ref": "2388" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "10150", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "2309" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "POST", + "uri": "{endpoint}", + "path": "/indexes('{indexName}')/docs/search.post.search", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Documents.searchPost", + "decorators": [], + "examples": [ + { + "$id": "10151", + "kind": "http", + "name": "SearchIndexSearchDocumentsPost", + "description": "SearchIndexSearchDocumentsPost", + "filePath": "2025-03-01-preview/SearchIndexSearchDocumentsPost.json", + "parameters": [ + { + "$id": "10152", + "parameter": { + "$ref": "10141" + }, + "value": { + "$id": "10153", + "kind": "string", + "type": { + "$ref": "10142" + }, + "value": "preview-test" + } + }, + { + "$id": "10154", + "parameter": { + "$ref": "10134" + }, + "value": { + "$id": "10155", + "kind": "string", + "type": { + "$ref": "10135" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "10156", + "parameter": { + "$ref": "10138" + }, + "value": { + "$id": "10157", + "kind": "string", + "type": { + "$ref": "10139" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "10158", + "parameter": { + "$ref": "10149" + }, + "value": { + "$id": "10159", + "kind": "model", + "type": { + "$ref": "2388" + }, + "value": { + "$id": "10160", + "count": { + "$id": "10161", + "kind": "boolean", + "type": { + "$ref": "2390" + }, + "value": true + }, + "facets": { + "$id": "10162", + "kind": "array", + "type": { + "$ref": "2394" + }, + "value": [ + { + "$id": "10163", + "kind": "string", + "type": { + "$ref": "2395" + }, + "value": "ownerId" + }, + { + "$id": "10164", + "kind": "string", + "type": { + "$ref": "2395" + }, + "value": "price,metric:sum,default:10" + } + ] + }, + "filter": { + "$id": "10165", + "kind": "string", + "type": { + "$ref": "2399" + }, + "value": "category eq 'purple' or category eq 'pink'" + }, + "highlight": { + "$id": "10166", + "kind": "string", + "type": { + "$ref": "2403" + }, + "value": "category" + }, + "highlightPostTag": { + "$id": "10167", + "kind": "string", + "type": { + "$ref": "2407" + }, + "value": "" + }, + "highlightPreTag": { + "$id": "10168", + "kind": "string", + "type": { + "$ref": "2411" + }, + "value": "" + }, + "minimumCoverage": { + "$id": "10169", + "kind": "number", + "type": { + "$ref": "2415" + }, + "value": 100 + }, + "queryType": { + "$id": "10170", + "kind": "string", + "type": { + "$ref": "2" + }, + "value": "semantic" + }, + "scoringStatistics": { + "$id": "10171", + "kind": "string", + "type": { + "$ref": "16" + }, + "value": "global" + }, + "sessionId": { + "$id": "10172", + "kind": "string", + "type": { + "$ref": "2429" + }, + "value": "mysessionid" + }, + "scoringParameters": { + "$id": "10173", + "kind": "array", + "type": { + "$ref": "2433" + }, + "value": [ + { + "$id": "10174", + "kind": "string", + "type": { + "$ref": "2434" + }, + "value": "categoryTag:desiredCategoryValue" + } + ] + }, + "scoringProfile": { + "$id": "10175", + "kind": "string", + "type": { + "$ref": "2438" + }, + "value": "stringFieldBoost" + }, + "search": { + "$id": "10176", + "kind": "string", + "type": { + "$ref": "2445" + }, + "value": "purple" + }, + "searchFields": { + "$id": "10177", + "kind": "string", + "type": { + "$ref": "2449" + }, + "value": "id,name,description,category,ownerId" + }, + "searchMode": { + "$id": "10178", + "kind": "string", + "type": { + "$ref": "10" + }, + "value": "any" + }, + "queryLanguage": { + "$id": "10179", + "kind": "string", + "type": { + "$ref": "58" + }, + "value": "en-us" + }, + "speller": { + "$id": "10180", + "kind": "string", + "type": { + "$ref": "204" + }, + "value": "lexicon" + }, + "select": { + "$id": "10181", + "kind": "string", + "type": { + "$ref": "2462" + }, + "value": "id,name,description,category,ownerId" + }, + "skip": { + "$id": "10182", + "kind": "number", + "type": { + "$ref": "2466" + }, + "value": 0 + }, + "top": { + "$id": "10183", + "kind": "number", + "type": { + "$ref": "2470" + }, + "value": 10 + }, + "semanticConfiguration": { + "$id": "10184", + "kind": "string", + "type": { + "$ref": "2474" + }, + "value": "testconfig" + }, + "semanticErrorHandling": { + "$id": "10185", + "kind": "string", + "type": { + "$ref": "22" + }, + "value": "partial" + }, + "semanticMaxWaitInMilliseconds": { + "$id": "10186", + "kind": "number", + "type": { + "$ref": "2481" + }, + "value": 5000 + }, + "semanticQuery": { + "$id": "10187", + "kind": "string", + "type": { + "$ref": "2485" + }, + "value": "find all purple" + }, + "answers": { + "$id": "10188", + "kind": "string", + "type": { + "$ref": "28" + }, + "value": "extractive" + }, + "captions": { + "$id": "10189", + "kind": "string", + "type": { + "$ref": "34" + }, + "value": "extractive" + }, + "queryRewrites": { + "$id": "10190", + "kind": "string", + "type": { + "$ref": "40" + }, + "value": "generative" + }, + "vectorQueries": { + "$id": "10191", + "kind": "array", + "type": { + "$ref": "2502" + }, + "value": [ + { + "$id": "10192", + "kind": "model", + "type": { + "$ref": "2560" + }, + "value": { + "$id": "10193", + "vector": { + "$id": "10194", + "kind": "array", + "type": { + "$ref": "2562" + }, + "value": [ + { + "$id": "10195", + "kind": "number", + "type": { + "$ref": "2563" + }, + "value": 0 + }, + { + "$id": "10196", + "kind": "number", + "type": { + "$ref": "2563" + }, + "value": 1 + }, + { + "$id": "10197", + "kind": "number", + "type": { + "$ref": "2563" + }, + "value": 2 + }, + { + "$id": "10198", + "kind": "number", + "type": { + "$ref": "2563" + }, + "value": 3 + }, + { + "$id": "10199", + "kind": "number", + "type": { + "$ref": "2563" + }, + "value": 4 + }, + { + "$id": "10200", + "kind": "number", + "type": { + "$ref": "2563" + }, + "value": 5 + }, + { + "$id": "10201", + "kind": "number", + "type": { + "$ref": "2563" + }, + "value": 6 + }, + { + "$id": "10202", + "kind": "number", + "type": { + "$ref": "2563" + }, + "value": 7 + }, + { + "$id": "10203", + "kind": "number", + "type": { + "$ref": "2563" + }, + "value": 8 + }, + { + "$id": "10204", + "kind": "number", + "type": { + "$ref": "2563" + }, + "value": 9 + } + ] + }, + "kind": { + "$id": "10205", + "kind": "string", + "type": { + "$ref": "2567" + }, + "value": "vector" + }, + "k": { + "$id": "10206", + "kind": "number", + "type": { + "$ref": "2508" + }, + "value": 50 + }, + "fields": { + "$id": "10207", + "kind": "string", + "type": { + "$ref": "2512" + }, + "value": "vector22, vector1b" + }, + "oversampling": { + "$id": "10208", + "kind": "number", + "type": { + "$ref": "2520" + }, + "value": 20 + }, + "weight": { + "$id": "10209", + "kind": "number", + "type": { + "$ref": "2524" + }, + "value": 1 + }, + "threshold": { + "$id": "10210", + "kind": "model", + "type": { + "$ref": "2533" + }, + "value": { + "$id": "10211", + "value": { + "$id": "10212", + "kind": "number", + "type": { + "$ref": "2535" + }, + "value": 0.984 + }, + "kind": { + "$id": "10213", + "kind": "string", + "type": { + "$ref": "2539" + }, + "value": "vectorSimilarity" + } + } + }, + "filterOverride": { + "$id": "10214", + "kind": "string", + "type": { + "$ref": "2556" + }, + "value": "ownerId eq 'sam'" + } + } + } + ] + }, + "vectorFilterMode": { + "$id": "10215", + "kind": "string", + "type": { + "$ref": "226" + }, + "value": "preFilter" + }, + "hybridSearch": { + "$id": "10216", + "kind": "model", + "type": { + "$ref": "2610" + }, + "value": { + "$id": "10217", + "maxTextRecallSize": { + "$id": "10218", + "kind": "number", + "type": { + "$ref": "2612" + }, + "value": 100 + }, + "countAndFacetMode": { + "$id": "10219", + "kind": "string", + "type": { + "$ref": "232" + }, + "value": "countAllResults" + } + } + } + } + } + } + ], + "responses": [ + { + "$id": "10220", + "response": { + "$ref": "10150" + }, + "statusCode": 200, + "bodyValue": { + "$id": "10221", + "kind": "model", + "type": { + "$ref": "2309" + }, + "value": { + "$id": "10222", + "@odata.count": { + "$id": "10223", + "kind": "number", + "type": { + "$ref": "2311" + }, + "value": 27 + }, + "@search.coverage": { + "$id": "10224", + "kind": "number", + "type": { + "$ref": "2315" + }, + "value": 100 + }, + "@search.facets": { + "$id": "10225", + "kind": "dict", + "type": { + "$ref": "2319" + }, + "value": { + "$id": "10226", + "ownerId": { + "$id": "10227", + "kind": "array", + "type": { + "$ref": "2321" + }, + "value": [ + { + "$id": "10228", + "kind": "model", + "type": { + "$ref": "2322" + }, + "value": { + "$id": "10229", + "count": { + "$id": "10230", + "kind": "number", + "type": { + "$ref": "2325" + }, + "value": 16 + } + }, + "additionalPropertiesValue": { + "$id": "10231", + "value": { + "$id": "10232", + "kind": "unknown", + "type": { + "$ref": "2323" + }, + "value": "sam" + } + } + }, + { + "$id": "10233", + "kind": "model", + "type": { + "$ref": "2322" + }, + "value": { + "$id": "10234", + "count": { + "$id": "10235", + "kind": "number", + "type": { + "$ref": "2325" + }, + "value": 8 + } + }, + "additionalPropertiesValue": { + "$id": "10236", + "value": { + "$id": "10237", + "kind": "unknown", + "type": { + "$ref": "2323" + }, + "value": "ryan" + } + } + }, + { + "$id": "10238", + "kind": "model", + "type": { + "$ref": "2322" + }, + "value": { + "$id": "10239", + "count": { + "$id": "10240", + "kind": "number", + "type": { + "$ref": "2325" + }, + "value": 3 + } + }, + "additionalPropertiesValue": { + "$id": "10241", + "value": { + "$id": "10242", + "kind": "unknown", + "type": { + "$ref": "2323" + }, + "value": "benny" + } + } + } + ] + }, + "price": { + "$id": "10243", + "kind": "array", + "type": { + "$ref": "2321" + }, + "value": [ + { + "$id": "10244", + "kind": "model", + "type": { + "$ref": "2322" + }, + "value": { + "$id": "10245", + "sum": { + "$id": "10246", + "kind": "number", + "type": { + "$ref": "2335" + }, + "value": 320 + } + } + } + ] + } + } + }, + "@search.answers": { + "$id": "10247", + "kind": "array", + "type": { + "$ref": "2341" + }, + "value": [ + { + "$id": "10248", + "kind": "model", + "type": { + "$ref": "2342" + }, + "value": { + "$id": "10249", + "key": { + "$id": "10250", + "kind": "string", + "type": { + "$ref": "2349" + }, + "value": "empty-vectors" + }, + "text": { + "$id": "10251", + "kind": "string", + "type": { + "$ref": "2353" + }, + "value": "no vector." + }, + "highlights": { + "$id": "10252", + "kind": "string", + "type": { + "$ref": "2357" + }, + "value": "no vector." + }, + "score": { + "$id": "10253", + "kind": "number", + "type": { + "$ref": "2345" + }, + "value": 0.8240000009536743 + } + } + } + ] + }, + "value": { + "$id": "10254", + "kind": "array", + "type": { + "$ref": "2623" + }, + "value": [ + { + "$id": "10255", + "kind": "model", + "type": { + "$ref": "2624" + }, + "value": { + "$id": "10256", + "@search.score": { + "$id": "10257", + "kind": "number", + "type": { + "$ref": "2627" + }, + "value": 0.012820512987673283 + }, + "@search.highlights": { + "$id": "10258", + "kind": "dict", + "type": { + "$ref": "2635" + }, + "value": { + "$id": "10259", + "category": { + "$id": "10260", + "kind": "array", + "type": { + "$ref": "2637" + }, + "value": [ + { + "$id": "10261", + "kind": "string", + "type": { + "$ref": "2638" + }, + "value": "purple" + } + ] + } + } + }, + "@search.rerankerScore": { + "$id": "10262", + "kind": "number", + "type": { + "$ref": "2631" + }, + "value": 1.788736343383789 + }, + "@search.captions": { + "$id": "10263", + "kind": "array", + "type": { + "$ref": "2642" + }, + "value": [ + { + "$id": "10264", + "kind": "model", + "type": { + "$ref": "2643" + }, + "value": { + "$id": "10265", + "text": { + "$id": "10266", + "kind": "string", + "type": { + "$ref": "2646" + }, + "value": "no vector." + }, + "highlights": { + "$id": "10267", + "kind": "string", + "type": { + "$ref": "2650" + }, + "value": "no vector." + } + } + } + ] + } + }, + "additionalPropertiesValue": { + "$id": "10268", + "id": { + "$id": "10269", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "empty-vectors" + }, + "name": { + "$id": "10270", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test" + }, + "description": { + "$id": "10271", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "no vector" + }, + "category": { + "$id": "10272", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "purple" + }, + "ownerId": { + "$id": "10273", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "sam" + } + } + }, + { + "$id": "10274", + "kind": "model", + "type": { + "$ref": "2624" + }, + "value": { + "$id": "10275", + "@search.score": { + "$id": "10276", + "kind": "number", + "type": { + "$ref": "2627" + }, + "value": 0.011627906933426857 + }, + "@search.highlights": { + "$id": "10277", + "kind": "dict", + "type": { + "$ref": "2635" + }, + "value": { + "$id": "10278", + "category": { + "$id": "10279", + "kind": "array", + "type": { + "$ref": "2637" + }, + "value": [ + { + "$id": "10280", + "kind": "string", + "type": { + "$ref": "2638" + }, + "value": "purple" + } + ] + } + } + }, + "@search.rerankerScore": { + "$id": "10281", + "kind": "number", + "type": { + "$ref": "2631" + }, + "value": 1.788736343383789 + }, + "@search.captions": { + "$id": "10282", + "kind": "array", + "type": { + "$ref": "2642" + }, + "value": [ + { + "$id": "10283", + "kind": "model", + "type": { + "$ref": "2643" + }, + "value": { + "$id": "10284", + "text": { + "$id": "10285", + "kind": "string", + "type": { + "$ref": "2646" + }, + "value": "no vector." + }, + "highlights": { + "$id": "10286", + "kind": "string", + "type": { + "$ref": "2650" + }, + "value": "no vector." + } + } + } + ] + } + }, + "additionalPropertiesValue": { + "$id": "10287", + "id": { + "$id": "10288", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "no-vectors" + }, + "name": { + "$id": "10289", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test" + }, + "description": { + "$id": "10290", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "no vector" + }, + "category": { + "$id": "10291", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "purple" + }, + "ownerId": { + "$id": "10292", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "sam" + } + } + }, + { + "$id": "10293", + "kind": "model", + "type": { + "$ref": "2624" + }, + "value": { + "$id": "10294", + "@search.score": { + "$id": "10295", + "kind": "number", + "type": { + "$ref": "2627" + }, + "value": 0.012345679104328156 + }, + "@search.highlights": { + "$id": "10296", + "kind": "dict", + "type": { + "$ref": "2635" + }, + "value": { + "$id": "10297", + "category": { + "$id": "10298", + "kind": "array", + "type": { + "$ref": "2637" + }, + "value": [ + { + "$id": "10299", + "kind": "string", + "type": { + "$ref": "2638" + }, + "value": "purple" + } + ] + } + } + }, + "@search.rerankerScore": { + "$id": "10300", + "kind": "number", + "type": { + "$ref": "2631" + }, + "value": 1.7298945188522339 + }, + "@search.captions": { + "$id": "10301", + "kind": "array", + "type": { + "$ref": "2642" + }, + "value": [ + { + "$id": "10302", + "kind": "model", + "type": { + "$ref": "2643" + }, + "value": { + "$id": "10303", + "text": { + "$id": "10304", + "kind": "string", + "type": { + "$ref": "2646" + }, + "value": "test2 hello." + }, + "highlights": { + "$id": "10305", + "kind": "string", + "type": { + "$ref": "2650" + }, + "value": "" + } + } + } + ] + } + }, + "additionalPropertiesValue": { + "$id": "10306", + "id": { + "$id": "10307", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "2" + }, + "name": { + "$id": "10308", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test" + }, + "description": { + "$id": "10309", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test2 hello" + }, + "category": { + "$id": "10310", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "purple" + }, + "ownerId": { + "$id": "10311", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "sam" + } + } + }, + { + "$id": "10312", + "kind": "model", + "type": { + "$ref": "2624" + }, + "value": { + "$id": "10313", + "@search.score": { + "$id": "10314", + "kind": "number", + "type": { + "$ref": "2627" + }, + "value": 0.011904762126505375 + }, + "@search.highlights": { + "$id": "10315", + "kind": "dict", + "type": { + "$ref": "2635" + }, + "value": { + "$id": "10316", + "category": { + "$id": "10317", + "kind": "array", + "type": { + "$ref": "2637" + }, + "value": [ + { + "$id": "10318", + "kind": "string", + "type": { + "$ref": "2638" + }, + "value": "purple" + } + ] + } + } + }, + "@search.rerankerScore": { + "$id": "10319", + "kind": "number", + "type": { + "$ref": "2631" + }, + "value": 1.7274131774902344 + }, + "@search.captions": { + "$id": "10320", + "kind": "array", + "type": { + "$ref": "2642" + }, + "value": [ + { + "$id": "10321", + "kind": "model", + "type": { + "$ref": "2643" + }, + "value": { + "$id": "10322", + "text": { + "$id": "10323", + "kind": "string", + "type": { + "$ref": "2646" + }, + "value": "test4 hello." + }, + "highlights": { + "$id": "10324", + "kind": "string", + "type": { + "$ref": "2650" + }, + "value": "" + } + } + } + ] + } + }, + "additionalPropertiesValue": { + "$id": "10325", + "id": { + "$id": "10326", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "4" + }, + "name": { + "$id": "10327", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test" + }, + "description": { + "$id": "10328", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test4 hello" + }, + "category": { + "$id": "10329", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "purple" + }, + "ownerId": { + "$id": "10330", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "sam" + } + } + }, + { + "$id": "10331", + "kind": "model", + "type": { + "$ref": "2624" + }, + "value": { + "$id": "10332", + "@search.score": { + "$id": "10333", + "kind": "number", + "type": { + "$ref": "2627" + }, + "value": 0.01666666753590107 + }, + "@search.highlights": { + "$id": "10334", + "kind": "dict", + "type": { + "$ref": "2635" + }, + "value": { + "$id": "10335", + "category": { + "$id": "10336", + "kind": "array", + "type": { + "$ref": "2637" + }, + "value": [ + { + "$id": "10337", + "kind": "string", + "type": { + "$ref": "2638" + }, + "value": "purple" + } + ] + } + } + }, + "@search.rerankerScore": { + "$id": "10338", + "kind": "number", + "type": { + "$ref": "2631" + }, + "value": 1.724223017692566 + }, + "@search.captions": { + "$id": "10339", + "kind": "array", + "type": { + "$ref": "2642" + }, + "value": [ + { + "$id": "10340", + "kind": "model", + "type": { + "$ref": "2643" + }, + "value": { + "$id": "10341", + "text": { + "$id": "10342", + "kind": "string", + "type": { + "$ref": "2646" + }, + "value": "test7 hello." + }, + "highlights": { + "$id": "10343", + "kind": "string", + "type": { + "$ref": "2650" + }, + "value": "" + } + } + } + ] + } + }, + "additionalPropertiesValue": { + "$id": "10344", + "id": { + "$id": "10345", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "7" + }, + "name": { + "$id": "10346", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test" + }, + "description": { + "$id": "10347", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test7 hello" + }, + "category": { + "$id": "10348", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "purple" + }, + "ownerId": { + "$id": "10349", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "sam" + } + } + }, + { + "$id": "10350", + "kind": "model", + "type": { + "$ref": "2624" + }, + "value": { + "$id": "10351", + "@search.score": { + "$id": "10352", + "kind": "number", + "type": { + "$ref": "2627" + }, + "value": 0.0117647061124444 + }, + "@search.highlights": { + "$id": "10353", + "kind": "dict", + "type": { + "$ref": "2635" + }, + "value": { + "$id": "10354", + "category": { + "$id": "10355", + "kind": "array", + "type": { + "$ref": "2637" + }, + "value": [ + { + "$id": "10356", + "kind": "string", + "type": { + "$ref": "2638" + }, + "value": "purple" + } + ] + } + } + }, + "@search.rerankerScore": { + "$id": "10357", + "kind": "number", + "type": { + "$ref": "2631" + }, + "value": 1.721387267112732 + }, + "@search.captions": { + "$id": "10358", + "kind": "array", + "type": { + "$ref": "2642" + }, + "value": [ + { + "$id": "10359", + "kind": "model", + "type": { + "$ref": "2643" + }, + "value": { + "$id": "10360", + "text": { + "$id": "10361", + "kind": "string", + "type": { + "$ref": "2646" + }, + "value": "test5 hello." + }, + "highlights": { + "$id": "10362", + "kind": "string", + "type": { + "$ref": "2650" + }, + "value": "" + } + } + } + ] + } + }, + "additionalPropertiesValue": { + "$id": "10363", + "id": { + "$id": "10364", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "5" + }, + "name": { + "$id": "10365", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test" + }, + "description": { + "$id": "10366", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test5 hello" + }, + "category": { + "$id": "10367", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "purple" + }, + "ownerId": { + "$id": "10368", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "sam" + } + } + }, + { + "$id": "10369", + "kind": "model", + "type": { + "$ref": "2624" + }, + "value": { + "$id": "10370", + "@search.score": { + "$id": "10371", + "kind": "number", + "type": { + "$ref": "2627" + }, + "value": 0.013888888992369175 + }, + "@search.highlights": { + "$id": "10372", + "kind": "dict", + "type": { + "$ref": "2635" + }, + "value": { + "$id": "10373", + "category": { + "$id": "10374", + "kind": "array", + "type": { + "$ref": "2637" + }, + "value": [ + { + "$id": "10375", + "kind": "string", + "type": { + "$ref": "2638" + }, + "value": "purple" + } + ] + } + } + }, + "@search.rerankerScore": { + "$id": "10376", + "kind": "number", + "type": { + "$ref": "2631" + }, + "value": 1.695865511894226 + }, + "@search.captions": { + "$id": "10377", + "kind": "array", + "type": { + "$ref": "2642" + }, + "value": [ + { + "$id": "10378", + "kind": "model", + "type": { + "$ref": "2643" + }, + "value": { + "$id": "10379", + "text": { + "$id": "10380", + "kind": "string", + "type": { + "$ref": "2646" + }, + "value": "test8 hello." + }, + "highlights": { + "$id": "10381", + "kind": "string", + "type": { + "$ref": "2650" + }, + "value": "" + } + } + } + ] + } + }, + "additionalPropertiesValue": { + "$id": "10382", + "id": { + "$id": "10383", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "8" + }, + "name": { + "$id": "10384", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test" + }, + "description": { + "$id": "10385", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test8 hello" + }, + "category": { + "$id": "10386", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "purple" + }, + "ownerId": { + "$id": "10387", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "sam" + } + } + }, + { + "$id": "10388", + "kind": "model", + "type": { + "$ref": "2624" + }, + "value": { + "$id": "10389", + "@search.score": { + "$id": "10390", + "kind": "number", + "type": { + "$ref": "2627" + }, + "value": 0.012658228166401386 + }, + "@search.highlights": { + "$id": "10391", + "kind": "dict", + "type": { + "$ref": "2635" + }, + "value": { + "$id": "10392", + "category": { + "$id": "10393", + "kind": "array", + "type": { + "$ref": "2637" + }, + "value": [ + { + "$id": "10394", + "kind": "string", + "type": { + "$ref": "2638" + }, + "value": "purple" + } + ] + } + } + }, + "@search.rerankerScore": { + "$id": "10395", + "kind": "number", + "type": { + "$ref": "2631" + }, + "value": 1.6887761354446411 + }, + "@search.captions": { + "$id": "10396", + "kind": "array", + "type": { + "$ref": "2642" + }, + "value": [ + { + "$id": "10397", + "kind": "model", + "type": { + "$ref": "2643" + }, + "value": { + "$id": "10398", + "text": { + "$id": "10399", + "kind": "string", + "type": { + "$ref": "2646" + }, + "value": "test11 hello." + }, + "highlights": { + "$id": "10400", + "kind": "string", + "type": { + "$ref": "2650" + }, + "value": "" + } + } + } + ] + } + }, + "additionalPropertiesValue": { + "$id": "10401", + "id": { + "$id": "10402", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "11" + }, + "name": { + "$id": "10403", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test" + }, + "description": { + "$id": "10404", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test11 hello" + }, + "category": { + "$id": "10405", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "purple" + }, + "ownerId": { + "$id": "10406", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "sam" + } + } + }, + { + "$id": "10407", + "kind": "model", + "type": { + "$ref": "2624" + }, + "value": { + "$id": "10408", + "@search.score": { + "$id": "10409", + "kind": "number", + "type": { + "$ref": "2627" + }, + "value": 0.014084506779909134 + }, + "@search.highlights": { + "$id": "10410", + "kind": "dict", + "type": { + "$ref": "2635" + }, + "value": { + "$id": "10411", + "category": { + "$id": "10412", + "kind": "array", + "type": { + "$ref": "2637" + }, + "value": [ + { + "$id": "10413", + "kind": "string", + "type": { + "$ref": "2638" + }, + "value": "purple" + } + ] + } + } + }, + "@search.rerankerScore": { + "$id": "10414", + "kind": "number", + "type": { + "$ref": "2631" + }, + "value": 1.6848769187927246 + }, + "@search.captions": { + "$id": "10415", + "kind": "array", + "type": { + "$ref": "2642" + }, + "value": [ + { + "$id": "10416", + "kind": "model", + "type": { + "$ref": "2643" + }, + "value": { + "$id": "10417", + "text": { + "$id": "10418", + "kind": "string", + "type": { + "$ref": "2646" + }, + "value": "test16 hello." + }, + "highlights": { + "$id": "10419", + "kind": "string", + "type": { + "$ref": "2650" + }, + "value": "" + } + } + } + ] + } + }, + "additionalPropertiesValue": { + "$id": "10420", + "id": { + "$id": "10421", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "16" + }, + "name": { + "$id": "10422", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test" + }, + "description": { + "$id": "10423", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test16 hello" + }, + "category": { + "$id": "10424", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "purple" + }, + "ownerId": { + "$id": "10425", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "sam" + } + } + }, + { + "$id": "10426", + "kind": "model", + "type": { + "$ref": "2624" + }, + "value": { + "$id": "10427", + "@search.score": { + "$id": "10428", + "kind": "number", + "type": { + "$ref": "2627" + }, + "value": 0.013333333656191826 + }, + "@search.highlights": { + "$id": "10429", + "kind": "dict", + "type": { + "$ref": "2635" + }, + "value": { + "$id": "10430", + "category": { + "$id": "10431", + "kind": "array", + "type": { + "$ref": "2637" + }, + "value": [ + { + "$id": "10432", + "kind": "string", + "type": { + "$ref": "2638" + }, + "value": "purple" + } + ] + } + } + }, + "@search.rerankerScore": { + "$id": "10433", + "kind": "number", + "type": { + "$ref": "2631" + }, + "value": 1.6834590435028076 + }, + "@search.captions": { + "$id": "10434", + "kind": "array", + "type": { + "$ref": "2642" + }, + "value": [ + { + "$id": "10435", + "kind": "model", + "type": { + "$ref": "2643" + }, + "value": { + "$id": "10436", + "text": { + "$id": "10437", + "kind": "string", + "type": { + "$ref": "2646" + }, + "value": "test23 hello." + }, + "highlights": { + "$id": "10438", + "kind": "string", + "type": { + "$ref": "2650" + }, + "value": "" + } + } + } + ] + } + }, + "additionalPropertiesValue": { + "$id": "10439", + "id": { + "$id": "10440", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "23" + }, + "name": { + "$id": "10441", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test" + }, + "description": { + "$id": "10442", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "test23 hello" + }, + "category": { + "$id": "10443", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "purple" + }, + "ownerId": { + "$id": "10444", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "sam" + } + } + } + ] + } + } + } + } + ] + }, + { + "$id": "10445", + "kind": "http", + "name": "SearchIndexSearchDocumentsSemanticPost", + "description": "SearchIndexSearchDocumentsSemanticPost", + "filePath": "2025-03-01-preview/SearchIndexSearchDocumentsSemanticPost.json", + "parameters": [ + { + "$id": "10446", + "parameter": { + "$ref": "10141" + }, + "value": { + "$id": "10447", + "kind": "string", + "type": { + "$ref": "10142" + }, + "value": "myindex" + } + }, + { + "$id": "10448", + "parameter": { + "$ref": "10134" + }, + "value": { + "$id": "10449", + "kind": "string", + "type": { + "$ref": "10135" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "10450", + "parameter": { + "$ref": "10149" + }, + "value": { + "$id": "10451", + "kind": "model", + "type": { + "$ref": "2388" + }, + "value": { + "$id": "10452", + "count": { + "$id": "10453", + "kind": "boolean", + "type": { + "$ref": "2390" + }, + "value": true + }, + "highlightPostTag": { + "$id": "10454", + "kind": "string", + "type": { + "$ref": "2407" + }, + "value": "" + }, + "highlightPreTag": { + "$id": "10455", + "kind": "string", + "type": { + "$ref": "2411" + }, + "value": "" + }, + "queryType": { + "$id": "10456", + "kind": "string", + "type": { + "$ref": "2" + }, + "value": "semantic" + }, + "search": { + "$id": "10457", + "kind": "string", + "type": { + "$ref": "2445" + }, + "value": "how do clouds form" + }, + "semanticConfiguration": { + "$id": "10458", + "kind": "string", + "type": { + "$ref": "2474" + }, + "value": "my-semantic-config" + }, + "answers": { + "$id": "10459", + "kind": "string", + "type": { + "$ref": "28" + }, + "value": "extractive|count-3" + }, + "captions": { + "$id": "10460", + "kind": "string", + "type": { + "$ref": "34" + }, + "value": "extractive|highlight-true" + }, + "semanticErrorHandling": { + "$id": "10461", + "kind": "string", + "type": { + "$ref": "22" + }, + "value": "partial" + }, + "semanticMaxWaitInMilliseconds": { + "$id": "10462", + "kind": "number", + "type": { + "$ref": "2481" + }, + "value": 780 + } + } + } + } + ], + "responses": [ + { + "$id": "10463", + "response": { + "$ref": "10150" + }, + "statusCode": 200, + "bodyValue": { + "$id": "10464", + "kind": "model", + "type": { + "$ref": "2309" + }, + "value": { + "$id": "10465", + "@odata.count": { + "$id": "10466", + "kind": "number", + "type": { + "$ref": "2311" + }, + "value": 25 + }, + "@search.answers": { + "$id": "10467", + "kind": "array", + "type": { + "$ref": "2341" + }, + "value": [ + { + "$id": "10468", + "kind": "model", + "type": { + "$ref": "2342" + }, + "value": { + "$id": "10469", + "key": { + "$id": "10470", + "kind": "string", + "type": { + "$ref": "2349" + }, + "value": "4123" + }, + "text": { + "$id": "10471", + "kind": "string", + "type": { + "$ref": "2353" + }, + "value": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case), but not where it is descending (over the river)." + }, + "highlights": { + "$id": "10472", + "kind": "string", + "type": { + "$ref": "2357" + }, + "value": "Sunlight heats the land all day, warming that moist air and causing it to rise high into the atmosphere until it cools and condenses into water droplets. Clouds generally form where air is ascending (over land in this case), but not where it is descending (over the river)." + }, + "score": { + "$id": "10473", + "kind": "number", + "type": { + "$ref": "2345" + }, + "value": 0.94639826 + } + } + } + ] + }, + "@search.nextPageParameters": { + "$id": "10474", + "kind": "model", + "type": { + "$ref": "2388" + }, + "value": { + "$id": "10475", + "count": { + "$id": "10476", + "kind": "boolean", + "type": { + "$ref": "2390" + }, + "value": true + }, + "highlightPostTag": { + "$id": "10477", + "kind": "string", + "type": { + "$ref": "2407" + }, + "value": "" + }, + "highlightPreTag": { + "$id": "10478", + "kind": "string", + "type": { + "$ref": "2411" + }, + "value": "" + }, + "queryType": { + "$id": "10479", + "kind": "string", + "type": { + "$ref": "2" + }, + "value": "semantic" + }, + "search": { + "$id": "10480", + "kind": "string", + "type": { + "$ref": "2445" + }, + "value": "how do clouds form" + }, + "semanticConfiguration": { + "$id": "10481", + "kind": "string", + "type": { + "$ref": "2474" + }, + "value": "my-semantic-config" + }, + "answers": { + "$id": "10482", + "kind": "string", + "type": { + "$ref": "28" + }, + "value": "extractive|count-3" + }, + "captions": { + "$id": "10483", + "kind": "string", + "type": { + "$ref": "34" + }, + "value": "extractive|highlight-true" + }, + "semanticErrorHandling": { + "$id": "10484", + "kind": "string", + "type": { + "$ref": "22" + }, + "value": "partial" + }, + "semanticMaxWaitInMilliseconds": { + "$id": "10485", + "kind": "number", + "type": { + "$ref": "2481" + }, + "value": 780 + }, + "skip": { + "$id": "10486", + "kind": "number", + "type": { + "$ref": "2466" + }, + "value": 2 + }, + "top": { + "$id": "10487", + "kind": "number", + "type": { + "$ref": "2470" + }, + "value": 8 + } + } + }, + "value": { + "$id": "10488", + "kind": "array", + "type": { + "$ref": "2623" + }, + "value": [ + { + "$id": "10489", + "kind": "model", + "type": { + "$ref": "2624" + }, + "value": { + "$id": "10490", + "@search.score": { + "$id": "10491", + "kind": "number", + "type": { + "$ref": "2627" + }, + "value": 0.5479723 + }, + "@search.rerankerScore": { + "$id": "10492", + "kind": "number", + "type": { + "$ref": "2631" + }, + "value": 1.0321671911515296 + }, + "@search.captions": { + "$id": "10493", + "kind": "array", + "type": { + "$ref": "2642" + }, + "value": [ + { + "$id": "10494", + "kind": "model", + "type": { + "$ref": "2643" + }, + "value": { + "$id": "10495", + "text": { + "$id": "10496", + "kind": "string", + "type": { + "$ref": "2646" + }, + "value": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America." + }, + "highlights": { + "$id": "10497", + "kind": "string", + "type": { + "$ref": "2650" + }, + "value": "Like all clouds, it forms when the air reaches its dew point—the temperature at which an air mass is cool enough for its water vapor to condense into liquid droplets. This false-color image shows valley fog, which is common in the Pacific Northwest of North America." + } + } + } + ] + } + }, + "additionalPropertiesValue": { + "$id": "10498", + "id": { + "$id": "10499", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "4123" + }, + "title": { + "$id": "10500", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "Earth Atmosphere" + }, + "content": { + "$id": "10501", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": "Fog is essentially a cloud lying on the ground. Like all clouds, it forms when the air reaches its dew point—the temperature at \n\nwhich an air mass is cool enough for its water vapor to condense into liquid droplets.\n\nThis false-color image shows valley fog, which is common in the Pacific Northwest of North America. On clear winter nights, the \n\nground and overlying air cool off rapidly, especially at high elevations. Cold air is denser than warm air, and it sinks down into the \n\nvalleys. The moist air in the valleys gets chilled to its dew point, and fog forms. If undisturbed by winds, such fog may persist for \n\ndays. The Terra satellite captured this image of foggy valleys northeast of Vancouver in February 2010.\n\n\n" + }, + "locations": { + "$id": "10502", + "kind": "unknown", + "type": { + "$ref": "2625" + }, + "value": [ + "Pacific Northwest", + "North America", + "Vancouver" + ] + } + } + } + ] + }, + "@odata.nextLink": { + "$id": "10503", + "kind": "string", + "type": { + "$ref": "2737" + }, + "value": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2025-03-01-preview" + } + } + } + } + ] + } + ] + }, + { + "$id": "10504", + "name": "get", + "resourceName": "Documents", + "doc": "Retrieves a document from the index.", + "accessibility": "public", + "parameters": [ + { + "$id": "10505", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "10506", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "10507", + "type": { + "$id": "10508", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10509", + "name": "key", + "nameInRequest": "key", + "doc": "The key of the document to retrieve.", + "type": { + "$id": "10510", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10511", + "name": "selectedFields", + "nameInRequest": "$select", + "doc": "List of field names to retrieve for the document; Any field not retrieved will\nbe missing from the returned document.", + "type": { + "$id": "10512", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "10513", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "arraySerializationDelimiter": ",", + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10514", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "10515", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "10516", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10517", + "name": "indexName", + "nameInRequest": "indexName", + "doc": "The name of the index.", + "type": { + "$id": "10518", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10519", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "10520", + "kind": "constant", + "valueType": { + "$id": "10521", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "10522", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "2749" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/indexes('{indexName}')/docs('{key}')", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Documents.get", + "decorators": [], + "examples": [ + { + "$id": "10523", + "kind": "http", + "name": "SearchIndexGetDocument", + "description": "SearchIndexGetDocument", + "filePath": "2025-03-01-preview/SearchIndexGetDocument.json", + "parameters": [ + { + "$id": "10524", + "parameter": { + "$ref": "10517" + }, + "value": { + "$id": "10525", + "kind": "string", + "type": { + "$ref": "10518" + }, + "value": "preview-test" + } + }, + { + "$id": "10526", + "parameter": { + "$ref": "10509" + }, + "value": { + "$id": "10527", + "kind": "string", + "type": { + "$ref": "10510" + }, + "value": "1" + } + }, + { + "$id": "10528", + "parameter": { + "$ref": "10511" + }, + "value": { + "$id": "10529", + "kind": "array", + "type": { + "$ref": "10512" + }, + "value": [ + { + "$id": "10530", + "kind": "string", + "type": { + "$ref": "10513" + }, + "value": "id" + }, + { + "$id": "10531", + "kind": "string", + "type": { + "$ref": "10513" + }, + "value": "description" + }, + { + "$id": "10532", + "kind": "string", + "type": { + "$ref": "10513" + }, + "value": "name" + }, + { + "$id": "10533", + "kind": "string", + "type": { + "$ref": "10513" + }, + "value": "category" + }, + { + "$id": "10534", + "kind": "string", + "type": { + "$ref": "10513" + }, + "value": "ownerId" + } + ] + } + }, + { + "$id": "10535", + "parameter": { + "$ref": "10505" + }, + "value": { + "$id": "10536", + "kind": "string", + "type": { + "$ref": "10506" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "10537", + "parameter": { + "$ref": "10514" + }, + "value": { + "$id": "10538", + "kind": "string", + "type": { + "$ref": "10515" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + } + ], + "responses": [ + { + "$id": "10539", + "response": { + "$ref": "10522" + }, + "statusCode": 200, + "bodyValue": { + "$id": "10540", + "kind": "model", + "type": { + "$ref": "2749" + }, + "value": { + "$id": "10541" + }, + "additionalPropertiesValue": { + "$id": "10542", + "id": { + "$id": "10543", + "kind": "unknown", + "type": { + "$ref": "2750" + }, + "value": "1" + }, + "name": { + "$id": "10544", + "kind": "unknown", + "type": { + "$ref": "2750" + }, + "value": "test" + }, + "description": { + "$id": "10545", + "kind": "unknown", + "type": { + "$ref": "2750" + }, + "value": "test1 hello" + }, + "category": { + "$id": "10546", + "kind": "unknown", + "type": { + "$ref": "2750" + }, + "value": "purple" + }, + "ownerId": { + "$id": "10547", + "kind": "unknown", + "type": { + "$ref": "2750" + }, + "value": "sam" + } + } + } + } + ] + } + ] + }, + { + "$id": "10548", + "name": "suggestGet", + "resourceName": "Documents", + "doc": "Suggests documents in the index that match the given partial query text.", + "accessibility": "public", + "parameters": [ + { + "$id": "10549", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "10550", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "10551", + "type": { + "$id": "10552", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10553", + "name": "searchText", + "nameInRequest": "search", + "doc": "The search text to use to suggest documents. Must be at least 1 character, and\nno more than 100 characters.", + "type": { + "$id": "10554", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10555", + "name": "suggesterName", + "nameInRequest": "suggesterName", + "doc": "The name of the suggester as specified in the suggesters collection that's part\nof the index definition.", + "type": { + "$id": "10556", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10557", + "name": "$filter", + "nameInRequest": "$filter", + "doc": "An OData expression that filters the documents considered for suggestions.", + "type": { + "$id": "10558", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10559", + "name": "useFuzzyMatching", + "nameInRequest": "fuzzy", + "doc": "A value indicating whether to use fuzzy matching for the suggestions query.\nDefault is false. When set to true, the query will find terms even if there's a\nsubstituted or missing character in the search text. While this provides a\nbetter experience in some scenarios, it comes at a performance cost as fuzzy\nsuggestions queries are slower and consume more resources.", + "type": { + "$id": "10560", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10561", + "name": "highlightPostTag", + "nameInRequest": "highlightPostTag", + "doc": "A string tag that is appended to hit highlights. Must be set with\nhighlightPreTag. If omitted, hit highlighting of suggestions is disabled.", + "type": { + "$id": "10562", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10563", + "name": "highlightPreTag", + "nameInRequest": "highlightPreTag", + "doc": "A string tag that is prepended to hit highlights. Must be set with\nhighlightPostTag. If omitted, hit highlighting of suggestions is disabled.", + "type": { + "$id": "10564", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10565", + "name": "minimumCoverage", + "nameInRequest": "minimumCoverage", + "doc": "A number between 0 and 100 indicating the percentage of the index that must be\ncovered by a suggestions query in order for the query to be reported as a\nsuccess. This parameter can be useful for ensuring search availability even for\nservices with only one replica. The default is 80.", + "type": { + "$id": "10566", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10567", + "name": "orderBy", + "nameInRequest": "$orderby", + "doc": "The list of OData $orderby expressions by which to sort the results. Each\nexpression can be either a field name or a call to either the geo.distance() or\nthe search.score() functions. Each expression can be followed by asc to\nindicate ascending, or desc to indicate descending. The default is ascending\norder. Ties will be broken by the match scores of documents. If no $orderby is\nspecified, the default sort order is descending by document match score. There\ncan be at most 32 $orderby clauses.", + "type": { + "$id": "10568", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "10569", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "arraySerializationDelimiter": ",", + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10570", + "name": "searchFields", + "nameInRequest": "searchFields", + "doc": "The list of field names to search for the specified search text. Target fields\nmust be included in the specified suggester.", + "type": { + "$id": "10571", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "10572", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "arraySerializationDelimiter": ",", + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10573", + "name": "$select", + "nameInRequest": "$select", + "doc": "The list of fields to retrieve. If unspecified, only the key field will be\nincluded in the results.", + "type": { + "$id": "10574", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "10575", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "arraySerializationDelimiter": ",", + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10576", + "name": "$top", + "nameInRequest": "$top", + "doc": "The number of suggestions to retrieve. The value must be a number between 1 and\n100. The default is 5.", + "type": { + "$id": "10577", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10578", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "10579", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "10580", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10581", + "name": "indexName", + "nameInRequest": "indexName", + "doc": "The name of the index.", + "type": { + "$id": "10582", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10583", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "10584", + "kind": "constant", + "valueType": { + "$id": "10585", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "10586", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "2751" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/indexes('{indexName}')/docs/search.suggest", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Documents.suggestGet", + "decorators": [], + "examples": [ + { + "$id": "10587", + "kind": "http", + "name": "SearchIndexSuggestDocumentsGet", + "description": "SearchIndexSuggestDocumentsGet", + "filePath": "2025-03-01-preview/SearchIndexSuggestDocumentsGet.json", + "parameters": [ + { + "$id": "10588", + "parameter": { + "$ref": "10581" + }, + "value": { + "$id": "10589", + "kind": "string", + "type": { + "$ref": "10582" + }, + "value": "myindex" + } + }, + { + "$id": "10590", + "parameter": { + "$ref": "10549" + }, + "value": { + "$id": "10591", + "kind": "string", + "type": { + "$ref": "10550" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "10592", + "parameter": { + "$ref": "10557" + }, + "value": { + "$id": "10593", + "kind": "string", + "type": { + "$ref": "10558" + }, + "value": "rating gt 10" + } + }, + { + "$id": "10594", + "parameter": { + "$ref": "10559" + }, + "value": { + "$id": "10595", + "kind": "boolean", + "type": { + "$ref": "10560" + }, + "value": false + } + }, + { + "$id": "10596", + "parameter": { + "$ref": "10561" + }, + "value": { + "$id": "10597", + "kind": "string", + "type": { + "$ref": "10562" + }, + "value": "" + } + }, + { + "$id": "10598", + "parameter": { + "$ref": "10563" + }, + "value": { + "$id": "10599", + "kind": "string", + "type": { + "$ref": "10564" + }, + "value": "" + } + }, + { + "$id": "10600", + "parameter": { + "$ref": "10565" + }, + "value": { + "$id": "10601", + "kind": "number", + "type": { + "$ref": "10566" + }, + "value": 80 + } + }, + { + "$id": "10602", + "parameter": { + "$ref": "10567" + }, + "value": { + "$id": "10603", + "kind": "array", + "type": { + "$ref": "10568" + }, + "value": [ + { + "$id": "10604", + "kind": "string", + "type": { + "$ref": "10569" + }, + "value": "search.score() desc" + }, + { + "$id": "10605", + "kind": "string", + "type": { + "$ref": "10569" + }, + "value": "rating desc" + } + ] + } + }, + { + "$id": "10606", + "parameter": { + "$ref": "10553" + }, + "value": { + "$id": "10607", + "kind": "string", + "type": { + "$ref": "10554" + }, + "value": "hote" + } + }, + { + "$id": "10608", + "parameter": { + "$ref": "10570" + }, + "value": { + "$id": "10609", + "kind": "array", + "type": { + "$ref": "10571" + }, + "value": [ + { + "$id": "10610", + "kind": "string", + "type": { + "$ref": "10572" + }, + "value": "title" + } + ] + } + }, + { + "$id": "10611", + "parameter": { + "$ref": "10555" + }, + "value": { + "$id": "10612", + "kind": "string", + "type": { + "$ref": "10556" + }, + "value": "sg" + } + }, + { + "$id": "10613", + "parameter": { + "$ref": "10573" + }, + "value": { + "$id": "10614", + "kind": "array", + "type": { + "$ref": "10574" + }, + "value": [ + { + "$id": "10615", + "kind": "string", + "type": { + "$ref": "10575" + }, + "value": "docId" + }, + { + "$id": "10616", + "kind": "string", + "type": { + "$ref": "10575" + }, + "value": "title" + }, + { + "$id": "10617", + "kind": "string", + "type": { + "$ref": "10575" + }, + "value": "description" + } + ] + } + }, + { + "$id": "10618", + "parameter": { + "$ref": "10576" + }, + "value": { + "$id": "10619", + "kind": "number", + "type": { + "$ref": "10577" + }, + "value": 10 + } + } + ], + "responses": [ + { + "$id": "10620", + "response": { + "$ref": "10586" + }, + "statusCode": 200, + "bodyValue": { + "$id": "10621", + "kind": "model", + "type": { + "$ref": "2751" + }, + "value": { + "$id": "10622", + "value": { + "$id": "10623", + "kind": "array", + "type": { + "$ref": "2753" + }, + "value": [ + { + "$id": "10624", + "kind": "model", + "type": { + "$ref": "2754" + }, + "value": { + "$id": "10625", + "@search.text": { + "$id": "10626", + "kind": "string", + "type": { + "$ref": "2757" + }, + "value": "Nice Hotel" + } + }, + "additionalPropertiesValue": { + "$id": "10627", + "description": { + "$id": "10628", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "Cheapest hotel in town" + }, + "docId": { + "$id": "10629", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "1" + }, + "title": { + "$id": "10630", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "Nice Hotel" + } + } + }, + { + "$id": "10631", + "kind": "model", + "type": { + "$ref": "2754" + }, + "value": { + "$id": "10632", + "@search.text": { + "$id": "10633", + "kind": "string", + "type": { + "$ref": "2757" + }, + "value": "Fancy Hotel" + } + }, + "additionalPropertiesValue": { + "$id": "10634", + "description": { + "$id": "10635", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "Best hotel in town" + }, + "docId": { + "$id": "10636", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "2" + }, + "title": { + "$id": "10637", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "Fancy Hotel" + } + } + } + ] + } + } + } + } + ] + } + ] + }, + { + "$id": "10638", + "name": "suggestPost", + "resourceName": "Documents", + "doc": "Suggests documents in the index that match the given partial query text.", + "accessibility": "public", + "parameters": [ + { + "$id": "10639", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "10640", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "10641", + "type": { + "$id": "10642", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10643", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "10644", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "10645", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10646", + "name": "indexName", + "nameInRequest": "indexName", + "doc": "The name of the index.", + "type": { + "$id": "10647", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10648", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "10649", + "kind": "constant", + "valueType": { + "$id": "10650", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10651", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "10652", + "kind": "constant", + "valueType": { + "$id": "10653", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10654", + "name": "suggestRequest", + "nameInRequest": "suggestRequest", + "doc": "The Suggest request.", + "type": { + "$ref": "2766" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "10655", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "2751" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "POST", + "uri": "{endpoint}", + "path": "/indexes('{indexName}')/docs/search.post.suggest", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Documents.suggestPost", + "decorators": [], + "examples": [ + { + "$id": "10656", + "kind": "http", + "name": "SearchIndexSuggestDocumentsPost", + "description": "SearchIndexSuggestDocumentsPost", + "filePath": "2025-03-01-preview/SearchIndexSuggestDocumentsPost.json", + "parameters": [ + { + "$id": "10657", + "parameter": { + "$ref": "10646" + }, + "value": { + "$id": "10658", + "kind": "string", + "type": { + "$ref": "10647" + }, + "value": "preview-test" + } + }, + { + "$id": "10659", + "parameter": { + "$ref": "10639" + }, + "value": { + "$id": "10660", + "kind": "string", + "type": { + "$ref": "10640" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "10661", + "parameter": { + "$ref": "10643" + }, + "value": { + "$id": "10662", + "kind": "string", + "type": { + "$ref": "10644" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "10663", + "parameter": { + "$ref": "10654" + }, + "value": { + "$id": "10664", + "kind": "model", + "type": { + "$ref": "2766" + }, + "value": { + "$id": "10665", + "filter": { + "$id": "10666", + "kind": "string", + "type": { + "$ref": "2768" + }, + "value": "ownerId eq 'sam' and id lt '15'" + }, + "fuzzy": { + "$id": "10667", + "kind": "boolean", + "type": { + "$ref": "2772" + }, + "value": true + }, + "highlightPostTag": { + "$id": "10668", + "kind": "string", + "type": { + "$ref": "2776" + }, + "value": "" + }, + "highlightPreTag": { + "$id": "10669", + "kind": "string", + "type": { + "$ref": "2780" + }, + "value": "" + }, + "minimumCoverage": { + "$id": "10670", + "kind": "number", + "type": { + "$ref": "2784" + }, + "value": 80 + }, + "orderby": { + "$id": "10671", + "kind": "string", + "type": { + "$ref": "2788" + }, + "value": "id desc" + }, + "search": { + "$id": "10672", + "kind": "string", + "type": { + "$ref": "2792" + }, + "value": "p" + }, + "searchFields": { + "$id": "10673", + "kind": "string", + "type": { + "$ref": "2796" + }, + "value": "category" + }, + "select": { + "$id": "10674", + "kind": "string", + "type": { + "$ref": "2800" + }, + "value": "id,name,category,ownerId" + }, + "suggesterName": { + "$id": "10675", + "kind": "string", + "type": { + "$ref": "2804" + }, + "value": "sg" + }, + "top": { + "$id": "10676", + "kind": "number", + "type": { + "$ref": "2808" + }, + "value": 10 + } + } + } + } + ], + "responses": [ + { + "$id": "10677", + "response": { + "$ref": "10655" + }, + "statusCode": 200, + "bodyValue": { + "$id": "10678", + "kind": "model", + "type": { + "$ref": "2751" + }, + "value": { + "$id": "10679", + "@search.coverage": { + "$id": "10680", + "kind": "number", + "type": { + "$ref": "2763" + }, + "value": 100 + }, + "value": { + "$id": "10681", + "kind": "array", + "type": { + "$ref": "2753" + }, + "value": [ + { + "$id": "10682", + "kind": "model", + "type": { + "$ref": "2754" + }, + "value": { + "$id": "10683", + "@search.text": { + "$id": "10684", + "kind": "string", + "type": { + "$ref": "2757" + }, + "value": "purple" + } + }, + "additionalPropertiesValue": { + "$id": "10685", + "id": { + "$id": "10686", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "14" + }, + "name": { + "$id": "10687", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "test" + }, + "category": { + "$id": "10688", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "purple" + }, + "ownerId": { + "$id": "10689", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "sam" + } + } + }, + { + "$id": "10690", + "kind": "model", + "type": { + "$ref": "2754" + }, + "value": { + "$id": "10691", + "@search.text": { + "$id": "10692", + "kind": "string", + "type": { + "$ref": "2757" + }, + "value": "purple" + } + }, + "additionalPropertiesValue": { + "$id": "10693", + "id": { + "$id": "10694", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "13" + }, + "name": { + "$id": "10695", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "test" + }, + "category": { + "$id": "10696", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "purple" + }, + "ownerId": { + "$id": "10697", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "sam" + } + } + }, + { + "$id": "10698", + "kind": "model", + "type": { + "$ref": "2754" + }, + "value": { + "$id": "10699", + "@search.text": { + "$id": "10700", + "kind": "string", + "type": { + "$ref": "2757" + }, + "value": "purple" + } + }, + "additionalPropertiesValue": { + "$id": "10701", + "id": { + "$id": "10702", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "11" + }, + "name": { + "$id": "10703", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "test" + }, + "category": { + "$id": "10704", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "purple" + }, + "ownerId": { + "$id": "10705", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "sam" + } + } + }, + { + "$id": "10706", + "kind": "model", + "type": { + "$ref": "2754" + }, + "value": { + "$id": "10707", + "@search.text": { + "$id": "10708", + "kind": "string", + "type": { + "$ref": "2757" + }, + "value": "purple" + } + }, + "additionalPropertiesValue": { + "$id": "10709", + "id": { + "$id": "10710", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "1" + }, + "name": { + "$id": "10711", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "test" + }, + "category": { + "$id": "10712", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "purple" + }, + "ownerId": { + "$id": "10713", + "kind": "unknown", + "type": { + "$ref": "2755" + }, + "value": "sam" + } + } + } + ] + } + } + } + } + ] + } + ] + }, + { + "$id": "10714", + "name": "index", + "resourceName": "Documents", + "doc": "Sends a batch of document write actions to the index.", + "accessibility": "public", + "parameters": [ + { + "$id": "10715", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "10716", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "10717", + "type": { + "$id": "10718", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10719", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "10720", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "10721", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10722", + "name": "indexName", + "nameInRequest": "indexName", + "doc": "The name of the index.", + "type": { + "$id": "10723", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10724", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "10725", + "kind": "constant", + "valueType": { + "$id": "10726", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10727", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "10728", + "kind": "constant", + "valueType": { + "$id": "10729", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "10730", + "name": "batch", + "nameInRequest": "batch", + "doc": "The batch of index actions.", + "type": { + "$ref": "2811" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "10731", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "2821" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + }, + { + "$id": "10732", + "statusCodes": [ + 207 + ], + "bodyType": { + "$ref": "2821" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "POST", + "uri": "{endpoint}", + "path": "/indexes('{indexName}')/docs/search.index", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Documents.index", + "decorators": [], + "examples": [ + { + "$id": "10733", + "kind": "http", + "name": "SearchIndexIndexDocuments", + "description": "SearchIndexIndexDocuments", + "filePath": "2025-03-01-preview/SearchIndexIndexDocuments.json", + "parameters": [ + { + "$id": "10734", + "parameter": { + "$ref": "10722" + }, + "value": { + "$id": "10735", + "kind": "string", + "type": { + "$ref": "10723" + }, + "value": "preview-test" + } + }, + { + "$id": "10736", + "parameter": { + "$ref": "10715" + }, + "value": { + "$id": "10737", + "kind": "string", + "type": { + "$ref": "10716" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "10738", + "parameter": { + "$ref": "10719" + }, + "value": { + "$id": "10739", + "kind": "string", + "type": { + "$ref": "10720" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "10740", + "parameter": { + "$ref": "10730" + }, + "value": { + "$id": "10741", + "kind": "model", + "type": { + "$ref": "2811" + }, + "value": { + "$id": "10742", + "value": { + "$id": "10743", + "kind": "array", + "type": { + "$ref": "2813" + }, + "value": [ + { + "$id": "10744", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10745", + "@search.action": { + "$id": "10746", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10747", + "id": { + "$id": "10748", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "0" + }, + "name": { + "$id": "10749", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10750", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test0 hello" + }, + "vector1": { + "$id": "10751", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 0, + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19 + ] + }, + "vector1b": { + "$id": "10752", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19 + ] + }, + "vector2": { + "$id": "10753", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 0, + 1, + 2, + 3, + 4 + ] + }, + "vector3": { + "$id": "10754", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 0, + 1, + 2, + 3, + 4 + ] + }, + "vector22": { + "$id": "10755", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29 + ] + }, + "ownerId": { + "$id": "10756", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "benny" + }, + "category": { + "$id": "10757", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10758", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 0 + } + } + }, + { + "$id": "10759", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10760", + "@search.action": { + "$id": "10761", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10762", + "id": { + "$id": "10763", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "1" + }, + "name": { + "$id": "10764", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10765", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test1 hello" + }, + "vector1": { + "$id": "10766", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 1, + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20 + ] + }, + "vector1b": { + "$id": "10767", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20 + ] + }, + "vector2": { + "$id": "10768", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 1, + 2, + 3, + 4, + 5 + ] + }, + "vector3": { + "$id": "10769", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 1, + 2, + 3, + 4, + 5 + ] + }, + "vector22": { + "$id": "10770", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30 + ] + }, + "ownerId": { + "$id": "10771", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "10772", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10773", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 1 + } + } + }, + { + "$id": "10774", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10775", + "@search.action": { + "$id": "10776", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10777", + "id": { + "$id": "10778", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "2" + }, + "name": { + "$id": "10779", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10780", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test2 hello" + }, + "vector1": { + "$id": "10781", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 2, + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21 + ] + }, + "vector1b": { + "$id": "10782", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21 + ] + }, + "vector2": { + "$id": "10783", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 2, + 3, + 4, + 5, + 6 + ] + }, + "vector3": { + "$id": "10784", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 2, + 3, + 4, + 5, + 6 + ] + }, + "vector22": { + "$id": "10785", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31 + ] + }, + "ownerId": { + "$id": "10786", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "10787", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10788", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 2 + } + } + }, + { + "$id": "10789", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10790", + "@search.action": { + "$id": "10791", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10792", + "id": { + "$id": "10793", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "3" + }, + "name": { + "$id": "10794", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10795", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test3 hello" + }, + "vector1": { + "$id": "10796", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 3, + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22 + ] + }, + "vector1b": { + "$id": "10797", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22 + ] + }, + "vector2": { + "$id": "10798", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 3, + 4, + 5, + 6, + 7 + ] + }, + "vector3": { + "$id": "10799", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 3, + 4, + 5, + 6, + 7 + ] + }, + "vector22": { + "$id": "10800", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32 + ] + }, + "ownerId": { + "$id": "10801", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "ryan" + }, + "category": { + "$id": "10802", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10803", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 3 + } + } + }, + { + "$id": "10804", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10805", + "@search.action": { + "$id": "10806", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10807", + "id": { + "$id": "10808", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "4" + }, + "name": { + "$id": "10809", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10810", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test4 hello" + }, + "vector1": { + "$id": "10811", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 4, + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23 + ] + }, + "vector1b": { + "$id": "10812", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23 + ] + }, + "vector2": { + "$id": "10813", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 4, + 5, + 6, + 7, + 8 + ] + }, + "vector3": { + "$id": "10814", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 4, + 5, + 6, + 7, + 8 + ] + }, + "vector22": { + "$id": "10815", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33 + ] + }, + "ownerId": { + "$id": "10816", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "10817", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10818", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 4 + } + } + }, + { + "$id": "10819", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10820", + "@search.action": { + "$id": "10821", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10822", + "id": { + "$id": "10823", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "5" + }, + "name": { + "$id": "10824", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10825", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test5 hello" + }, + "vector1": { + "$id": "10826", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 5, + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24 + ] + }, + "vector1b": { + "$id": "10827", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24 + ] + }, + "vector2": { + "$id": "10828", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 5, + 6, + 7, + 8, + 9 + ] + }, + "vector3": { + "$id": "10829", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 5, + 6, + 7, + 8, + 9 + ] + }, + "vector22": { + "$id": "10830", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34 + ] + }, + "ownerId": { + "$id": "10831", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "10832", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10833", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 5 + } + } + }, + { + "$id": "10834", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10835", + "@search.action": { + "$id": "10836", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10837", + "id": { + "$id": "10838", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "6" + }, + "name": { + "$id": "10839", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10840", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test6 hello" + }, + "vector1": { + "$id": "10841", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 6, + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25 + ] + }, + "vector1b": { + "$id": "10842", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25 + ] + }, + "vector2": { + "$id": "10843", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 6, + 7, + 8, + 9, + 10 + ] + }, + "vector3": { + "$id": "10844", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 6, + 7, + 8, + 9, + 10 + ] + }, + "vector22": { + "$id": "10845", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35 + ] + }, + "ownerId": { + "$id": "10846", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "ryan" + }, + "category": { + "$id": "10847", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10848", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 6 + } + } + }, + { + "$id": "10849", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10850", + "@search.action": { + "$id": "10851", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10852", + "id": { + "$id": "10853", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "7" + }, + "name": { + "$id": "10854", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10855", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test7 hello" + }, + "vector1": { + "$id": "10856", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 7, + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26 + ] + }, + "vector1b": { + "$id": "10857", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26 + ] + }, + "vector2": { + "$id": "10858", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 7, + 8, + 9, + 10, + 11 + ] + }, + "vector3": { + "$id": "10859", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 7, + 8, + 9, + 10, + 11 + ] + }, + "vector22": { + "$id": "10860", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36 + ] + }, + "ownerId": { + "$id": "10861", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "10862", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10863", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 7 + } + } + }, + { + "$id": "10864", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10865", + "@search.action": { + "$id": "10866", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10867", + "id": { + "$id": "10868", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "8" + }, + "name": { + "$id": "10869", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10870", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test8 hello" + }, + "vector1": { + "$id": "10871", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 8, + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27 + ] + }, + "vector1b": { + "$id": "10872", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27 + ] + }, + "vector2": { + "$id": "10873", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 8, + 9, + 10, + 11, + 12 + ] + }, + "vector3": { + "$id": "10874", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 8, + 9, + 10, + 11, + 12 + ] + }, + "vector22": { + "$id": "10875", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37 + ] + }, + "ownerId": { + "$id": "10876", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "10877", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10878", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 8 + } + } + }, + { + "$id": "10879", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10880", + "@search.action": { + "$id": "10881", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10882", + "id": { + "$id": "10883", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "9" + }, + "name": { + "$id": "10884", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10885", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test9 hello" + }, + "vector1": { + "$id": "10886", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 9, + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28 + ] + }, + "vector1b": { + "$id": "10887", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28 + ] + }, + "vector2": { + "$id": "10888", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 9, + 10, + 11, + 12, + 13 + ] + }, + "vector3": { + "$id": "10889", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 9, + 10, + 11, + 12, + 13 + ] + }, + "vector22": { + "$id": "10890", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38 + ] + }, + "ownerId": { + "$id": "10891", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "ryan" + }, + "category": { + "$id": "10892", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10893", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 9 + } + } + }, + { + "$id": "10894", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10895", + "@search.action": { + "$id": "10896", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10897", + "id": { + "$id": "10898", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "10" + }, + "name": { + "$id": "10899", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10900", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test10 hello" + }, + "vector1": { + "$id": "10901", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 10, + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29 + ] + }, + "vector1b": { + "$id": "10902", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29 + ] + }, + "vector2": { + "$id": "10903", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 10, + 11, + 12, + 13, + 14 + ] + }, + "vector3": { + "$id": "10904", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 10, + 11, + 12, + 13, + 14 + ] + }, + "vector22": { + "$id": "10905", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39 + ] + }, + "ownerId": { + "$id": "10906", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "benny" + }, + "category": { + "$id": "10907", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10908", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 10 + } + } + }, + { + "$id": "10909", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10910", + "@search.action": { + "$id": "10911", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10912", + "id": { + "$id": "10913", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "11" + }, + "name": { + "$id": "10914", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10915", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test11 hello" + }, + "vector1": { + "$id": "10916", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 11, + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30 + ] + }, + "vector1b": { + "$id": "10917", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30 + ] + }, + "vector2": { + "$id": "10918", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 11, + 12, + 13, + 14, + 15 + ] + }, + "vector3": { + "$id": "10919", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 11, + 12, + 13, + 14, + 15 + ] + }, + "vector22": { + "$id": "10920", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40 + ] + }, + "ownerId": { + "$id": "10921", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "10922", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10923", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 11 + } + } + }, + { + "$id": "10924", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10925", + "@search.action": { + "$id": "10926", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10927", + "id": { + "$id": "10928", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "12" + }, + "name": { + "$id": "10929", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10930", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test12 hello" + }, + "vector1": { + "$id": "10931", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 12, + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31 + ] + }, + "vector1b": { + "$id": "10932", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31 + ] + }, + "vector2": { + "$id": "10933", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 12, + 13, + 14, + 15, + 16 + ] + }, + "vector3": { + "$id": "10934", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 12, + 13, + 14, + 15, + 16 + ] + }, + "vector22": { + "$id": "10935", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41 + ] + }, + "ownerId": { + "$id": "10936", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "ryan" + }, + "category": { + "$id": "10937", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10938", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 12 + } + } + }, + { + "$id": "10939", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10940", + "@search.action": { + "$id": "10941", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10942", + "id": { + "$id": "10943", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "13" + }, + "name": { + "$id": "10944", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10945", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test13 hello" + }, + "vector1": { + "$id": "10946", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 13, + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32 + ] + }, + "vector1b": { + "$id": "10947", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32 + ] + }, + "vector2": { + "$id": "10948", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 13, + 14, + 15, + 16, + 17 + ] + }, + "vector3": { + "$id": "10949", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 13, + 14, + 15, + 16, + 17 + ] + }, + "vector22": { + "$id": "10950", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42 + ] + }, + "ownerId": { + "$id": "10951", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "10952", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10953", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 13 + } + } + }, + { + "$id": "10954", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10955", + "@search.action": { + "$id": "10956", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10957", + "id": { + "$id": "10958", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "14" + }, + "name": { + "$id": "10959", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10960", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test14 hello" + }, + "vector1": { + "$id": "10961", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 14, + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33 + ] + }, + "vector1b": { + "$id": "10962", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33 + ] + }, + "vector2": { + "$id": "10963", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 14, + 15, + 16, + 17, + 18 + ] + }, + "vector3": { + "$id": "10964", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 14, + 15, + 16, + 17, + 18 + ] + }, + "vector22": { + "$id": "10965", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43 + ] + }, + "ownerId": { + "$id": "10966", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "10967", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10968", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 14 + } + } + }, + { + "$id": "10969", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10970", + "@search.action": { + "$id": "10971", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10972", + "id": { + "$id": "10973", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "15" + }, + "name": { + "$id": "10974", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10975", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test15 hello" + }, + "vector1": { + "$id": "10976", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 15, + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34 + ] + }, + "vector1b": { + "$id": "10977", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34 + ] + }, + "vector2": { + "$id": "10978", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 15, + 16, + 17, + 18, + 19 + ] + }, + "vector3": { + "$id": "10979", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 15, + 16, + 17, + 18, + 19 + ] + }, + "vector22": { + "$id": "10980", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44 + ] + }, + "ownerId": { + "$id": "10981", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "ryan" + }, + "category": { + "$id": "10982", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10983", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 15 + } + } + }, + { + "$id": "10984", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "10985", + "@search.action": { + "$id": "10986", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "10987", + "id": { + "$id": "10988", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "16" + }, + "name": { + "$id": "10989", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "10990", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test16 hello" + }, + "vector1": { + "$id": "10991", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 16, + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35 + ] + }, + "vector1b": { + "$id": "10992", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35 + ] + }, + "vector2": { + "$id": "10993", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 16, + 17, + 18, + 19, + 20 + ] + }, + "vector3": { + "$id": "10994", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 16, + 17, + 18, + 19, + 20 + ] + }, + "vector22": { + "$id": "10995", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45 + ] + }, + "ownerId": { + "$id": "10996", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "10997", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "10998", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 16 + } + } + }, + { + "$id": "10999", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11000", + "@search.action": { + "$id": "11001", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11002", + "id": { + "$id": "11003", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "17" + }, + "name": { + "$id": "11004", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11005", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test17 hello" + }, + "vector1": { + "$id": "11006", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 17, + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36 + ] + }, + "vector1b": { + "$id": "11007", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36 + ] + }, + "vector2": { + "$id": "11008", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 17, + 18, + 19, + 20, + 21 + ] + }, + "vector3": { + "$id": "11009", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 17, + 18, + 19, + 20, + 21 + ] + }, + "vector22": { + "$id": "11010", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46 + ] + }, + "ownerId": { + "$id": "11011", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11012", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "11013", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 17 + } + } + }, + { + "$id": "11014", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11015", + "@search.action": { + "$id": "11016", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11017", + "id": { + "$id": "11018", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "18" + }, + "name": { + "$id": "11019", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11020", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test18 hello" + }, + "vector1": { + "$id": "11021", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 18, + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37 + ] + }, + "vector1b": { + "$id": "11022", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37 + ] + }, + "vector2": { + "$id": "11023", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 18, + 19, + 20, + 21, + 22 + ] + }, + "vector3": { + "$id": "11024", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 18, + 19, + 20, + 21, + 22 + ] + }, + "vector22": { + "$id": "11025", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47 + ] + }, + "ownerId": { + "$id": "11026", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "ryan" + }, + "category": { + "$id": "11027", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "11028", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 18 + } + } + }, + { + "$id": "11029", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11030", + "@search.action": { + "$id": "11031", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11032", + "id": { + "$id": "11033", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "19" + }, + "name": { + "$id": "11034", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11035", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test19 hello" + }, + "vector1": { + "$id": "11036", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 19, + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38 + ] + }, + "vector1b": { + "$id": "11037", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38 + ] + }, + "vector2": { + "$id": "11038", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 19, + 20, + 21, + 22, + 23 + ] + }, + "vector3": { + "$id": "11039", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 19, + 20, + 21, + 22, + 23 + ] + }, + "vector22": { + "$id": "11040", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48 + ] + }, + "ownerId": { + "$id": "11041", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11042", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "11043", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 19 + } + } + }, + { + "$id": "11044", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11045", + "@search.action": { + "$id": "11046", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11047", + "id": { + "$id": "11048", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "20" + }, + "name": { + "$id": "11049", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11050", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test20 hello" + }, + "vector1": { + "$id": "11051", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 20, + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39 + ] + }, + "vector1b": { + "$id": "11052", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39 + ] + }, + "vector2": { + "$id": "11053", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 20, + 21, + 22, + 23, + 24 + ] + }, + "vector3": { + "$id": "11054", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 20, + 21, + 22, + 23, + 24 + ] + }, + "vector22": { + "$id": "11055", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49 + ] + }, + "ownerId": { + "$id": "11056", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "benny" + }, + "category": { + "$id": "11057", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "11058", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 20 + } + } + }, + { + "$id": "11059", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11060", + "@search.action": { + "$id": "11061", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11062", + "id": { + "$id": "11063", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "21" + }, + "name": { + "$id": "11064", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11065", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test21 hello" + }, + "vector1": { + "$id": "11066", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 21, + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40 + ] + }, + "vector1b": { + "$id": "11067", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40 + ] + }, + "vector2": { + "$id": "11068", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 21, + 22, + 23, + 24, + 25 + ] + }, + "vector3": { + "$id": "11069", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 21, + 22, + 23, + 24, + 25 + ] + }, + "vector22": { + "$id": "11070", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50 + ] + }, + "ownerId": { + "$id": "11071", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "ryan" + }, + "category": { + "$id": "11072", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "11073", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 21 + } + } + }, + { + "$id": "11074", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11075", + "@search.action": { + "$id": "11076", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11077", + "id": { + "$id": "11078", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "22" + }, + "name": { + "$id": "11079", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11080", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test22 hello" + }, + "vector1": { + "$id": "11081", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 22, + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41 + ] + }, + "vector1b": { + "$id": "11082", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41 + ] + }, + "vector2": { + "$id": "11083", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 22, + 23, + 24, + 25, + 26 + ] + }, + "vector3": { + "$id": "11084", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 22, + 23, + 24, + 25, + 26 + ] + }, + "vector22": { + "$id": "11085", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51 + ] + }, + "ownerId": { + "$id": "11086", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11087", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "11088", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 22 + } + } + }, + { + "$id": "11089", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11090", + "@search.action": { + "$id": "11091", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11092", + "id": { + "$id": "11093", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "23" + }, + "name": { + "$id": "11094", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11095", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test23 hello" + }, + "vector1": { + "$id": "11096", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 23, + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42 + ] + }, + "vector1b": { + "$id": "11097", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42 + ] + }, + "vector2": { + "$id": "11098", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 23, + 24, + 25, + 26, + 27 + ] + }, + "vector3": { + "$id": "11099", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 23, + 24, + 25, + 26, + 27 + ] + }, + "vector22": { + "$id": "11100", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52 + ] + }, + "ownerId": { + "$id": "11101", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11102", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "11103", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 23 + } + } + }, + { + "$id": "11104", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11105", + "@search.action": { + "$id": "11106", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11107", + "id": { + "$id": "11108", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "24" + }, + "name": { + "$id": "11109", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11110", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test24 hello" + }, + "vector1": { + "$id": "11111", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 24, + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43 + ] + }, + "vector1b": { + "$id": "11112", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43 + ] + }, + "vector2": { + "$id": "11113", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 24, + 25, + 26, + 27, + 28 + ] + }, + "vector3": { + "$id": "11114", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 24, + 25, + 26, + 27, + 28 + ] + }, + "vector22": { + "$id": "11115", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53 + ] + }, + "ownerId": { + "$id": "11116", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "ryan" + }, + "category": { + "$id": "11117", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + }, + "price": { + "$id": "11118", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 24 + } + } + }, + { + "$id": "11119", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11120", + "@search.action": { + "$id": "11121", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11122", + "id": { + "$id": "11123", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "25" + }, + "name": { + "$id": "11124", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11125", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test25 hello" + }, + "vector1": { + "$id": "11126", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 25, + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44 + ] + }, + "vector1b": { + "$id": "11127", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44 + ] + }, + "vector2": { + "$id": "11128", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 25, + 26, + 27, + 28, + 29 + ] + }, + "vector3": { + "$id": "11129", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 25, + 26, + 27, + 28, + 29 + ] + }, + "vector22": { + "$id": "11130", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54 + ] + }, + "ownerId": { + "$id": "11131", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11132", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "pink" + }, + "price": { + "$id": "11133", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 25 + } + } + }, + { + "$id": "11134", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11135", + "@search.action": { + "$id": "11136", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11137", + "id": { + "$id": "11138", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "26" + }, + "name": { + "$id": "11139", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11140", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test26 hello" + }, + "vector1": { + "$id": "11141", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 26, + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45 + ] + }, + "vector1b": { + "$id": "11142", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45 + ] + }, + "vector2": { + "$id": "11143", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 26, + 27, + 28, + 29, + 30 + ] + }, + "vector3": { + "$id": "11144", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 26, + 27, + 28, + 29, + 30 + ] + }, + "vector22": { + "$id": "11145", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55 + ] + }, + "ownerId": { + "$id": "11146", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11147", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "pink" + }, + "price": { + "$id": "11148", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 26 + } + } + }, + { + "$id": "11149", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11150", + "@search.action": { + "$id": "11151", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11152", + "id": { + "$id": "11153", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "27" + }, + "name": { + "$id": "11154", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11155", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test27 hello" + }, + "vector1": { + "$id": "11156", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 27, + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46 + ] + }, + "vector1b": { + "$id": "11157", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46 + ] + }, + "vector2": { + "$id": "11158", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 27, + 28, + 29, + 30, + 31 + ] + }, + "vector3": { + "$id": "11159", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 27, + 28, + 29, + 30, + 31 + ] + }, + "vector22": { + "$id": "11160", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56 + ] + }, + "ownerId": { + "$id": "11161", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "ryan" + }, + "category": { + "$id": "11162", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "pink" + }, + "price": { + "$id": "11163", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 27 + } + } + }, + { + "$id": "11164", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11165", + "@search.action": { + "$id": "11166", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11167", + "id": { + "$id": "11168", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "28" + }, + "name": { + "$id": "11169", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11170", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test28 hello" + }, + "vector1": { + "$id": "11171", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 28, + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47 + ] + }, + "vector1b": { + "$id": "11172", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47 + ] + }, + "vector2": { + "$id": "11173", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 28, + 29, + 30, + 31, + 32 + ] + }, + "vector3": { + "$id": "11174", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 28, + 29, + 30, + 31, + 32 + ] + }, + "vector22": { + "$id": "11175", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57 + ] + }, + "ownerId": { + "$id": "11176", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11177", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "pink" + }, + "price": { + "$id": "11178", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 28 + } + } + }, + { + "$id": "11179", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11180", + "@search.action": { + "$id": "11181", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11182", + "id": { + "$id": "11183", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "29" + }, + "name": { + "$id": "11184", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11185", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test29 hello" + }, + "vector1": { + "$id": "11186", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 29, + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48 + ] + }, + "vector1b": { + "$id": "11187", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48 + ] + }, + "vector2": { + "$id": "11188", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 29, + 30, + 31, + 32, + 33 + ] + }, + "vector3": { + "$id": "11189", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 29, + 30, + 31, + 32, + 33 + ] + }, + "vector22": { + "$id": "11190", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58 + ] + }, + "ownerId": { + "$id": "11191", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11192", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "pink" + }, + "price": { + "$id": "11193", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 29 + } + } + }, + { + "$id": "11194", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11195", + "@search.action": { + "$id": "11196", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11197", + "id": { + "$id": "11198", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "30" + }, + "name": { + "$id": "11199", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11200", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test30 hello" + }, + "vector1": { + "$id": "11201", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 30, + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49 + ] + }, + "vector1b": { + "$id": "11202", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49 + ] + }, + "vector2": { + "$id": "11203", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 30, + 31, + 32, + 33, + 34 + ] + }, + "vector3": { + "$id": "11204", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 30, + 31, + 32, + 33, + 34 + ] + }, + "vector22": { + "$id": "11205", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59 + ] + }, + "ownerId": { + "$id": "11206", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "benny" + }, + "category": { + "$id": "11207", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "pink" + }, + "price": { + "$id": "11208", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 30 + } + } + }, + { + "$id": "11209", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11210", + "@search.action": { + "$id": "11211", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11212", + "id": { + "$id": "11213", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "31" + }, + "name": { + "$id": "11214", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11215", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test31 hello" + }, + "vector1": { + "$id": "11216", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 31, + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50 + ] + }, + "vector1b": { + "$id": "11217", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50 + ] + }, + "vector2": { + "$id": "11218", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 31, + 32, + 33, + 34, + 35 + ] + }, + "vector3": { + "$id": "11219", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 31, + 32, + 33, + 34, + 35 + ] + }, + "vector22": { + "$id": "11220", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60 + ] + }, + "ownerId": { + "$id": "11221", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11222", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "pink" + }, + "price": { + "$id": "11223", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 31 + } + } + }, + { + "$id": "11224", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11225", + "@search.action": { + "$id": "11226", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11227", + "id": { + "$id": "11228", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "32" + }, + "name": { + "$id": "11229", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11230", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test32 hello" + }, + "vector1": { + "$id": "11231", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 32, + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51 + ] + }, + "vector1b": { + "$id": "11232", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51 + ] + }, + "vector2": { + "$id": "11233", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 32, + 33, + 34, + 35, + 36 + ] + }, + "vector3": { + "$id": "11234", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 32, + 33, + 34, + 35, + 36 + ] + }, + "vector22": { + "$id": "11235", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61 + ] + }, + "ownerId": { + "$id": "11236", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11237", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "pink" + }, + "price": { + "$id": "11238", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 32 + } + } + }, + { + "$id": "11239", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11240", + "@search.action": { + "$id": "11241", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11242", + "id": { + "$id": "11243", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "33" + }, + "name": { + "$id": "11244", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11245", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test33 hello" + }, + "vector1": { + "$id": "11246", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 33, + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52 + ] + }, + "vector1b": { + "$id": "11247", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52 + ] + }, + "vector2": { + "$id": "11248", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 33, + 34, + 35, + 36, + 37 + ] + }, + "vector3": { + "$id": "11249", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 33, + 34, + 35, + 36, + 37 + ] + }, + "vector22": { + "$id": "11250", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62 + ] + }, + "ownerId": { + "$id": "11251", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "ryan" + }, + "category": { + "$id": "11252", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "pink" + }, + "price": { + "$id": "11253", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 33 + } + } + }, + { + "$id": "11254", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11255", + "@search.action": { + "$id": "11256", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11257", + "id": { + "$id": "11258", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "34" + }, + "name": { + "$id": "11259", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11260", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test34 hello" + }, + "vector1": { + "$id": "11261", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 34, + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53 + ] + }, + "vector1b": { + "$id": "11262", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53 + ] + }, + "vector2": { + "$id": "11263", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 34, + 35, + 36, + 37, + 38 + ] + }, + "vector3": { + "$id": "11264", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 34, + 35, + 36, + 37, + 38 + ] + }, + "vector22": { + "$id": "11265", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63 + ] + }, + "ownerId": { + "$id": "11266", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11267", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "pink" + }, + "price": { + "$id": "11268", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 34 + } + } + }, + { + "$id": "11269", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11270", + "@search.action": { + "$id": "11271", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11272", + "id": { + "$id": "11273", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "35" + }, + "name": { + "$id": "11274", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11275", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test35 hello" + }, + "vector1": { + "$id": "11276", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 35, + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54 + ] + }, + "vector1b": { + "$id": "11277", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54 + ] + }, + "vector2": { + "$id": "11278", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 35, + 36, + 37, + 38, + 39 + ] + }, + "vector3": { + "$id": "11279", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 35, + 36, + 37, + 38, + 39 + ] + }, + "vector22": { + "$id": "11280", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64 + ] + }, + "ownerId": { + "$id": "11281", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11282", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "pink" + }, + "price": { + "$id": "11283", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 35 + } + } + }, + { + "$id": "11284", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11285", + "@search.action": { + "$id": "11286", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11287", + "id": { + "$id": "11288", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "36" + }, + "name": { + "$id": "11289", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11290", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test36 hello" + }, + "vector1": { + "$id": "11291", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 36, + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55 + ] + }, + "vector1b": { + "$id": "11292", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55 + ] + }, + "vector2": { + "$id": "11293", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 36, + 37, + 38, + 39, + 40 + ] + }, + "vector3": { + "$id": "11294", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 36, + 37, + 38, + 39, + 40 + ] + }, + "vector22": { + "$id": "11295", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65 + ] + }, + "ownerId": { + "$id": "11296", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "ryan" + }, + "category": { + "$id": "11297", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "pink" + }, + "price": { + "$id": "11298", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 36 + } + } + }, + { + "$id": "11299", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11300", + "@search.action": { + "$id": "11301", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11302", + "id": { + "$id": "11303", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "37" + }, + "name": { + "$id": "11304", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11305", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test37 hello" + }, + "vector1": { + "$id": "11306", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 37, + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56 + ] + }, + "vector1b": { + "$id": "11307", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56 + ] + }, + "vector2": { + "$id": "11308", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 37, + 38, + 39, + 40, + 41 + ] + }, + "vector3": { + "$id": "11309", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 37, + 38, + 39, + 40, + 41 + ] + }, + "vector22": { + "$id": "11310", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65, + 66 + ] + }, + "ownerId": { + "$id": "11311", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11312", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "pink" + }, + "price": { + "$id": "11313", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 37 + } + } + }, + { + "$id": "11314", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11315", + "@search.action": { + "$id": "11316", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11317", + "id": { + "$id": "11318", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "38" + }, + "name": { + "$id": "11319", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11320", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test38 hello" + }, + "vector1": { + "$id": "11321", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 38, + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57 + ] + }, + "vector1b": { + "$id": "11322", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57 + ] + }, + "vector2": { + "$id": "11323", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 38, + 39, + 40, + 41, + 42 + ] + }, + "vector3": { + "$id": "11324", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 38, + 39, + 40, + 41, + 42 + ] + }, + "vector22": { + "$id": "11325", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65, + 66, + 67 + ] + }, + "ownerId": { + "$id": "11326", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11327", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "pink" + }, + "price": { + "$id": "11328", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 38 + } + } + }, + { + "$id": "11329", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11330", + "@search.action": { + "$id": "11331", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11332", + "id": { + "$id": "11333", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "39" + }, + "name": { + "$id": "11334", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11335", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test39 hello" + }, + "vector1": { + "$id": "11336", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 39, + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58 + ] + }, + "vector1b": { + "$id": "11337", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58 + ] + }, + "vector2": { + "$id": "11338", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 39, + 40, + 41, + 42, + 43 + ] + }, + "vector3": { + "$id": "11339", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 39, + 40, + 41, + 42, + 43 + ] + }, + "vector22": { + "$id": "11340", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 59, + 60, + 61, + 62, + 63, + 64, + 65, + 66, + 67, + 68 + ] + }, + "ownerId": { + "$id": "11341", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "ryan" + }, + "category": { + "$id": "11342", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "pink" + }, + "price": { + "$id": "11343", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 39 + } + } + }, + { + "$id": "11344", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11345", + "@search.action": { + "$id": "11346", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11347", + "id": { + "$id": "11348", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "40" + }, + "name": { + "$id": "11349", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11350", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test40 hello" + }, + "vector1": { + "$id": "11351", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 40, + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59 + ] + }, + "vector1b": { + "$id": "11352", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59 + ] + }, + "vector2": { + "$id": "11353", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 40, + 41, + 42, + 43, + 44 + ] + }, + "vector3": { + "$id": "11354", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 40, + 41, + 42, + 43, + 44 + ] + }, + "vector22": { + "$id": "11355", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 60, + 61, + 62, + 63, + 64, + 65, + 66, + 67, + 68, + 69 + ] + }, + "ownerId": { + "$id": "11356", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "benny" + }, + "category": { + "$id": "11357", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "green" + }, + "price": { + "$id": "11358", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 40 + } + } + }, + { + "$id": "11359", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11360", + "@search.action": { + "$id": "11361", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11362", + "id": { + "$id": "11363", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "41" + }, + "name": { + "$id": "11364", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11365", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test41 hello" + }, + "vector1": { + "$id": "11366", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 41, + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60 + ] + }, + "vector1b": { + "$id": "11367", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60 + ] + }, + "vector2": { + "$id": "11368", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 41, + 42, + 43, + 44, + 45 + ] + }, + "vector3": { + "$id": "11369", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 41, + 42, + 43, + 44, + 45 + ] + }, + "vector22": { + "$id": "11370", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 61, + 62, + 63, + 64, + 65, + 66, + 67, + 68, + 69, + 70 + ] + }, + "ownerId": { + "$id": "11371", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11372", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "green" + }, + "price": { + "$id": "11373", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 41 + } + } + }, + { + "$id": "11374", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11375", + "@search.action": { + "$id": "11376", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11377", + "id": { + "$id": "11378", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "42" + }, + "name": { + "$id": "11379", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11380", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test42 hello" + }, + "vector1": { + "$id": "11381", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 42, + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61 + ] + }, + "vector1b": { + "$id": "11382", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61 + ] + }, + "vector2": { + "$id": "11383", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 42, + 43, + 44, + 45, + 46 + ] + }, + "vector3": { + "$id": "11384", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 42, + 43, + 44, + 45, + 46 + ] + }, + "vector22": { + "$id": "11385", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 62, + 63, + 64, + 65, + 66, + 67, + 68, + 69, + 70, + 71 + ] + }, + "ownerId": { + "$id": "11386", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "ryan" + }, + "category": { + "$id": "11387", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "green" + }, + "price": { + "$id": "11388", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 42 + } + } + }, + { + "$id": "11389", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11390", + "@search.action": { + "$id": "11391", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11392", + "id": { + "$id": "11393", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "43" + }, + "name": { + "$id": "11394", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11395", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test43 hello" + }, + "vector1": { + "$id": "11396", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 43, + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62 + ] + }, + "vector1b": { + "$id": "11397", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62 + ] + }, + "vector2": { + "$id": "11398", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 43, + 44, + 45, + 46, + 47 + ] + }, + "vector3": { + "$id": "11399", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 43, + 44, + 45, + 46, + 47 + ] + }, + "vector22": { + "$id": "11400", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 63, + 64, + 65, + 66, + 67, + 68, + 69, + 70, + 71, + 72 + ] + }, + "ownerId": { + "$id": "11401", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11402", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "green" + }, + "price": { + "$id": "11403", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 43 + } + } + }, + { + "$id": "11404", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11405", + "@search.action": { + "$id": "11406", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11407", + "id": { + "$id": "11408", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "44" + }, + "name": { + "$id": "11409", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11410", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test44 hello" + }, + "vector1": { + "$id": "11411", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 44, + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63 + ] + }, + "vector1b": { + "$id": "11412", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63 + ] + }, + "vector2": { + "$id": "11413", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 44, + 45, + 46, + 47, + 48 + ] + }, + "vector3": { + "$id": "11414", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 44, + 45, + 46, + 47, + 48 + ] + }, + "vector22": { + "$id": "11415", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 64, + 65, + 66, + 67, + 68, + 69, + 70, + 71, + 72, + 73 + ] + }, + "ownerId": { + "$id": "11416", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11417", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "green" + }, + "price": { + "$id": "11418", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 44 + } + } + }, + { + "$id": "11419", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11420", + "@search.action": { + "$id": "11421", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11422", + "id": { + "$id": "11423", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "45" + }, + "name": { + "$id": "11424", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11425", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test45 hello" + }, + "vector1": { + "$id": "11426", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 45, + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64 + ] + }, + "vector1b": { + "$id": "11427", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64 + ] + }, + "vector2": { + "$id": "11428", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 45, + 46, + 47, + 48, + 49 + ] + }, + "vector3": { + "$id": "11429", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 45, + 46, + 47, + 48, + 49 + ] + }, + "vector22": { + "$id": "11430", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 65, + 66, + 67, + 68, + 69, + 70, + 71, + 72, + 73, + 74 + ] + }, + "ownerId": { + "$id": "11431", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "ryan" + }, + "category": { + "$id": "11432", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "orange" + }, + "price": { + "$id": "11433", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 45 + } + } + }, + { + "$id": "11434", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11435", + "@search.action": { + "$id": "11436", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11437", + "id": { + "$id": "11438", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "46" + }, + "name": { + "$id": "11439", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11440", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test46 hello" + }, + "vector1": { + "$id": "11441", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 46, + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65 + ] + }, + "vector1b": { + "$id": "11442", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65 + ] + }, + "vector2": { + "$id": "11443", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 46, + 47, + 48, + 49, + 50 + ] + }, + "vector3": { + "$id": "11444", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 46, + 47, + 48, + 49, + 50 + ] + }, + "vector22": { + "$id": "11445", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 66, + 67, + 68, + 69, + 70, + 71, + 72, + 73, + 74, + 75 + ] + }, + "ownerId": { + "$id": "11446", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11447", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "orange" + }, + "price": { + "$id": "11448", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 46 + } + } + }, + { + "$id": "11449", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11450", + "@search.action": { + "$id": "11451", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11452", + "id": { + "$id": "11453", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "47" + }, + "name": { + "$id": "11454", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11455", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test47 hello" + }, + "vector1": { + "$id": "11456", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 47, + 48, + 49, + 50, + 51, + 52, + 53, + 54, + 55, + 56, + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65, + 66 + ] + }, + "vector1b": { + "$id": "11457", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 57, + 58, + 59, + 60, + 61, + 62, + 63, + 64, + 65, + 66 + ] + }, + "vector2": { + "$id": "11458", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 47, + 48, + 49, + 50, + 51 + ] + }, + "vector3": { + "$id": "11459", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 47, + 48, + 49, + 50, + 51 + ] + }, + "vector22": { + "$id": "11460", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": [ + 67, + 68, + 69, + 70, + 71, + 72, + 73, + 74, + 75, + 76 + ] + }, + "ownerId": { + "$id": "11461", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11462", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "orange" + }, + "price": { + "$id": "11463", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": 47 + } + } + }, + { + "$id": "11464", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11465", + "@search.action": { + "$id": "11466", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11467", + "id": { + "$id": "11468", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "no-vectors" + }, + "name": { + "$id": "11469", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11470", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "no vector" + }, + "ownerId": { + "$id": "11471", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11472", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + } + } + }, + { + "$id": "11473", + "kind": "model", + "type": { + "$ref": "2814" + }, + "value": { + "$id": "11474", + "@search.action": { + "$id": "11475", + "kind": "string", + "type": { + "$ref": "264" + }, + "value": "mergeOrUpload" + } + }, + "additionalPropertiesValue": { + "$id": "11476", + "id": { + "$id": "11477", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "empty-vectors" + }, + "name": { + "$id": "11478", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "test" + }, + "description": { + "$id": "11479", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "no vector" + }, + "ownerId": { + "$id": "11480", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "sam" + }, + "category": { + "$id": "11481", + "kind": "unknown", + "type": { + "$ref": "2815" + }, + "value": "purple" + } + } + } + ] + } + } + } + } + ], + "responses": [ + { + "$id": "11482", + "response": { + "$ref": "10731" + }, + "statusCode": 200, + "bodyValue": { + "$id": "11483", + "kind": "model", + "type": { + "$ref": "2821" + }, + "value": { + "$id": "11484", + "value": { + "$id": "11485", + "kind": "array", + "type": { + "$ref": "2823" + }, + "value": [ + { + "$id": "11486", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11487", + "key": { + "$id": "11488", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "0" + }, + "status": { + "$id": "11489", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11490", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11491", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11492", + "key": { + "$id": "11493", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "1" + }, + "status": { + "$id": "11494", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11495", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11496", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11497", + "key": { + "$id": "11498", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "2" + }, + "status": { + "$id": "11499", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11500", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11501", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11502", + "key": { + "$id": "11503", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "3" + }, + "status": { + "$id": "11504", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11505", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11506", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11507", + "key": { + "$id": "11508", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "4" + }, + "status": { + "$id": "11509", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11510", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11511", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11512", + "key": { + "$id": "11513", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "5" + }, + "status": { + "$id": "11514", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11515", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11516", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11517", + "key": { + "$id": "11518", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "6" + }, + "status": { + "$id": "11519", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11520", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11521", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11522", + "key": { + "$id": "11523", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "7" + }, + "status": { + "$id": "11524", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11525", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11526", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11527", + "key": { + "$id": "11528", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "8" + }, + "status": { + "$id": "11529", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11530", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11531", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11532", + "key": { + "$id": "11533", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "9" + }, + "status": { + "$id": "11534", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11535", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11536", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11537", + "key": { + "$id": "11538", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "10" + }, + "status": { + "$id": "11539", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11540", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11541", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11542", + "key": { + "$id": "11543", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "11" + }, + "status": { + "$id": "11544", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11545", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11546", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11547", + "key": { + "$id": "11548", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "12" + }, + "status": { + "$id": "11549", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11550", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11551", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11552", + "key": { + "$id": "11553", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "13" + }, + "status": { + "$id": "11554", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11555", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11556", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11557", + "key": { + "$id": "11558", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "14" + }, + "status": { + "$id": "11559", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11560", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11561", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11562", + "key": { + "$id": "11563", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "15" + }, + "status": { + "$id": "11564", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11565", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11566", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11567", + "key": { + "$id": "11568", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "16" + }, + "status": { + "$id": "11569", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11570", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11571", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11572", + "key": { + "$id": "11573", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "17" + }, + "status": { + "$id": "11574", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11575", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11576", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11577", + "key": { + "$id": "11578", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "18" + }, + "status": { + "$id": "11579", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11580", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11581", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11582", + "key": { + "$id": "11583", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "19" + }, + "status": { + "$id": "11584", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11585", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11586", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11587", + "key": { + "$id": "11588", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "20" + }, + "status": { + "$id": "11589", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11590", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11591", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11592", + "key": { + "$id": "11593", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "21" + }, + "status": { + "$id": "11594", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11595", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11596", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11597", + "key": { + "$id": "11598", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "22" + }, + "status": { + "$id": "11599", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11600", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11601", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11602", + "key": { + "$id": "11603", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "23" + }, + "status": { + "$id": "11604", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11605", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11606", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11607", + "key": { + "$id": "11608", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "24" + }, + "status": { + "$id": "11609", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11610", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11611", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11612", + "key": { + "$id": "11613", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "25" + }, + "status": { + "$id": "11614", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11615", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11616", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11617", + "key": { + "$id": "11618", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "26" + }, + "status": { + "$id": "11619", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11620", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11621", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11622", + "key": { + "$id": "11623", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "27" + }, + "status": { + "$id": "11624", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11625", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11626", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11627", + "key": { + "$id": "11628", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "28" + }, + "status": { + "$id": "11629", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11630", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11631", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11632", + "key": { + "$id": "11633", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "29" + }, + "status": { + "$id": "11634", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11635", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11636", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11637", + "key": { + "$id": "11638", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "30" + }, + "status": { + "$id": "11639", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11640", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11641", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11642", + "key": { + "$id": "11643", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "31" + }, + "status": { + "$id": "11644", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11645", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11646", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11647", + "key": { + "$id": "11648", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "32" + }, + "status": { + "$id": "11649", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11650", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11651", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11652", + "key": { + "$id": "11653", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "33" + }, + "status": { + "$id": "11654", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11655", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11656", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11657", + "key": { + "$id": "11658", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "34" + }, + "status": { + "$id": "11659", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11660", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11661", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11662", + "key": { + "$id": "11663", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "35" + }, + "status": { + "$id": "11664", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11665", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11666", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11667", + "key": { + "$id": "11668", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "36" + }, + "status": { + "$id": "11669", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11670", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11671", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11672", + "key": { + "$id": "11673", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "37" + }, + "status": { + "$id": "11674", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11675", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11676", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11677", + "key": { + "$id": "11678", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "38" + }, + "status": { + "$id": "11679", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11680", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11681", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11682", + "key": { + "$id": "11683", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "39" + }, + "status": { + "$id": "11684", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11685", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11686", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11687", + "key": { + "$id": "11688", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "40" + }, + "status": { + "$id": "11689", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11690", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11691", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11692", + "key": { + "$id": "11693", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "41" + }, + "status": { + "$id": "11694", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11695", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11696", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11697", + "key": { + "$id": "11698", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "42" + }, + "status": { + "$id": "11699", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11700", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11701", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11702", + "key": { + "$id": "11703", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "43" + }, + "status": { + "$id": "11704", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11705", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11706", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11707", + "key": { + "$id": "11708", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "44" + }, + "status": { + "$id": "11709", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11710", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11711", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11712", + "key": { + "$id": "11713", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "45" + }, + "status": { + "$id": "11714", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11715", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11716", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11717", + "key": { + "$id": "11718", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "46" + }, + "status": { + "$id": "11719", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11720", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11721", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11722", + "key": { + "$id": "11723", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "47" + }, + "status": { + "$id": "11724", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11725", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11726", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11727", + "key": { + "$id": "11728", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "no-vectors" + }, + "status": { + "$id": "11729", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11730", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11731", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11732", + "key": { + "$id": "11733", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "empty-vectors" + }, + "status": { + "$id": "11734", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11735", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + } + ] + } + } + } + }, + { + "$id": "11736", + "response": { + "$ref": "10732" + }, + "statusCode": 207, + "bodyValue": { + "$id": "11737", + "kind": "model", + "type": { + "$ref": "2821" + }, + "value": { + "$id": "11738", + "value": { + "$id": "11739", + "kind": "array", + "type": { + "$ref": "2823" + }, + "value": [ + { + "$id": "11740", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11741", + "key": { + "$id": "11742", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "0" + }, + "status": { + "$id": "11743", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11744", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11745", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11746", + "key": { + "$id": "11747", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "1" + }, + "status": { + "$id": "11748", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11749", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11750", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11751", + "key": { + "$id": "11752", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "2" + }, + "status": { + "$id": "11753", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11754", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11755", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11756", + "key": { + "$id": "11757", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "3" + }, + "status": { + "$id": "11758", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11759", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11760", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11761", + "key": { + "$id": "11762", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "4" + }, + "status": { + "$id": "11763", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11764", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11765", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11766", + "key": { + "$id": "11767", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "5" + }, + "status": { + "$id": "11768", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11769", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11770", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11771", + "key": { + "$id": "11772", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "6" + }, + "status": { + "$id": "11773", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11774", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11775", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11776", + "key": { + "$id": "11777", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "7" + }, + "status": { + "$id": "11778", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11779", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11780", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11781", + "key": { + "$id": "11782", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "8" + }, + "status": { + "$id": "11783", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11784", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11785", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11786", + "key": { + "$id": "11787", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "9" + }, + "status": { + "$id": "11788", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11789", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11790", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11791", + "key": { + "$id": "11792", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "10" + }, + "status": { + "$id": "11793", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11794", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11795", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11796", + "key": { + "$id": "11797", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "11" + }, + "status": { + "$id": "11798", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11799", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11800", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11801", + "key": { + "$id": "11802", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "12" + }, + "status": { + "$id": "11803", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11804", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11805", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11806", + "key": { + "$id": "11807", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "13" + }, + "status": { + "$id": "11808", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11809", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11810", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11811", + "key": { + "$id": "11812", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "14" + }, + "status": { + "$id": "11813", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11814", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11815", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11816", + "key": { + "$id": "11817", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "15" + }, + "status": { + "$id": "11818", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11819", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11820", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11821", + "key": { + "$id": "11822", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "16" + }, + "status": { + "$id": "11823", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11824", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11825", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11826", + "key": { + "$id": "11827", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "17" + }, + "status": { + "$id": "11828", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11829", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11830", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11831", + "key": { + "$id": "11832", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "18" + }, + "status": { + "$id": "11833", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11834", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11835", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11836", + "key": { + "$id": "11837", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "19" + }, + "status": { + "$id": "11838", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11839", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11840", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11841", + "key": { + "$id": "11842", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "20" + }, + "status": { + "$id": "11843", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11844", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11845", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11846", + "key": { + "$id": "11847", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "21" + }, + "status": { + "$id": "11848", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11849", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11850", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11851", + "key": { + "$id": "11852", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "22" + }, + "status": { + "$id": "11853", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11854", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11855", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11856", + "key": { + "$id": "11857", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "23" + }, + "status": { + "$id": "11858", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11859", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11860", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11861", + "key": { + "$id": "11862", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "24" + }, + "status": { + "$id": "11863", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11864", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11865", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11866", + "key": { + "$id": "11867", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "25" + }, + "status": { + "$id": "11868", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11869", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11870", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11871", + "key": { + "$id": "11872", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "26" + }, + "status": { + "$id": "11873", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11874", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11875", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11876", + "key": { + "$id": "11877", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "27" + }, + "status": { + "$id": "11878", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11879", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11880", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11881", + "key": { + "$id": "11882", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "28" + }, + "status": { + "$id": "11883", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11884", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11885", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11886", + "key": { + "$id": "11887", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "29" + }, + "status": { + "$id": "11888", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11889", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11890", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11891", + "key": { + "$id": "11892", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "30" + }, + "status": { + "$id": "11893", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11894", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11895", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11896", + "key": { + "$id": "11897", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "31" + }, + "status": { + "$id": "11898", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11899", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11900", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11901", + "key": { + "$id": "11902", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "32" + }, + "status": { + "$id": "11903", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11904", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11905", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11906", + "key": { + "$id": "11907", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "33" + }, + "status": { + "$id": "11908", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11909", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11910", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11911", + "key": { + "$id": "11912", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "34" + }, + "status": { + "$id": "11913", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11914", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11915", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11916", + "key": { + "$id": "11917", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "35" + }, + "status": { + "$id": "11918", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11919", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11920", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11921", + "key": { + "$id": "11922", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "36" + }, + "status": { + "$id": "11923", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11924", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11925", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11926", + "key": { + "$id": "11927", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "37" + }, + "status": { + "$id": "11928", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11929", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11930", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11931", + "key": { + "$id": "11932", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "38" + }, + "status": { + "$id": "11933", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11934", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11935", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11936", + "key": { + "$id": "11937", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "39" + }, + "status": { + "$id": "11938", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11939", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11940", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11941", + "key": { + "$id": "11942", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "40" + }, + "status": { + "$id": "11943", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11944", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11945", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11946", + "key": { + "$id": "11947", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "41" + }, + "status": { + "$id": "11948", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11949", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11950", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11951", + "key": { + "$id": "11952", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "42" + }, + "status": { + "$id": "11953", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11954", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11955", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11956", + "key": { + "$id": "11957", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "43" + }, + "status": { + "$id": "11958", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11959", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11960", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11961", + "key": { + "$id": "11962", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "44" + }, + "status": { + "$id": "11963", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11964", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11965", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11966", + "key": { + "$id": "11967", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "45" + }, + "status": { + "$id": "11968", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11969", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11970", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11971", + "key": { + "$id": "11972", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "46" + }, + "status": { + "$id": "11973", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11974", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11975", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11976", + "key": { + "$id": "11977", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "47" + }, + "status": { + "$id": "11978", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11979", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11980", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11981", + "key": { + "$id": "11982", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "no-vectors" + }, + "status": { + "$id": "11983", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11984", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + }, + { + "$id": "11985", + "kind": "model", + "type": { + "$ref": "2824" + }, + "value": { + "$id": "11986", + "key": { + "$id": "11987", + "kind": "string", + "type": { + "$ref": "2826" + }, + "value": "empty-vectors" + }, + "status": { + "$id": "11988", + "kind": "boolean", + "type": { + "$ref": "2834" + }, + "value": true + }, + "statusCode": { + "$id": "11989", + "kind": "number", + "type": { + "$ref": "2838" + }, + "value": 201 + } + } + } + ] + } + } + } + } + ] + } + ] + }, + { + "$id": "11990", + "name": "autocompleteGet", + "resourceName": "Documents", + "doc": "Autocompletes incomplete query terms based on input text and matching terms in\nthe index.", + "accessibility": "public", + "parameters": [ + { + "$id": "11991", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "11992", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "11993", + "type": { + "$id": "11994", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "11995", + "name": "searchText", + "nameInRequest": "search", + "doc": "The incomplete term which should be auto-completed.", + "type": { + "$id": "11996", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "11997", + "name": "suggesterName", + "nameInRequest": "suggesterName", + "doc": "The name of the suggester as specified in the suggesters collection that's part\nof the index definition.", + "type": { + "$id": "11998", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "11999", + "name": "autocompleteMode", + "nameInRequest": "autocompleteMode", + "doc": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms'\nto get shingles and 'oneTermWithContext' to use the current context while\nproducing auto-completed terms.", + "type": { + "$ref": "274" + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "12000", + "name": "$filter", + "nameInRequest": "$filter", + "doc": "An OData expression that filters the documents used to produce completed terms\nfor the Autocomplete result.", + "type": { + "$id": "12001", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "12002", + "name": "useFuzzyMatching", + "nameInRequest": "fuzzy", + "doc": "A value indicating whether to use fuzzy matching for the autocomplete query.\nDefault is false. When set to true, the query will find terms even if there's a\nsubstituted or missing character in the search text. While this provides a\nbetter experience in some scenarios, it comes at a performance cost as fuzzy\nautocomplete queries are slower and consume more resources.", + "type": { + "$id": "12003", + "kind": "boolean", + "name": "boolean", + "crossLanguageDefinitionId": "TypeSpec.boolean", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "12004", + "name": "highlightPostTag", + "nameInRequest": "highlightPostTag", + "doc": "A string tag that is appended to hit highlights. Must be set with\nhighlightPreTag. If omitted, hit highlighting is disabled.", + "type": { + "$id": "12005", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "12006", + "name": "highlightPreTag", + "nameInRequest": "highlightPreTag", + "doc": "A string tag that is prepended to hit highlights. Must be set with\nhighlightPostTag. If omitted, hit highlighting is disabled.", + "type": { + "$id": "12007", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "12008", + "name": "minimumCoverage", + "nameInRequest": "minimumCoverage", + "doc": "A number between 0 and 100 indicating the percentage of the index that must be\ncovered by an autocomplete query in order for the query to be reported as a\nsuccess. This parameter can be useful for ensuring search availability even for\nservices with only one replica. The default is 80.", + "type": { + "$id": "12009", + "kind": "float64", + "name": "float64", + "crossLanguageDefinitionId": "TypeSpec.float64", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "12010", + "name": "searchFields", + "nameInRequest": "searchFields", + "doc": "The list of field names to consider when querying for auto-completed terms.\nTarget fields must be included in the specified suggester.", + "type": { + "$id": "12011", + "kind": "array", + "name": "Array", + "valueType": { + "$id": "12012", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "crossLanguageDefinitionId": "TypeSpec.Array", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "arraySerializationDelimiter": ",", + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "12013", + "name": "$top", + "nameInRequest": "$top", + "doc": "The number of auto-completed terms to retrieve. This must be a value between 1\nand 100. The default is 5.", + "type": { + "$id": "12014", + "kind": "int32", + "name": "int32", + "crossLanguageDefinitionId": "TypeSpec.int32", + "decorators": [] + }, + "location": "Query", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "12015", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "12016", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "12017", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "12018", + "name": "indexName", + "nameInRequest": "indexName", + "doc": "The name of the index.", + "type": { + "$id": "12019", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "12020", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "12021", + "kind": "constant", + "valueType": { + "$id": "12022", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "12023", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "2843" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "GET", + "uri": "{endpoint}", + "path": "/indexes('{indexName}')/docs/search.autocomplete", + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Documents.autocompleteGet", + "decorators": [], + "examples": [ + { + "$id": "12024", + "kind": "http", + "name": "SearchIndexAutocompleteDocumentsGet", + "description": "SearchIndexAutocompleteDocumentsGet", + "filePath": "2025-03-01-preview/SearchIndexAutocompleteDocumentsGet.json", + "parameters": [ + { + "$id": "12025", + "parameter": { + "$ref": "12018" + }, + "value": { + "$id": "12026", + "kind": "string", + "type": { + "$ref": "12019" + }, + "value": "myindex" + } + }, + { + "$id": "12027", + "parameter": { + "$ref": "11991" + }, + "value": { + "$id": "12028", + "kind": "string", + "type": { + "$ref": "11992" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "12029", + "parameter": { + "$ref": "11999" + }, + "value": { + "$id": "12030", + "kind": "string", + "type": { + "$ref": "274" + }, + "value": "oneTerm" + } + }, + { + "$id": "12031", + "parameter": { + "$ref": "11995" + }, + "value": { + "$id": "12032", + "kind": "string", + "type": { + "$ref": "11996" + }, + "value": "washington medic" + } + }, + { + "$id": "12033", + "parameter": { + "$ref": "11997" + }, + "value": { + "$id": "12034", + "kind": "string", + "type": { + "$ref": "11998" + }, + "value": "sg" + } + }, + { + "$id": "12035", + "parameter": { + "$ref": "12002" + }, + "value": { + "$id": "12036", + "kind": "boolean", + "type": { + "$ref": "12003" + }, + "value": false + } + }, + { + "$id": "12037", + "parameter": { + "$ref": "12004" + }, + "value": { + "$id": "12038", + "kind": "string", + "type": { + "$ref": "12005" + }, + "value": "" + } + }, + { + "$id": "12039", + "parameter": { + "$ref": "12006" + }, + "value": { + "$id": "12040", + "kind": "string", + "type": { + "$ref": "12007" + }, + "value": "" + } + }, + { + "$id": "12041", + "parameter": { + "$ref": "12008" + }, + "value": { + "$id": "12042", + "kind": "number", + "type": { + "$ref": "12009" + }, + "value": 80 + } + }, + { + "$id": "12043", + "parameter": { + "$ref": "12010" + }, + "value": { + "$id": "12044", + "kind": "array", + "type": { + "$ref": "12011" + }, + "value": [ + { + "$id": "12045", + "kind": "string", + "type": { + "$ref": "12012" + }, + "value": "title" + }, + { + "$id": "12046", + "kind": "string", + "type": { + "$ref": "12012" + }, + "value": "description" + } + ] + } + } + ], + "responses": [ + { + "$id": "12047", + "response": { + "$ref": "12023" + }, + "statusCode": 200, + "bodyValue": { + "$id": "12048", + "kind": "model", + "type": { + "$ref": "2843" + }, + "value": { + "$id": "12049" + } + } + } + ] + } + ] + }, + { + "$id": "12050", + "name": "autocompletePost", + "resourceName": "Documents", + "doc": "Autocompletes incomplete query terms based on input text and matching terms in\nthe index.", + "accessibility": "public", + "parameters": [ + { + "$id": "12051", + "name": "apiVersion", + "nameInRequest": "api-version", + "doc": "The API version to use for this operation.", + "type": { + "$id": "12052", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Query", + "isApiVersion": true, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Client", + "defaultValue": { + "$id": "12053", + "type": { + "$id": "12054", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string" + }, + "value": "2025-03-01-preview" + }, + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "12055", + "name": "clientRequestId", + "nameInRequest": "x-ms-client-request-id", + "doc": "An opaque, globally-unique, client-generated string identifier for the request.", + "type": { + "$id": "12056", + "kind": "string", + "name": "uuid", + "crossLanguageDefinitionId": "Azure.Core.uuid", + "baseType": { + "$id": "12057", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": false, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "12058", + "name": "indexName", + "nameInRequest": "indexName", + "doc": "The name of the index.", + "type": { + "$id": "12059", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "location": "Path", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "12060", + "name": "contentType", + "nameInRequest": "Content-Type", + "doc": "Body parameter's content type. Known values are application/json", + "type": { + "$id": "12061", + "kind": "constant", + "valueType": { + "$id": "12062", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": true, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "12063", + "name": "accept", + "nameInRequest": "Accept", + "type": { + "$id": "12064", + "kind": "constant", + "valueType": { + "$id": "12065", + "kind": "string", + "name": "string", + "crossLanguageDefinitionId": "TypeSpec.string", + "decorators": [] + }, + "value": "application/json", + "decorators": [] + }, + "location": "Header", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Constant", + "decorators": [], + "skipUrlEncoding": false + }, + { + "$id": "12066", + "name": "autocompleteRequest", + "nameInRequest": "autocompleteRequest", + "doc": "The definition of the Autocomplete request.", + "type": { + "$ref": "2861" + }, + "location": "Body", + "isApiVersion": false, + "isContentType": false, + "isEndpoint": false, + "explode": false, + "isRequired": true, + "kind": "Method", + "decorators": [], + "skipUrlEncoding": false + } + ], + "responses": [ + { + "$id": "12067", + "statusCodes": [ + 200 + ], + "bodyType": { + "$ref": "2843" + }, + "headers": [], + "isErrorResponse": false, + "contentTypes": [ + "application/json" + ] + } + ], + "httpMethod": "POST", + "uri": "{endpoint}", + "path": "/indexes('{indexName}')/docs/search.post.autocomplete", + "requestMediaTypes": [ + "application/json" + ], + "bufferResponse": true, + "generateProtocolMethod": true, + "generateConvenienceMethod": true, + "crossLanguageDefinitionId": "Search.Documents.autocompletePost", + "decorators": [], + "examples": [ + { + "$id": "12068", + "kind": "http", + "name": "SearchIndexAutocompleteDocumentsPost", + "description": "SearchIndexAutocompleteDocumentsPost", + "filePath": "2025-03-01-preview/SearchIndexAutocompleteDocumentsPost.json", + "parameters": [ + { + "$id": "12069", + "parameter": { + "$ref": "12058" + }, + "value": { + "$id": "12070", + "kind": "string", + "type": { + "$ref": "12059" + }, + "value": "preview-test" + } + }, + { + "$id": "12071", + "parameter": { + "$ref": "12051" + }, + "value": { + "$id": "12072", + "kind": "string", + "type": { + "$ref": "12052" + }, + "value": "2025-03-01-preview" + } + }, + { + "$id": "12073", + "parameter": { + "$ref": "12055" + }, + "value": { + "$id": "12074", + "kind": "string", + "type": { + "$ref": "12056" + }, + "value": "00000000-0000-0000-0000-000000000000" + } + }, + { + "$id": "12075", + "parameter": { + "$ref": "12066" + }, + "value": { + "$id": "12076", + "kind": "model", + "type": { + "$ref": "2861" + }, + "value": { + "$id": "12077", + "search": { + "$id": "12078", + "kind": "string", + "type": { + "$ref": "2863" + }, + "value": "p" + }, + "autocompleteMode": { + "$id": "12079", + "kind": "string", + "type": { + "$ref": "274" + }, + "value": "oneTerm" + }, + "filter": { + "$id": "12080", + "kind": "string", + "type": { + "$ref": "2870" + }, + "value": "ownerId ne '1'" + }, + "fuzzy": { + "$id": "12081", + "kind": "boolean", + "type": { + "$ref": "2874" + }, + "value": true + }, + "highlightPostTag": { + "$id": "12082", + "kind": "string", + "type": { + "$ref": "2878" + }, + "value": "" + }, + "highlightPreTag": { + "$id": "12083", + "kind": "string", + "type": { + "$ref": "2882" + }, + "value": "" + }, + "minimumCoverage": { + "$id": "12084", + "kind": "number", + "type": { + "$ref": "2886" + }, + "value": 80 + }, + "searchFields": { + "$id": "12085", + "kind": "string", + "type": { + "$ref": "2890" + }, + "value": "category, ownerId" + }, + "suggesterName": { + "$id": "12086", + "kind": "string", + "type": { + "$ref": "2894" + }, + "value": "sg" + }, + "top": { + "$id": "12087", + "kind": "number", + "type": { + "$ref": "2898" + }, + "value": 10 + } + } + } + } + ], + "responses": [ + { + "$id": "12088", + "response": { + "$ref": "12067" + }, + "statusCode": 200, + "bodyValue": { + "$id": "12089", + "kind": "model", + "type": { + "$ref": "2843" + }, + "value": { + "$id": "12090", + "@search.coverage": { + "$id": "12091", + "kind": "number", + "type": { + "$ref": "2845" + }, + "value": 100 + }, + "value": { + "$id": "12092", + "kind": "array", + "type": { + "$ref": "2849" + }, + "value": [ + { + "$id": "12093", + "kind": "model", + "type": { + "$ref": "2850" + }, + "value": { + "$id": "12094", + "text": { + "$id": "12095", + "kind": "string", + "type": { + "$ref": "2852" + }, + "value": "purple" + }, + "queryPlusText": { + "$id": "12096", + "kind": "string", + "type": { + "$ref": "2856" + }, + "value": "purple" + } + } + }, + { + "$id": "12097", + "kind": "model", + "type": { + "$ref": "2850" + }, + "value": { + "$id": "12098", + "text": { + "$id": "12099", + "kind": "string", + "type": { + "$ref": "2852" + }, + "value": "pink" + }, + "queryPlusText": { + "$id": "12100", + "kind": "string", + "type": { + "$ref": "2856" + }, + "value": "pink" + } + } + } + ] + } + } + } + } + ] + } + ] + } + ], + "parameters": [ + { + "$id": "12101", + "name": "endpoint", + "nameInRequest": "endpoint", + "doc": "Service host", + "type": { + "$id": "12102", + "kind": "url", + "name": "url", + "crossLanguageDefinitionId": "TypeSpec.url" + }, + "location": "Uri", + "isApiVersion": false, + "isContentType": false, + "isRequired": true, + "isEndpoint": true, + "skipUrlEncoding": false, + "explode": false, + "kind": "Client" + } + ], + "decorators": [], + "crossLanguageDefinitionId": "Search.Documents", + "apiVersions": [ + "2024-07-01", + "2025-03-01-preview" + ], + "parent": { + "$ref": "5531" + } + } + ] + } + ], + "auth": { + "$id": "12103", + "apiKey": { + "$id": "12104", + "name": "api-key", + "in": "header" + }, + "oAuth2": { + "$id": "12105", + "scopes": [ + "https://search.azure.com/.default" + ] + } + } +}