Skip to content

[Discovery] Azure.AI.Discovery 1.0.0-beta.1 preview release for API version 2026-02-01-preview#59320

Open
ahall-msft wants to merge 1 commit into
mainfrom
discovery/2026-02-01-preview
Open

[Discovery] Azure.AI.Discovery 1.0.0-beta.1 preview release for API version 2026-02-01-preview#59320
ahall-msft wants to merge 1 commit into
mainfrom
discovery/2026-02-01-preview

Conversation

@ahall-msft
Copy link
Copy Markdown
Member

@ahall-msft ahall-msft commented May 19, 2026 •
edited
Loading

Description

Initial preview release of Azure.AI.Discovery 1.0.0-beta.1.

This pull request introduces a new client library for the Azure AI Discovery
service. It provides two clients under the Azure.AI.Discovery namespace:

  • WorkspaceClient — exposing sub-clients for investigations, conversations,
    tasks, and tools.
  • BookshelfClient — exposing sub-clients for knowledge bases and knowledge
    base versions.

Generated from TypeSpec at:

  • specification/discovery/Discovery.Workspace
  • specification/discovery/Discovery.Bookshelf

in Azure/azure-rest-api-specs at commit
7089f3d2a4ed7e765d66f5f5e3be0b8b1eed6c1a.

Spec PR: Azure/azure-rest-api-specs#39746 (merged 2026-05-05)
Release plan: 2032 - Public Preview - Microsoft Discovery
Sibling SDK PR: Azure/azure-sdk-for-python#46940 (Python data-plane release)

All SDK Contribution checklist:

  • The pull request does not introduce [breaking changes] (initial release)
  • CHANGELOG is updated for new features, bug fixes or other significant changes.
  • I have read the contribution guidelines.

General Guidelines and Best Practices

  • Title of the pull request is clear and informative.
  • There are a small number of commits, each of which have an informative message.

Testing Guidelines

  • Pull request includes test coverage for the included changes.

Release Plan Details

@ahall-msft ahall-msft force-pushed the discovery/2026-02-01-preview branch 3 times, most recently from f87dd27 to 8fea2f4 Compare May 20, 2026 21:09
@ahall-msft ahall-msft mentioned this pull request May 20, 2026
Draft
@ahall-msft ahall-msft marked this pull request as ready for review May 20, 2026 22:11
@ahall-msft ahall-msft force-pushed the discovery/2026-02-01-preview branch from 8fea2f4 to be19477 Compare May 20, 2026 22:11
@ahall-msft ahall-msft requested a review from jsquire as a code owner May 20, 2026 22:11
Copilot AI review requested due to automatic review settings May 20, 2026 22:11
@ahall-msft ahall-msft requested review from a team, benbp, hallipr, m-redding and weshaggard as code owners May 20, 2026 22:11
Copilot AI reviewed May 20, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot wasn't able to review this pull request because it exceeds the maximum number of lines (20,000). Try reducing the number of changed lines and requesting a review from Copilot again.

@ahall-msft
[Discovery] Initial release of Azure.AI.Discovery 1.0.0-beta.1
52bd915 
New client library for the Azure AI Discovery service (API version 2026-02-01-preview).

Provides two clients under the Azure.AI.Discovery namespace:
- WorkspaceClient: investigations, conversations, tasks, and tools
- BookshelfClient: knowledge bases and knowledge base versions

Generated from TypeSpec specifications:
- specification/discovery/Discovery.Workspace
- specification/discovery/Discovery.Bookshelf

Spec PR: Azure/azure-rest-api-specs#39746
Release plan: 2032 - Public Preview - Microsoft Discovery
@ahall-msft ahall-msft force-pushed the discovery/2026-02-01-preview branch from be19477 to 52bd915 Compare May 20, 2026 22:45
jsquire
jsquire requested changes May 20, 2026
View reviewed changes
Copy link
Copy Markdown
Member

@jsquire jsquire left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove _bookshelf and _workspace. These are not the standard hierarchy used by Azure SDK libraries and are likely to cause issues in the repository engineering systems.

Comment thread sdk/discovery/Azure.AI.Discovery/samples/snippets/InvestigationsSnippets.cs
/// </summary>
public async Task CreateAndManageInvestigation()
{
#region Snippet:CreateAndManageInvestigation
Copy link
Copy Markdown
Member

@jsquire jsquire May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please name snippets with an association to your library. They are global in scope and something generic like this runs a high risk of collisions.

Example: Discovery_CreateAndManageInvestigation

Comment thread sdk/discovery/Azure.AI.Discovery/samples/snippets/Azure.AI.Discovery.Snippets.csproj
@@ -0,0 +1,16 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
Copy link
Copy Markdown
Member

@jsquire jsquire May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please move your snippets to your test project to follow standard repository patterns.

Comment thread sdk/discovery/Azure.AI.Discovery/samples/snippets/Azure.AI.Discovery.Snippets.csproj
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<OutputType>Library</OutputType>
<NoWarn>$(NoWarn);CS1998</NoWarn> <!-- Suppress async method without await -->
Copy link
Copy Markdown
Member

@jsquire jsquire May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This should not be suppressed, and certainly not globally.

Comment thread sdk/discovery/Azure.AI.Discovery/samples/README.md
@@ -0,0 +1,48 @@
# Azure AI Discovery samples for .NET

This directory contains sample code demonstrating common scenarios for the [Azure AI Discovery client library for .NET](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/discovery/Azure.AI.Discovery/README.md).
Copy link
Copy Markdown
Member

@jsquire jsquire May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not how the Azure SDK for .NET represents samples. These should be markdown-based samples with snippets injected, per the Azure SDK guidelines.

Comment thread sdk/discovery/Azure.AI.Discovery/samples/Directory.Build.targets
@@ -0,0 +1,14 @@
<Project>
Copy link
Copy Markdown
Member

@jsquire jsquire May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please remove props, targets, and csproj files from the samples area.

Comment thread sdk/discovery/Azure.AI.Discovery/src/Azure.AI.Discovery.csproj

<ItemGroup>
<PackageReference Include="Azure.Core" />
<PackageReference Include="System.Text.Json" />
Copy link
Copy Markdown
Member

@jsquire jsquire May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove; this comes in transitively via Core.

Comment thread sdk/discovery/Azure.AI.Discovery/README.md
Both clients use Microsoft Entra ID (Azure Active Directory) token authentication. Use the [Azure.Identity][azure_identity] library to obtain credentials:

```dotnetcli
dotnet add package Azure.Identity
Copy link
Copy Markdown
Member

@jsquire jsquire May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is no longer needed and should be removed. Credentials are now bundled into Core.

Comment thread sdk/discovery/Azure.AI.Discovery/README.md
- **`KnowledgeBases`** — list available knowledge bases.
- **`KnowledgeBaseVersions`** — create, update, index, and manage versions of knowledge bases backed by storage assets.

```C#
Copy link
Copy Markdown
Member

@jsquire jsquire May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All code in samples and README files should be snippets.

Comment thread sdk/discovery/Azure.AI.Discovery/README.md

This library uses the standard Azure.Core diagnostics pipeline. Enable detailed HTTP request/response logging by adding an `AzureEventSourceListener` to your application:

```C#
Copy link
Copy Markdown
Member

@jsquire jsquire May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Snippet, please

Comment thread sdk/discovery/Azure.AI.Discovery/CHANGELOG.md

### Features Added

- Added `WorkspaceClient` for managing Discovery workspace resources, with sub-clients for:
Copy link
Copy Markdown
Member

@jsquire jsquire May 20, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This isn't the right level of detail; we want to keep change logs focused on high-level features.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

Copilot code review Copilot Copilot left review comments

@jsquire jsquire jsquire requested changes

@m-redding m-redding Awaiting requested review from m-redding m-redding is a code owner

@hallipr hallipr Awaiting requested review from hallipr hallipr is a code owner

@weshaggard weshaggard Awaiting requested review from weshaggard weshaggard is a code owner

@benbp benbp Awaiting requested review from benbp benbp is a code owner

Requested changes must be addressed to merge this pull request.

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@ahall-msft @jsquire