diff --git a/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/Azure.Health.Insights.RadiologyInsights.sln b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/Azure.Health.Insights.RadiologyInsights.sln new file mode 100644 index 0000000000000..5d8a2df889772 --- /dev/null +++ b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/Azure.Health.Insights.RadiologyInsights.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.Health.Insights.RadiologyInsights", "src\Azure.Health.Insights.RadiologyInsights.csproj", "{28FF4005-4467-4E36-92E7-DEA27DEB1519}" +EndProject +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Azure.Health.Insights.RadiologyInsights.Tests", "tests\Azure.Health.Insights.RadiologyInsights.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/healthinsights/Azure.Health.Insights.RadiologyInsights/CHANGELOG.md b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/CHANGELOG.md new file mode 100644 index 0000000000000..13dd08af78abe --- /dev/null +++ b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/CHANGELOG.md @@ -0,0 +1,11 @@ +# Release History + +## 1.0.0-beta.1 (Unreleased) + +### Features Added + +### Breaking Changes + +### Bugs Fixed + +### Other Changes diff --git a/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/Directory.Build.props b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/Directory.Build.props new file mode 100644 index 0000000000000..63bd836ad44b7 --- /dev/null +++ b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/Directory.Build.props @@ -0,0 +1,6 @@ + + + + diff --git a/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/README.md b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/README.md new file mode 100644 index 0000000000000..3b37f81bbcc92 --- /dev/null +++ b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/README.md @@ -0,0 +1,86 @@ +# Azure.Health.Insights.RadiologyInsights client library for .NET + +Azure.Health.Insights.RadiologyInsights 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/healthinsights/Azure.Health.Insights.RadiologyInsights/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.Health.Insights.RadiologyInsights --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. + +## 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/healthinsights/Azure.Health.Insights.RadiologyInsights/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/healthinsights/Azure.Health.Insights.RadiologyInsights/README.png) diff --git a/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Azure.Health.Insights.RadiologyInsights.csproj b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Azure.Health.Insights.RadiologyInsights.csproj new file mode 100644 index 0000000000000..62f75ec6efbaf --- /dev/null +++ b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Azure.Health.Insights.RadiologyInsights.csproj @@ -0,0 +1,20 @@ + + + This is the Azure.Health.Insights.RadiologyInsights client library for developing .NET applications with rich experience. + Azure SDK Code Generation Azure.Health.Insights.RadiologyInsights for Azure Data Plane + 1.0.0-beta.1 + Azure.Health.Insights.RadiologyInsights + $(RequiredTargetFrameworks) + true + + + + + + + + + + + + diff --git a/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Generated/AzureHealthInsightsClient.cs b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Generated/AzureHealthInsightsClient.cs new file mode 100644 index 0000000000000..c8fa3cccdda40 --- /dev/null +++ b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Generated/AzureHealthInsightsClient.cs @@ -0,0 +1,70 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Health.Insights.RadiologyInsights +{ + // Data plane generated client. + /// The AzureHealthInsights service client. + public partial class AzureHealthInsightsClient + { + private const string AuthorizationHeader = "Ocp-Apim-Subscription-Key"; + private readonly AzureKeyCredential _keyCredential; + 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 AzureHealthInsightsClient for mocking. + protected AzureHealthInsightsClient() + { + } + + /// Initializes a new instance of AzureHealthInsightsClient. + /// Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). + /// A credential used to authenticate to an Azure Service. + /// or is null. + public AzureHealthInsightsClient(Uri endpoint, AzureKeyCredential credential) : this(endpoint, credential, new AzureHealthInsightsClientOptions()) + { + } + + /// Initializes a new instance of AzureHealthInsightsClient. + /// Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). + /// A credential used to authenticate to an Azure Service. + /// The options for configuring the client. + /// or is null. + public AzureHealthInsightsClient(Uri endpoint, AzureKeyCredential credential, AzureHealthInsightsClientOptions options) + { + Argument.AssertNotNull(endpoint, nameof(endpoint)); + Argument.AssertNotNull(credential, nameof(credential)); + options ??= new AzureHealthInsightsClientOptions(); + + 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 RadiologyInsights. + /// The to use. + /// is null. + public virtual RadiologyInsights GetRadiologyInsightsClient(string apiVersion = "2023-03-01-preview") + { + Argument.AssertNotNull(apiVersion, nameof(apiVersion)); + + return new RadiologyInsights(ClientDiagnostics, _pipeline, _keyCredential, _endpoint, apiVersion); + } + } +} diff --git a/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Generated/AzureHealthInsightsClientOptions.cs b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Generated/AzureHealthInsightsClientOptions.cs new file mode 100644 index 0000000000000..e20f12e532008 --- /dev/null +++ b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Generated/AzureHealthInsightsClientOptions.cs @@ -0,0 +1,37 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using Azure.Core; + +namespace Azure.Health.Insights.RadiologyInsights +{ + /// Client options for AzureHealthInsightsClient. + public partial class AzureHealthInsightsClientOptions : ClientOptions + { + private const ServiceVersion LatestVersion = ServiceVersion.V2023_03_01_Preview; + + /// The version of the service to use. + public enum ServiceVersion + { + /// Service version "2023-03-01-preview". + V2023_03_01_Preview = 1, + } + + internal string Version { get; } + + /// Initializes new instance of AzureHealthInsightsClientOptions. + public AzureHealthInsightsClientOptions(ServiceVersion version = LatestVersion) + { + Version = version switch + { + ServiceVersion.V2023_03_01_Preview => "2023-03-01-preview", + _ => throw new NotSupportedException() + }; + } + } +} diff --git a/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Generated/Docs/RadiologyInsights.xml b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Generated/Docs/RadiologyInsights.xml new file mode 100644 index 0000000000000..4a9ddec0acd61 --- /dev/null +++ b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Generated/Docs/RadiologyInsights.xml @@ -0,0 +1,51 @@ + + + + + +This sample shows how to call GetJobAsync. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +RadiologyInsights client = new AzureHealthInsightsClient(endpoint, credential).GetRadiologyInsightsClient(apiVersion: "2023-03-01-preview"); + +Response response = await client.GetJobAsync(""); + +Console.WriteLine(response.Status); +]]> +This sample shows how to call GetJobAsync with all parameters. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +RadiologyInsights client = new AzureHealthInsightsClient(endpoint, credential).GetRadiologyInsightsClient(apiVersion: "2023-03-01-preview"); + +Response response = await client.GetJobAsync(""); + +Console.WriteLine(response.Status); +]]> + + + +This sample shows how to call GetJob. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +RadiologyInsights client = new AzureHealthInsightsClient(endpoint, credential).GetRadiologyInsightsClient(apiVersion: "2023-03-01-preview"); + +Response response = client.GetJob(""); + +Console.WriteLine(response.Status); +]]> +This sample shows how to call GetJob with all parameters. +"); +AzureKeyCredential credential = new AzureKeyCredential(""); +RadiologyInsights client = new AzureHealthInsightsClient(endpoint, credential).GetRadiologyInsightsClient(apiVersion: "2023-03-01-preview"); + +Response response = client.GetJob(""); + +Console.WriteLine(response.Status); +]]> + + + \ No newline at end of file diff --git a/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Generated/HealthInsightsRadiologyInsightsClientBuilderExtensions.cs b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Generated/HealthInsightsRadiologyInsightsClientBuilderExtensions.cs new file mode 100644 index 0000000000000..baec5258068d5 --- /dev/null +++ b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Generated/HealthInsightsRadiologyInsightsClientBuilderExtensions.cs @@ -0,0 +1,37 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using Azure; +using Azure.Core.Extensions; +using Azure.Health.Insights.RadiologyInsights; + +namespace Microsoft.Extensions.Azure +{ + /// Extension methods to add to client builder. + public static partial class HealthInsightsRadiologyInsightsClientBuilderExtensions + { + /// Registers a instance. + /// The builder to register with. + /// Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). + /// A credential used to authenticate to an Azure Service. + public static IAzureClientBuilder AddAzureHealthInsightsClient(this TBuilder builder, Uri endpoint, AzureKeyCredential credential) + where TBuilder : IAzureClientFactoryBuilder + { + return builder.RegisterClientFactory((options) => new AzureHealthInsightsClient(endpoint, credential, options)); + } + + /// Registers a instance. + /// The builder to register with. + /// The configuration values. + public static IAzureClientBuilder AddAzureHealthInsightsClient(this TBuilder builder, TConfiguration configuration) + where TBuilder : IAzureClientFactoryBuilderWithConfiguration + { + return builder.RegisterClientFactory(configuration); + } + } +} diff --git a/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Generated/RadiologyInsights.cs b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Generated/RadiologyInsights.cs new file mode 100644 index 0000000000000..74a2542154cf5 --- /dev/null +++ b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Generated/RadiologyInsights.cs @@ -0,0 +1,143 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading.Tasks; +using Azure; +using Azure.Core; +using Azure.Core.Pipeline; + +namespace Azure.Health.Insights.RadiologyInsights +{ + // Data plane generated sub-client. + /// The RadiologyInsights sub-client. + public partial class RadiologyInsights + { + private const string AuthorizationHeader = "Ocp-Apim-Subscription-Key"; + private readonly AzureKeyCredential _keyCredential; + 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 RadiologyInsights for mocking. + protected RadiologyInsights() + { + } + + /// Initializes a new instance of RadiologyInsights. + /// The handler for diagnostic messaging in the client. + /// The HTTP pipeline for sending and receiving REST requests and responses. + /// The key credential to copy. + /// Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus2.api.cognitive.microsoft.com). + /// The to use. + internal RadiologyInsights(ClientDiagnostics clientDiagnostics, HttpPipeline pipeline, AzureKeyCredential keyCredential, Uri endpoint, string apiVersion) + { + ClientDiagnostics = clientDiagnostics; + _pipeline = pipeline; + _keyCredential = keyCredential; + _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] Get Radiology Insights job details + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The to use. + /// 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 GetJobAsync(string id, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(id, nameof(id)); + + using var scope = ClientDiagnostics.CreateScope("RadiologyInsights.GetJob"); + scope.Start(); + try + { + using HttpMessage message = CreateGetJobRequest(id, 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] Get Radiology Insights job details + /// + /// + /// + /// This protocol method allows explicit creation of the request and processing of the response for advanced scenarios. + /// + /// + /// + /// + /// The to use. + /// 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 GetJob(string id, RequestContext context = null) + { + Argument.AssertNotNullOrEmpty(id, nameof(id)); + + using var scope = ClientDiagnostics.CreateScope("RadiologyInsights.GetJob"); + scope.Start(); + try + { + using HttpMessage message = CreateGetJobRequest(id, context); + return _pipeline.ProcessMessage(message, context); + } + catch (Exception e) + { + scope.Failed(e); + throw; + } + } + + internal HttpMessage CreateGetJobRequest(string id, RequestContext context) + { + var message = _pipeline.CreateMessage(context, ResponseClassifier200); + var request = message.Request; + request.Method = RequestMethod.Get; + var uri = new RawRequestUriBuilder(); + uri.Reset(_endpoint); + uri.AppendRaw("/healthinsights", false); + uri.AppendPath("/radiology-insights/jobs/", false); + uri.AppendPath(id, true); + uri.AppendQuery("api-version", _apiVersion, true); + request.Uri = uri; + request.Headers.Add("Accept", "application/json"); + return message; + } + + private static ResponseClassifier _responseClassifier200; + private static ResponseClassifier ResponseClassifier200 => _responseClassifier200 ??= new StatusCodeClassifier(stackalloc ushort[] { 200 }); + } +} diff --git a/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Properties/AssemblyInfo.cs b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/src/Properties/AssemblyInfo.cs new file mode 100644 index 0000000000000..abdfc901b1f71 --- /dev/null +++ b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/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.Health.Insights.RadiologyInsights.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/healthinsights/Azure.Health.Insights.RadiologyInsights/tests/Azure.Health.Insights.RadiologyInsights.Tests.csproj b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/tests/Azure.Health.Insights.RadiologyInsights.Tests.csproj new file mode 100644 index 0000000000000..0cebe8e26600c --- /dev/null +++ b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/tests/Azure.Health.Insights.RadiologyInsights.Tests.csproj @@ -0,0 +1,20 @@ + + + $(RequiredTargetFrameworks) + + $(NoWarn);CS1591 + + + + + + + + + + + + + + + diff --git a/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/tests/Generated/Samples/Samples_RadiologyInsights.cs b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/tests/Generated/Samples/Samples_RadiologyInsights.cs new file mode 100644 index 0000000000000..39a208cc50437 --- /dev/null +++ b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/tests/Generated/Samples/Samples_RadiologyInsights.cs @@ -0,0 +1,71 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using System.Threading.Tasks; +using Azure; +using Azure.Health.Insights.RadiologyInsights; +using Azure.Identity; +using NUnit.Framework; + +namespace Azure.Health.Insights.RadiologyInsights.Samples +{ + public partial class Samples_RadiologyInsights + { + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_RadiologyInsights_GetJob_ShortVersion() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + RadiologyInsights client = new AzureHealthInsightsClient(endpoint, credential).GetRadiologyInsightsClient(apiVersion: "2023-03-01-preview"); + + Response response = client.GetJob(""); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_RadiologyInsights_GetJob_ShortVersion_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + RadiologyInsights client = new AzureHealthInsightsClient(endpoint, credential).GetRadiologyInsightsClient(apiVersion: "2023-03-01-preview"); + + Response response = await client.GetJobAsync(""); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public void Example_RadiologyInsights_GetJob_AllParameters() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + RadiologyInsights client = new AzureHealthInsightsClient(endpoint, credential).GetRadiologyInsightsClient(apiVersion: "2023-03-01-preview"); + + Response response = client.GetJob(""); + + Console.WriteLine(response.Status); + } + + [Test] + [Ignore("Only validating compilation of examples")] + public async Task Example_RadiologyInsights_GetJob_AllParameters_Async() + { + Uri endpoint = new Uri(""); + AzureKeyCredential credential = new AzureKeyCredential(""); + RadiologyInsights client = new AzureHealthInsightsClient(endpoint, credential).GetRadiologyInsightsClient(apiVersion: "2023-03-01-preview"); + + Response response = await client.GetJobAsync(""); + + Console.WriteLine(response.Status); + } + } +} diff --git a/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/tsp-location.yaml b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/tsp-location.yaml new file mode 100644 index 0000000000000..deb206da43726 --- /dev/null +++ b/sdk/healthinsights/Azure.Health.Insights.RadiologyInsights/tsp-location.yaml @@ -0,0 +1,7 @@ +additionalDirectories: +- specification/ai/HealthInsights/HealthInsights.Common/ +- specification/ai/HealthInsights/HealthInsights.OpenAPI/ +directory: specification/ai/HealthInsights/HealthInsights.RadiologyInsights +repo: test-repo-billy/azure-rest-api-specs +commit: 82186691d45005df81b7a474133a215bef79d701 + diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCognitiveSearchChatExtensionParameters.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCognitiveSearchChatExtensionParameters.cs index 68713a8ea8f6a..ae2423bf3d64f 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCognitiveSearchChatExtensionParameters.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCognitiveSearchChatExtensionParameters.cs @@ -10,7 +10,7 @@ namespace Azure.AI.OpenAI { - /// Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension. + /// Parameters for Azure Cognitive Search when used as an Azure OpenAI chat extension. The supported authentication types are APIKey, SystemAssignedManagedIdentity and UserAssignedManagedIdentity. internal partial class AzureCognitiveSearchChatExtensionParameters { /// Initializes a new instance of . @@ -61,7 +61,7 @@ internal AzureCognitiveSearchChatExtensionParameters(OnYourDataAuthenticationOpt /// If not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential) /// authentication. /// 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 available derived classes include , , , , , and . /// public OnYourDataAuthenticationOptions Authentication { get; set; } /// The configured top number of documents to feature for the configured query. diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBChatExtensionConfiguration.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBChatExtensionConfiguration.cs index 72bad8dd7f876..b0b8a555a357c 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBChatExtensionConfiguration.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBChatExtensionConfiguration.cs @@ -11,7 +11,7 @@ namespace Azure.AI.OpenAI { /// - /// A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat + /// A specific representation of configurable options for Azure Cosmos DB when using it as an Azure OpenAI chat /// extension. /// public partial class AzureCosmosDBChatExtensionConfiguration : AzureChatExtensionConfiguration diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBChatExtensionParameters.Serialization.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBChatExtensionParameters.Serialization.cs index cf725f13aa5aa..94d204697a880 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBChatExtensionParameters.Serialization.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBChatExtensionParameters.Serialization.cs @@ -48,11 +48,8 @@ void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) writer.WriteStringValue(IndexName); writer.WritePropertyName("fieldsMapping"u8); writer.WriteObjectValue(FieldMappingOptions); - if (Optional.IsDefined(EmbeddingDependency)) - { - writer.WritePropertyName("embeddingDependency"u8); - writer.WriteObjectValue(EmbeddingDependency); - } + writer.WritePropertyName("embeddingDependency"u8); + writer.WriteObjectValue(EmbeddingDependency); writer.WriteEndObject(); } diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBChatExtensionParameters.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBChatExtensionParameters.cs index bb0721b8bee1f..3c5b28b9ee44b 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBChatExtensionParameters.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBChatExtensionParameters.cs @@ -12,10 +12,32 @@ namespace Azure.AI.OpenAI { /// /// Parameters to use when configuring Azure OpenAI On Your Data chat extensions when using Azure Cosmos DB for - /// MongoDB vCore. + /// MongoDB vCore. The supported authentication type is ConnectionString. /// internal partial class AzureCosmosDBChatExtensionParameters { + /// Initializes a new instance of . + /// The MongoDB vCore database name to use with Azure Cosmos DB. + /// The name of the Azure Cosmos DB resource container. + /// The MongoDB vCore index name to use with Azure Cosmos DB. + /// Customized field mapping behavior to use when interacting with the search index. + /// The embedding dependency for vector search. + /// , , , or is null. + public AzureCosmosDBChatExtensionParameters(string databaseName, string containerName, string indexName, AzureCosmosDBFieldMappingOptions fieldMappingOptions, OnYourDataVectorizationSource embeddingDependency) + { + Argument.AssertNotNull(databaseName, nameof(databaseName)); + Argument.AssertNotNull(containerName, nameof(containerName)); + Argument.AssertNotNull(indexName, nameof(indexName)); + Argument.AssertNotNull(fieldMappingOptions, nameof(fieldMappingOptions)); + Argument.AssertNotNull(embeddingDependency, nameof(embeddingDependency)); + + DatabaseName = databaseName; + ContainerName = containerName; + IndexName = indexName; + FieldMappingOptions = fieldMappingOptions; + EmbeddingDependency = embeddingDependency; + } + /// Initializes a new instance of . /// /// The authentication method to use when accessing the defined data source. @@ -54,7 +76,7 @@ internal AzureCosmosDBChatExtensionParameters(OnYourDataAuthenticationOptions au /// If not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential) /// authentication. /// 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 available derived classes include , , , , , and . /// public OnYourDataAuthenticationOptions Authentication { get; set; } /// The configured top number of documents to feature for the configured query. diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBFieldMappingOptions.Serialization.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBFieldMappingOptions.Serialization.cs index 0905dda5fdadb..dda1a588c3a26 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBFieldMappingOptions.Serialization.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBFieldMappingOptions.Serialization.cs @@ -15,6 +15,33 @@ public partial class AzureCosmosDBFieldMappingOptions : IUtf8JsonSerializable void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) { writer.WriteStartObject(); + if (Optional.IsDefined(TitleFieldName)) + { + writer.WritePropertyName("titleField"u8); + writer.WriteStringValue(TitleFieldName); + } + if (Optional.IsDefined(UrlFieldName)) + { + writer.WritePropertyName("urlField"u8); + writer.WriteStringValue(UrlFieldName); + } + if (Optional.IsDefined(FilepathFieldName)) + { + writer.WritePropertyName("filepathField"u8); + writer.WriteStringValue(FilepathFieldName); + } + writer.WritePropertyName("contentFields"u8); + writer.WriteStartArray(); + foreach (var item in ContentFieldNames) + { + writer.WriteStringValue(item); + } + writer.WriteEndArray(); + if (Optional.IsDefined(ContentFieldSeparator)) + { + writer.WritePropertyName("contentFieldsSeparator"u8); + writer.WriteStringValue(ContentFieldSeparator); + } writer.WritePropertyName("vectorFields"u8); writer.WriteStartArray(); foreach (var item in VectorFieldNames) diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBFieldMappingOptions.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBFieldMappingOptions.cs index e6804d45b4253..1690025049936 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBFieldMappingOptions.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureCosmosDBFieldMappingOptions.cs @@ -16,22 +16,45 @@ namespace Azure.AI.OpenAI public partial class AzureCosmosDBFieldMappingOptions { /// Initializes a new instance of . + /// The names of index fields that should be treated as content. /// The names of fields that represent vector data. - /// is null. - public AzureCosmosDBFieldMappingOptions(IEnumerable vectorFieldNames) + /// or is null. + public AzureCosmosDBFieldMappingOptions(IEnumerable contentFieldNames, IEnumerable vectorFieldNames) { + Argument.AssertNotNull(contentFieldNames, nameof(contentFieldNames)); Argument.AssertNotNull(vectorFieldNames, nameof(vectorFieldNames)); + ContentFieldNames = contentFieldNames.ToList(); VectorFieldNames = vectorFieldNames.ToList(); } /// Initializes a new instance of . + /// The name of the index field to use as a title. + /// The name of the index field to use as a URL. + /// The name of the index field to use as a filepath. + /// The names of index fields that should be treated as content. + /// The separator pattern that content fields should use. /// The names of fields that represent vector data. - internal AzureCosmosDBFieldMappingOptions(IList vectorFieldNames) + internal AzureCosmosDBFieldMappingOptions(string titleFieldName, string urlFieldName, string filepathFieldName, IList contentFieldNames, string contentFieldSeparator, IList vectorFieldNames) { + TitleFieldName = titleFieldName; + UrlFieldName = urlFieldName; + FilepathFieldName = filepathFieldName; + ContentFieldNames = contentFieldNames; + ContentFieldSeparator = contentFieldSeparator; VectorFieldNames = vectorFieldNames; } + /// The name of the index field to use as a title. + public string TitleFieldName { get; set; } + /// The name of the index field to use as a URL. + public string UrlFieldName { get; set; } + /// The name of the index field to use as a filepath. + public string FilepathFieldName { get; set; } + /// The names of index fields that should be treated as content. + public IList ContentFieldNames { get; } + /// The separator pattern that content fields should use. + public string ContentFieldSeparator { get; set; } /// The names of fields that represent vector data. public IList VectorFieldNames { get; } } diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureMachineLearningIndexChatExtensionParameters.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureMachineLearningIndexChatExtensionParameters.cs index 3b1210ea00b29..508fd6f14b12c 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureMachineLearningIndexChatExtensionParameters.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/AzureMachineLearningIndexChatExtensionParameters.cs @@ -10,7 +10,7 @@ namespace Azure.AI.OpenAI { - /// Parameters for the Azure Machine Learning vector index chat extension. + /// Parameters for the Azure Machine Learning vector index chat extension. The supported authentication types are AccessToken, SystemAssignedManagedIdentity and UserAssignedManagedIdentity. internal partial class AzureMachineLearningIndexChatExtensionParameters { /// Initializes a new instance of . @@ -49,7 +49,7 @@ internal AzureMachineLearningIndexChatExtensionParameters(OnYourDataAuthenticati /// If not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential) /// authentication. /// 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 available derived classes include , , , , , and . /// public OnYourDataAuthenticationOptions Authentication { get; set; } /// The configured top number of documents to feature for the configured query. diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/ElasticsearchChatExtensionParameters.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/ElasticsearchChatExtensionParameters.cs index 460dd6e85cb60..94e93ac0dcc6c 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/ElasticsearchChatExtensionParameters.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/ElasticsearchChatExtensionParameters.cs @@ -10,7 +10,7 @@ namespace Azure.AI.OpenAI { - /// Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. + /// Parameters to use when configuring Elasticsearch® as an Azure OpenAI chat extension. The supported authentication types are KeyAndKeyId and EncodedAPIKey. internal partial class ElasticsearchChatExtensionParameters { /// Initializes a new instance of . @@ -51,7 +51,7 @@ internal ElasticsearchChatExtensionParameters(OnYourDataAuthenticationOptions au /// If not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential) /// authentication. /// 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 available derived classes include , , , , , and . /// public OnYourDataAuthenticationOptions Authentication { get; set; } /// The configured top number of documents to feature for the configured query. diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/FunctionCallPreset.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/FunctionCallPreset.cs index e022f2ff07529..2fad34c463139 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/FunctionCallPreset.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/FunctionCallPreset.cs @@ -36,6 +36,7 @@ public FunctionCallPreset(string value) /// /// Specifies that the model should not respond with a function call and should instead provide a standard chat /// completions response. Response content may still be influenced by the provided function information. + /// Doc change. /// public static FunctionCallPreset None { get; } = new FunctionCallPreset(NoneValue); /// Determines if two values are the same. diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataAccessTokenAuthenticationOptions.Serialization.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataAccessTokenAuthenticationOptions.Serialization.cs new file mode 100644 index 0000000000000..b8e61285cf45b --- /dev/null +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataAccessTokenAuthenticationOptions.Serialization.cs @@ -0,0 +1,33 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System.Text.Json; +using Azure.Core; + +namespace Azure.AI.OpenAI +{ + public partial class OnYourDataAccessTokenAuthenticationOptions : IUtf8JsonSerializable + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) + { + writer.WriteStartObject(); + writer.WritePropertyName("accessToken"u8); + writer.WriteStringValue(AccessToken); + writer.WritePropertyName("type"u8); + writer.WriteStringValue(Type.ToString()); + writer.WriteEndObject(); + } + + /// Convert into a Utf8JsonRequestContent. + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this); + return content; + } + } +} diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataAccessTokenAuthenticationOptions.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataAccessTokenAuthenticationOptions.cs new file mode 100644 index 0000000000000..288542509f584 --- /dev/null +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataAccessTokenAuthenticationOptions.cs @@ -0,0 +1,38 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using Azure.Core; + +namespace Azure.AI.OpenAI +{ + /// The authentication options for Azure OpenAI On Your Data when using access token. + public partial class OnYourDataAccessTokenAuthenticationOptions : OnYourDataAuthenticationOptions + { + /// Initializes a new instance of . + /// The access token to use for authentication. + /// is null. + public OnYourDataAccessTokenAuthenticationOptions(string accessToken) + { + Argument.AssertNotNull(accessToken, nameof(accessToken)); + + Type = OnYourDataAuthenticationType.AccessToken; + AccessToken = accessToken; + } + + /// Initializes a new instance of . + /// The authentication type. + /// The access token to use for authentication. + internal OnYourDataAccessTokenAuthenticationOptions(OnYourDataAuthenticationType type, string accessToken) : base(type) + { + AccessToken = accessToken; + } + + /// The access token to use for authentication. + public string AccessToken { get; } + } +} diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataAuthenticationOptions.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataAuthenticationOptions.cs index 05bf2720c07c8..7e3318c006069 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataAuthenticationOptions.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataAuthenticationOptions.cs @@ -10,7 +10,7 @@ namespace Azure.AI.OpenAI /// /// The authentication options for Azure OpenAI On Your Data. /// 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 available derived classes include , , , , , and . /// public abstract partial class OnYourDataAuthenticationOptions { diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataAuthenticationType.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataAuthenticationType.cs index 318433a35a298..bc5147a51b8d9 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataAuthenticationType.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataAuthenticationType.cs @@ -25,6 +25,8 @@ public OnYourDataAuthenticationType(string value) private const string ApiKeyValue = "APIKey"; private const string ConnectionStringValue = "ConnectionString"; private const string KeyAndKeyIdValue = "KeyAndKeyId"; + private const string EncodedApiKeyValue = "EncodedAPIKey"; + private const string AccessTokenValue = "AccessToken"; private const string SystemAssignedManagedIdentityValue = "SystemAssignedManagedIdentity"; private const string UserAssignedManagedIdentityValue = "UserAssignedManagedIdentity"; @@ -34,6 +36,10 @@ public OnYourDataAuthenticationType(string value) public static OnYourDataAuthenticationType ConnectionString { get; } = new OnYourDataAuthenticationType(ConnectionStringValue); /// Authentication via key and key ID pair. public static OnYourDataAuthenticationType KeyAndKeyId { get; } = new OnYourDataAuthenticationType(KeyAndKeyIdValue); + /// Authentication via encoded API key. + public static OnYourDataAuthenticationType EncodedApiKey { get; } = new OnYourDataAuthenticationType(EncodedApiKeyValue); + /// Authentication via access token. + public static OnYourDataAuthenticationType AccessToken { get; } = new OnYourDataAuthenticationType(AccessTokenValue); /// Authentication via system-assigned managed identity. public static OnYourDataAuthenticationType SystemAssignedManagedIdentity { get; } = new OnYourDataAuthenticationType(SystemAssignedManagedIdentityValue); /// Authentication via user-assigned managed identity. diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataEncodedApiKeyAuthenticationOptions.Serialization.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataEncodedApiKeyAuthenticationOptions.Serialization.cs new file mode 100644 index 0000000000000..8d21c97ad350e --- /dev/null +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataEncodedApiKeyAuthenticationOptions.Serialization.cs @@ -0,0 +1,33 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System.Text.Json; +using Azure.Core; + +namespace Azure.AI.OpenAI +{ + public partial class OnYourDataEncodedApiKeyAuthenticationOptions : IUtf8JsonSerializable + { + void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) + { + writer.WriteStartObject(); + writer.WritePropertyName("encodedApiKey"u8); + writer.WriteStringValue(EncodedApiKey); + writer.WritePropertyName("type"u8); + writer.WriteStringValue(Type.ToString()); + writer.WriteEndObject(); + } + + /// Convert into a Utf8JsonRequestContent. + internal override RequestContent ToRequestContent() + { + var content = new Utf8JsonRequestContent(); + content.JsonWriter.WriteObjectValue(this); + return content; + } + } +} diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataEncodedApiKeyAuthenticationOptions.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataEncodedApiKeyAuthenticationOptions.cs new file mode 100644 index 0000000000000..75c3655f8bb87 --- /dev/null +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataEncodedApiKeyAuthenticationOptions.cs @@ -0,0 +1,38 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. +// Licensed under the MIT License. + +// + +#nullable disable + +using System; +using Azure.Core; + +namespace Azure.AI.OpenAI +{ + /// The authentication options for Azure OpenAI On Your Data when using an Elasticsearch encoded API key. + public partial class OnYourDataEncodedApiKeyAuthenticationOptions : OnYourDataAuthenticationOptions + { + /// Initializes a new instance of . + /// The encoded API key to use for authentication. + /// is null. + public OnYourDataEncodedApiKeyAuthenticationOptions(string encodedApiKey) + { + Argument.AssertNotNull(encodedApiKey, nameof(encodedApiKey)); + + Type = OnYourDataAuthenticationType.EncodedApiKey; + EncodedApiKey = encodedApiKey; + } + + /// Initializes a new instance of . + /// The authentication type. + /// The encoded API key to use for authentication. + internal OnYourDataEncodedApiKeyAuthenticationOptions(OnYourDataAuthenticationType type, string encodedApiKey) : base(type) + { + EncodedApiKey = encodedApiKey; + } + + /// The encoded API key to use for authentication. + public string EncodedApiKey { get; } + } +} diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataEndpointVectorizationSource.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataEndpointVectorizationSource.cs index eb279089de144..7f1605e6ade37 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataEndpointVectorizationSource.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/OnYourDataEndpointVectorizationSource.cs @@ -45,7 +45,7 @@ internal OnYourDataEndpointVectorizationSource(OnYourDataVectorizationSourceType /// /// Specifies the authentication options to use when retrieving embeddings from the specified endpoint. /// 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 available derived classes include , , , , , and . /// public OnYourDataAuthenticationOptions Authentication { get; } } diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeChatExtensionConfiguration.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeChatExtensionConfiguration.cs index c93d89950592c..2904a341be268 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeChatExtensionConfiguration.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeChatExtensionConfiguration.cs @@ -11,7 +11,7 @@ namespace Azure.AI.OpenAI { /// - /// A specific representation of configurable options for Elasticsearch when using it as an Azure OpenAI chat + /// A specific representation of configurable options for Pinecone when using it as an Azure OpenAI chat /// extension. /// public partial class PineconeChatExtensionConfiguration : AzureChatExtensionConfiguration diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeChatExtensionParameters.Serialization.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeChatExtensionParameters.Serialization.cs index 87a3ec1d3f65a..f484ace02b7fe 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeChatExtensionParameters.Serialization.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeChatExtensionParameters.Serialization.cs @@ -46,11 +46,8 @@ void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) writer.WriteStringValue(IndexName); writer.WritePropertyName("fieldsMapping"u8); writer.WriteObjectValue(FieldMappingOptions); - if (Optional.IsDefined(EmbeddingDependency)) - { - writer.WritePropertyName("embeddingDependency"u8); - writer.WriteObjectValue(EmbeddingDependency); - } + writer.WritePropertyName("embeddingDependency"u8); + writer.WriteObjectValue(EmbeddingDependency); writer.WriteEndObject(); } diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeChatExtensionParameters.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeChatExtensionParameters.cs index 8947a5e89b601..897051d3f9e70 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeChatExtensionParameters.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeChatExtensionParameters.cs @@ -10,9 +10,28 @@ namespace Azure.AI.OpenAI { - /// Parameters for configuring Azure OpenAI Pinecone chat extensions. + /// Parameters for configuring Azure OpenAI Pinecone chat extensions. The supported authentication type is APIKey. internal partial class PineconeChatExtensionParameters { + /// Initializes a new instance of . + /// The environment name of Pinecone. + /// The name of the Pinecone database index. + /// Customized field mapping behavior to use when interacting with the search index. + /// The embedding dependency for vector search. + /// , , or is null. + public PineconeChatExtensionParameters(string environmentName, string indexName, PineconeFieldMappingOptions fieldMappingOptions, OnYourDataVectorizationSource embeddingDependency) + { + Argument.AssertNotNull(environmentName, nameof(environmentName)); + Argument.AssertNotNull(indexName, nameof(indexName)); + Argument.AssertNotNull(fieldMappingOptions, nameof(fieldMappingOptions)); + Argument.AssertNotNull(embeddingDependency, nameof(embeddingDependency)); + + EnvironmentName = environmentName; + IndexName = indexName; + FieldMappingOptions = fieldMappingOptions; + EmbeddingDependency = embeddingDependency; + } + /// Initializes a new instance of . /// /// The authentication method to use when accessing the defined data source. @@ -49,7 +68,7 @@ internal PineconeChatExtensionParameters(OnYourDataAuthenticationOptions authent /// If not otherwise provided, On Your Data will attempt to use System Managed Identity (default credential) /// authentication. /// 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 available derived classes include , , , , , and . /// public OnYourDataAuthenticationOptions Authentication { get; set; } /// The configured top number of documents to feature for the configured query. @@ -67,6 +86,6 @@ internal PineconeChatExtensionParameters(OnYourDataAuthenticationOptions authent /// 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 OnYourDataVectorizationSource EmbeddingDependency { get; set; } + public OnYourDataVectorizationSource EmbeddingDependency { get; } } } diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeFieldMappingOptions.Serialization.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeFieldMappingOptions.Serialization.cs index e6f14d6d0dff9..d4e7dbaab7940 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeFieldMappingOptions.Serialization.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeFieldMappingOptions.Serialization.cs @@ -30,41 +30,18 @@ void IUtf8JsonSerializable.Write(Utf8JsonWriter writer) writer.WritePropertyName("filepathField"u8); writer.WriteStringValue(FilepathFieldName); } - if (Optional.IsCollectionDefined(ContentFieldNames)) + writer.WritePropertyName("contentFields"u8); + writer.WriteStartArray(); + foreach (var item in ContentFieldNames) { - writer.WritePropertyName("contentFields"u8); - writer.WriteStartArray(); - foreach (var item in ContentFieldNames) - { - writer.WriteStringValue(item); - } - writer.WriteEndArray(); + writer.WriteStringValue(item); } + writer.WriteEndArray(); if (Optional.IsDefined(ContentFieldSeparator)) { writer.WritePropertyName("contentFieldsSeparator"u8); writer.WriteStringValue(ContentFieldSeparator); } - if (Optional.IsCollectionDefined(VectorFieldNames)) - { - writer.WritePropertyName("vectorFields"u8); - writer.WriteStartArray(); - foreach (var item in VectorFieldNames) - { - writer.WriteStringValue(item); - } - writer.WriteEndArray(); - } - if (Optional.IsCollectionDefined(ImageVectorFieldNames)) - { - writer.WritePropertyName("imageVectorFields"u8); - writer.WriteStartArray(); - foreach (var item in ImageVectorFieldNames) - { - writer.WriteStringValue(item); - } - writer.WriteEndArray(); - } writer.WriteEndObject(); } diff --git a/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeFieldMappingOptions.cs b/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeFieldMappingOptions.cs index daafcbe5597ed..8709e34197ea1 100644 --- a/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeFieldMappingOptions.cs +++ b/sdk/openai/Azure.AI.OpenAI/src/Generated/PineconeFieldMappingOptions.cs @@ -5,7 +5,9 @@ #nullable disable +using System; using System.Collections.Generic; +using System.Linq; using Azure.Core; namespace Azure.AI.OpenAI @@ -14,11 +16,13 @@ namespace Azure.AI.OpenAI public partial class PineconeFieldMappingOptions { /// Initializes a new instance of . - public PineconeFieldMappingOptions() + /// The names of index fields that should be treated as content. + /// is null. + public PineconeFieldMappingOptions(IEnumerable contentFieldNames) { - ContentFieldNames = new ChangeTrackingList(); - VectorFieldNames = new ChangeTrackingList(); - ImageVectorFieldNames = new ChangeTrackingList(); + Argument.AssertNotNull(contentFieldNames, nameof(contentFieldNames)); + + ContentFieldNames = contentFieldNames.ToList(); } /// Initializes a new instance of . @@ -27,17 +31,13 @@ public PineconeFieldMappingOptions() /// The name of the index field to use as a filepath. /// The names of index fields that should be treated as content. /// The separator pattern that content fields should use. - /// The names of fields that represent vector data. - /// The names of fields that represent image vector data. - internal PineconeFieldMappingOptions(string titleFieldName, string urlFieldName, string filepathFieldName, IList contentFieldNames, string contentFieldSeparator, IList vectorFieldNames, IList imageVectorFieldNames) + internal PineconeFieldMappingOptions(string titleFieldName, string urlFieldName, string filepathFieldName, IList contentFieldNames, string contentFieldSeparator) { TitleFieldName = titleFieldName; UrlFieldName = urlFieldName; FilepathFieldName = filepathFieldName; ContentFieldNames = contentFieldNames; ContentFieldSeparator = contentFieldSeparator; - VectorFieldNames = vectorFieldNames; - ImageVectorFieldNames = imageVectorFieldNames; } /// The name of the index field to use as a title. @@ -50,9 +50,5 @@ internal PineconeFieldMappingOptions(string titleFieldName, string urlFieldName, public IList ContentFieldNames { get; } /// The separator pattern that content fields should use. public string ContentFieldSeparator { get; set; } - /// The names of fields that represent vector data. - public IList VectorFieldNames { get; } - /// The names of fields that represent image vector data. - public IList ImageVectorFieldNames { get; } } } diff --git a/sdk/openai/Azure.AI.OpenAI/tsp-location.yaml b/sdk/openai/Azure.AI.OpenAI/tsp-location.yaml index c9b92ca8da803..8ac51563ed289 100644 --- a/sdk/openai/Azure.AI.OpenAI/tsp-location.yaml +++ b/sdk/openai/Azure.AI.OpenAI/tsp-location.yaml @@ -1,3 +1,5 @@ +additionalDirectories: [] directory: specification/cognitiveservices/OpenAI.Inference -commit: 848070b3dab1b5e76eee3587e99dddad8f36d6d7 -repo: Azure/azure-rest-api-specs +repo: test-repo-billy/azure-rest-api-specs +commit: 82186691d45005df81b7a474133a215bef79d701 +