From 85db8d005cb55da9fa65d4bc978320a391b67e2b Mon Sep 17 00:00:00 2001 From: Sebastien Ros Date: Wed, 8 May 2024 11:38:11 -0700 Subject: [PATCH] Update some Azure AI branding --- .../README.md | 2 +- .../AzureSearchExtensions.cs | 2 +- src/Aspire.Hosting.Azure.Search/README.md | 6 +++--- src/Components/Aspire.Azure.AI.OpenAI/README.md | 8 ++++---- .../Aspire.Azure.Search.Documents.csproj | 2 +- .../AzureSearchSettings.cs | 10 +++++----- .../ConfigurationSchema.json | 8 ++++---- .../Aspire.Azure.Search.Documents/README.md | 16 ++++++++-------- 8 files changed, 27 insertions(+), 27 deletions(-) diff --git a/src/Aspire.Hosting.Azure.CognitiveServices/README.md b/src/Aspire.Hosting.Azure.CognitiveServices/README.md index e9512a2aab2..43d92df5b33 100644 --- a/src/Aspire.Hosting.Azure.CognitiveServices/README.md +++ b/src/Aspire.Hosting.Azure.CognitiveServices/README.md @@ -38,7 +38,7 @@ automatically. ## Usage example -Then, in the _Program.cs_ file of `AppHost`, add an Azure AI OpenAI service and consume the connection using the following methods: +Then, in the _Program.cs_ file of `AppHost`, add an Azure OpenAI service and consume the connection using the following methods: ```csharp var openai = builder.AddAzureOpenAI("openai"); diff --git a/src/Aspire.Hosting.Azure.Search/AzureSearchExtensions.cs b/src/Aspire.Hosting.Azure.Search/AzureSearchExtensions.cs index 4cd44cc3cd2..462c1fdf29c 100644 --- a/src/Aspire.Hosting.Azure.Search/AzureSearchExtensions.cs +++ b/src/Aspire.Hosting.Azure.Search/AzureSearchExtensions.cs @@ -11,7 +11,7 @@ namespace Aspire.Hosting; /// -/// Provides extension methods for adding the Azure Search resources to the application model. +/// Provides extension methods for adding the Azure AI Search resources to the application model. /// public static class AzureSearchExtensions { diff --git a/src/Aspire.Hosting.Azure.Search/README.md b/src/Aspire.Hosting.Azure.Search/README.md index fff227117e6..2c9bd558691 100644 --- a/src/Aspire.Hosting.Azure.Search/README.md +++ b/src/Aspire.Hosting.Azure.Search/README.md @@ -1,6 +1,6 @@ # Aspire.Hosting.Azure.Search library -Provides extension methods and resource definitions for a .NET Aspire AppHost to configure Azure Search Service. +Provides extension methods and resource definitions for a .NET Aspire AppHost to configure Azure AI Search Service. ## Getting started @@ -10,7 +10,7 @@ Provides extension methods and resource definitions for a .NET Aspire AppHost to ### Install the package -Install the .NET Aspire Azure Search Hosting library with [NuGet](https://www.nuget.org): +Install the .NET Aspire Azure AI Search Hosting library with [NuGet](https://www.nuget.org): ```dotnetcli dotnet add package Aspire.Hosting.Azure.Search @@ -38,7 +38,7 @@ automatically. ## Usage example -Then, in the _Program.cs_ file of `AppHost`, add an Azure Search service and consume the connection using the following methods: +Then, in the _Program.cs_ file of `AppHost`, add an Azure AI Search service and consume the connection using the following methods: ```csharp var search = builder.AddAzureSearch("search"); diff --git a/src/Components/Aspire.Azure.AI.OpenAI/README.md b/src/Components/Aspire.Azure.AI.OpenAI/README.md index 9a3a2fc5f14..9733216bb91 100644 --- a/src/Components/Aspire.Azure.AI.OpenAI/README.md +++ b/src/Components/Aspire.Azure.AI.OpenAI/README.md @@ -11,7 +11,7 @@ Registers [OpenAIClient](https://learn.microsoft.com/dotnet/api/azure.ai.openai. ### Install the package -Install the .NET Aspire Azure AI OpenAI library with [NuGet](https://www.nuget.org): +Install the .NET Aspire Azure OpenAI library with [NuGet](https://www.nuget.org): ```dotnetcli dotnet add package Aspire.Azure.AI.OpenAI @@ -40,7 +40,7 @@ See the [Azure OpenAI Service quickstarts](https://learn.microsoft.com/azure/ai- ## Configuration -The .NET Aspire Azure Azure OpenAI library provides multiple options to configure the Azure OpenAI Service based on the requirements and conventions of your project. Note that either an `Endpoint` or a `ConnectionString` is required to be supplied. +The .NET Aspire Azure OpenAI library provides multiple options to configure the Azure OpenAI Service based on the requirements and conventions of your project. Note that either an `Endpoint` or a `ConnectionString` is required to be supplied. ### Use a connection string @@ -80,7 +80,7 @@ In order to connect to the non-Azure OpenAI service, drop the Endpoint property ### Use configuration providers -The .NET Aspire Azure AI OpenAI library supports [Microsoft.Extensions.Configuration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration). It loads the `AzureOpenAISettings` and `OpenAIClientOptions` from configuration by using the `Aspire:Azure:AI:OpenAI` key. Example `appsettings.json` that configures some of the options: +The .NET Aspire Azure OpenAI library supports [Microsoft.Extensions.Configuration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration). It loads the `AzureOpenAISettings` and `OpenAIClientOptions` from configuration by using the `Aspire:Azure:AI:OpenAI` key. Example `appsettings.json` that configures some of the options: ```json { @@ -118,7 +118,7 @@ In your AppHost project, install the Aspire Azure Cognitive Services Hosting lib dotnet add package Aspire.Hosting.Azure.CognitiveServices ``` -Then, in the _Program.cs_ file of `AppHost`, add an Azure AI OpenAI service and consume the connection using the following methods: +Then, in the _Program.cs_ file of `AppHost`, add an Azure OpenAI service and consume the connection using the following methods: ```csharp var openai = builder.ExecutionContext.IsPublishMode diff --git a/src/Components/Aspire.Azure.Search.Documents/Aspire.Azure.Search.Documents.csproj b/src/Components/Aspire.Azure.Search.Documents/Aspire.Azure.Search.Documents.csproj index c1779ad5be4..f580ec08451 100644 --- a/src/Components/Aspire.Azure.Search.Documents/Aspire.Azure.Search.Documents.csproj +++ b/src/Components/Aspire.Azure.Search.Documents/Aspire.Azure.Search.Documents.csproj @@ -4,7 +4,7 @@ $(NetCurrent) true $(ComponentAzurePackageTags) azure search - A client for Azure Search that integrates with Aspire, including logging and telemetry. + A client for Azure AI Search that integrates with Aspire, including logging and telemetry. $(SharedDir)AzureSearch_256x.png $(NoWarn);SYSLIB1100;SYSLIB1101 diff --git a/src/Components/Aspire.Azure.Search.Documents/AzureSearchSettings.cs b/src/Components/Aspire.Azure.Search.Documents/AzureSearchSettings.cs index 89ff63d6ae0..9a89281c7c3 100644 --- a/src/Components/Aspire.Azure.Search.Documents/AzureSearchSettings.cs +++ b/src/Components/Aspire.Azure.Search.Documents/AzureSearchSettings.cs @@ -9,7 +9,7 @@ namespace Aspire.Azure.Search.Documents; /// -/// Provides the client configuration settings for connecting to Azure Search. +/// Provides the client configuration settings for connecting to Azure AI Search. /// public sealed class AzureSearchSettings : IConnectionStringSettings { @@ -17,7 +17,7 @@ public sealed class AzureSearchSettings : IConnectionStringSettings private const string ConnectionStringKey = "Key"; /// - /// Gets or sets a referencing the Azure Search endpoint. + /// Gets or sets a referencing the Azure AI Search endpoint. /// This is likely to be similar to "https://{search_service}.search.windows.net". /// /// @@ -27,12 +27,12 @@ public sealed class AzureSearchSettings : IConnectionStringSettings public Uri? Endpoint { get; set; } /// - /// Gets or sets the credential used to authenticate to the Azure Search resource. + /// Gets or sets the credential used to authenticate to the Azure AI Search resource. /// public TokenCredential? Credential { get; set; } /// - /// Gets or sets the key to use to authenticate to the Azure Search endpoint. + /// Gets or sets the key to use to authenticate to the Azure AI Search endpoint. /// /// /// When defined it will use an instance instead of . @@ -40,7 +40,7 @@ public sealed class AzureSearchSettings : IConnectionStringSettings public string? Key { get; set; } /// - /// Gets or sets a boolean value that indicates whether the Azure Search health check is disabled or not. + /// Gets or sets a boolean value that indicates whether the Azure AI Search health check is disabled or not. /// /// /// The default value is . diff --git a/src/Components/Aspire.Azure.Search.Documents/ConfigurationSchema.json b/src/Components/Aspire.Azure.Search.Documents/ConfigurationSchema.json index 749c849973f..a898695525e 100644 --- a/src/Components/Aspire.Azure.Search.Documents/ConfigurationSchema.json +++ b/src/Components/Aspire.Azure.Search.Documents/ConfigurationSchema.json @@ -104,7 +104,7 @@ }, "DisableHealthChecks": { "type": "boolean", - "description": "Gets or sets a boolean value that indicates whether the Azure Search health check is disabled or not.", + "description": "Gets or sets a boolean value that indicates whether the Azure AI Search health check is disabled or not.", "default": false }, "DisableTracing": { @@ -115,14 +115,14 @@ "Endpoint": { "type": "string", "format": "uri", - "description": "Gets or sets a 'System.Uri' referencing the Azure Search endpoint.\nThis is likely to be similar to \"https://{search_service}.search.windows.net\"." + "description": "Gets or sets a 'System.Uri' referencing the Azure AI Search endpoint.\nThis is likely to be similar to \"https://{search_service}.search.windows.net\"." }, "Key": { "type": "string", - "description": "Gets or sets the key to use to authenticate to the Azure Search endpoint." + "description": "Gets or sets the key to use to authenticate to the Azure AI Search endpoint." } }, - "description": "Provides the client configuration settings for connecting to Azure Search." + "description": "Provides the client configuration settings for connecting to Azure AI Search." } } } diff --git a/src/Components/Aspire.Azure.Search.Documents/README.md b/src/Components/Aspire.Azure.Search.Documents/README.md index 11dd7f3f790..91182b151cc 100644 --- a/src/Components/Aspire.Azure.Search.Documents/README.md +++ b/src/Components/Aspire.Azure.Search.Documents/README.md @@ -1,17 +1,17 @@ # Aspire.Azure.Search.Documents library -Registers [SearchIndexClient](https://learn.microsoft.com/dotnet/api/azure.search.documents.indexes.searchindexclient) as a singleton in the DI container for connecting to Azure Search. Enables corresponding logging and telemetry. +Registers [SearchIndexClient](https://learn.microsoft.com/dotnet/api/azure.search.documents.indexes.searchindexclient) as a singleton in the DI container for connecting to Azure AI Search. Enables corresponding logging and telemetry. ## Getting started ### Prerequisites - Azure subscription - [create one for free](https://azure.microsoft.com/free/) -- Azure Search Service - [create an Azure Search Service resource](https://learn.microsoft.com/azure/search/search-create-service-portal) +- Azure AI Search Service - [create an Azure AI Search Service resource](https://learn.microsoft.com/azure/search/search-create-service-portal) ### Install the package -Install the .NET Aspire Azure Search library with [NuGet](https://www.nuget.org): +Install the .NET Aspire Azure AI Search library with [NuGet](https://www.nuget.org): ```dotnetcli dotnet add package Aspire.Azure.Search.Documents @@ -54,11 +54,11 @@ public async Task GetDocumentCountAsync(string indexName, CancellationToke } ``` -See the [Azure Search Service Getting Started](https://learn.microsoft.com/dotnet/api/overview/azure/search.documents-readme) for examples on using the `SearchIndexClient`. +See the [Azure AI Search client library for .NET](https://learn.microsoft.com/dotnet/api/overview/azure/search.documents-readme) for examples on using the `SearchIndexClient`. ## Configuration -The .NET Aspire Azure Azure Search library provides multiple options to configure the Azure Search Service based on the requirements and conventions of your project. Note that either an `Endpoint` or a `ConnectionString` is required to be supplied. +The .NET Aspire Azure AI Search library provides multiple options to configure the Azure AI Search Service based on the requirements and conventions of your project. Note that either an `Endpoint` or a `ConnectionString` is required to be supplied. ### Use a connection string @@ -96,7 +96,7 @@ Alternatively, a custom connection string can be used. ### Use configuration providers -The .NET Aspire Azure Search library supports [Microsoft.Extensions.Configuration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration). It loads the `AzureSearchSettings` and `SearchClientOptions` from configuration by using the `Aspire:Azure:Search:Documents` key. Example `appsettings.json` that configures some of the options: +The .NET Aspire Azure AI Search library supports [Microsoft.Extensions.Configuration](https://learn.microsoft.com/dotnet/api/microsoft.extensions.configuration). It loads the `AzureSearchSettings` and `SearchClientOptions` from configuration by using the `Aspire:Azure:Search:Documents` key. Example `appsettings.json` that configures some of the options: ```json { @@ -128,13 +128,13 @@ builder.AddAzureSearchClient("searchConnectionName", configureClientBuilder: bui ## AppHost extensions -In your AppHost project, install the Aspire Azure Search Hosting library with [NuGet](https://www.nuget.org): +In your AppHost project, install the Aspire Azure AI Search Hosting library with [NuGet](https://www.nuget.org): ```dotnetcli dotnet add package Aspire.Hosting.Azure.Search ``` -Then, in the _Program.cs_ file of `AppHost`, add an Azure Search service and consume the connection using the following methods: +Then, in the _Program.cs_ file of `AppHost`, add an Azure AI Search service and consume the connection using the following methods: ```csharp var search = builder.ExecutionContext.IsPublishMode