Skip to content

Update some Azure AI branding #4126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 9, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/Aspire.Hosting.Azure.CognitiveServices/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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");
Expand Down
2 changes: 1 addition & 1 deletion src/Aspire.Hosting.Azure.Search/AzureSearchExtensions.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
namespace Aspire.Hosting;

/// <summary>
/// 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.
/// </summary>
public static class AzureSearchExtensions
{
Expand Down
6 changes: 3 additions & 3 deletions src/Aspire.Hosting.Azure.Search/README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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
Expand Down Expand Up @@ -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");
Expand Down
8 changes: 4 additions & 4 deletions src/Components/Aspire.Azure.AI.OpenAI/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<TargetFramework>$(NetCurrent)</TargetFramework>
<IsPackable>true</IsPackable>
<PackageTags>$(ComponentAzurePackageTags) azure search</PackageTags>
<Description>A client for Azure Search that integrates with Aspire, including logging and telemetry.</Description>
<Description>A client for Azure AI Search that integrates with Aspire, including logging and telemetry.</Description>
<PackageIconFullPath>$(SharedDir)AzureSearch_256x.png</PackageIconFullPath>
<NoWarn>$(NoWarn);SYSLIB1100;SYSLIB1101</NoWarn>
</PropertyGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
namespace Aspire.Azure.Search.Documents;

/// <summary>
/// Provides the client configuration settings for connecting to Azure Search.
/// Provides the client configuration settings for connecting to Azure AI Search.
/// </summary>
public sealed class AzureSearchSettings : IConnectionStringSettings
{
private const string ConnectionStringEndpoint = "Endpoint";
private const string ConnectionStringKey = "Key";

/// <summary>
/// Gets or sets a <see cref="Uri"/> referencing the Azure Search endpoint.
/// Gets or sets a <see cref="Uri"/> referencing the Azure AI Search endpoint.
/// This is likely to be similar to "https://{search_service}.search.windows.net".
/// </summary>
/// <remarks>
Expand All @@ -27,20 +27,20 @@ public sealed class AzureSearchSettings : IConnectionStringSettings
public Uri? Endpoint { get; set; }

/// <summary>
/// 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.
/// </summary>
public TokenCredential? Credential { get; set; }

/// <summary>
/// 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.
/// </summary>
/// <remarks>
/// When defined it will use an <see cref="AzureKeyCredential"/> instance instead of <see cref="Credential"/>.
/// </remarks>
public string? Key { get; set; }

/// <summary>
/// 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.
/// </summary>
/// <value>
/// The default value is <see langword="false"/>.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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": {
Expand All @@ -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."
}
}
}
Expand Down
16 changes: 8 additions & 8 deletions src/Components/Aspire.Azure.Search.Documents/README.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down Expand Up @@ -54,11 +54,11 @@ public async Task<long> 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

Expand Down Expand Up @@ -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
{
Expand Down Expand Up @@ -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
Expand Down