-
Notifications
You must be signed in to change notification settings - Fork 2.2k
[discovery] Add azure-ai-discovery 1.0.0 (GA) #49932
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
Open
ahall-msft
wants to merge
3
commits into
main
Choose a base branch
from
discovery-dataplane-1.0.0
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| # Release History | ||
|
|
||
| ## 1.0.0 (2026-07-20) | ||
|
|
||
| Initial general availability (GA) release of the Azure AI Discovery client library for Java. This package targets the Microsoft Discovery data-plane API version `2026-06-01`. | ||
|
|
||
| ### Features Added | ||
|
|
||
| - `WorkspaceClient` and `WorkspaceAsyncClient` for working with Discovery workspaces, including conversations, investigations, tasks, and tools. | ||
| - `BookshelfClient` and `BookshelfAsyncClient` for managing knowledge bases, including long-running create/update, indexing, and search operations. | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| # Azure Discovery client library for Java | ||
|
|
||
| Azure Discovery client library for Java. | ||
|
|
||
| This package contains Microsoft Azure Discovery client library. | ||
|
|
||
| ## Documentation | ||
|
|
||
| Various documentation is available to help you get started | ||
|
|
||
| - [API reference documentation][docs] | ||
| - [Product documentation][product_documentation] | ||
|
|
||
| ## Getting started | ||
|
|
||
| ### Prerequisites | ||
|
|
||
| - [Java Development Kit (JDK)][jdk] with version 8 or above | ||
| - [Azure Subscription][azure_subscription] | ||
|
|
||
| ### Adding the package to your product | ||
|
|
||
| [//]: # ({x-version-update-start;com.azure:azure-ai-discovery;current}) | ||
| ```xml | ||
| <dependency> | ||
| <groupId>com.azure</groupId> | ||
| <artifactId>azure-ai-discovery</artifactId> | ||
| <version>1.0.0</version> | ||
| </dependency> | ||
| ``` | ||
| [//]: # ({x-version-update-end}) | ||
|
|
||
| ### Authentication | ||
|
|
||
| [Azure Identity][azure_identity] package provides the default implementation for authenticating the client. | ||
|
|
||
| ## Key concepts | ||
|
|
||
| ## Examples | ||
|
|
||
| ```java com.azure.ai.discovery.readme | ||
| ``` | ||
|
Comment on lines
+41
to
+42
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We should have at least one sample to get user started. Put it in ReadmeSamples.java, and it should sync here. |
||
|
|
||
| ### Service API versions | ||
|
|
||
| The client library targets the latest service API version by default. | ||
| The service client builder accepts an optional service API version parameter to specify which API version to communicate. | ||
|
|
||
| #### Select a service API version | ||
|
|
||
| You have the flexibility to explicitly select a supported service API version when initializing a service client via the service client builder. | ||
| This ensures that the client can communicate with services using the specified API version. | ||
|
|
||
| When selecting an API version, it is important to verify that there are no breaking changes compared to the latest API version. | ||
| If there are significant differences, API calls may fail due to incompatibility. | ||
|
|
||
| Always ensure that the chosen API version is fully supported and operational for your specific use case and that it aligns with the service's versioning policy. | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| ## Next steps | ||
|
|
||
| ## Contributing | ||
|
|
||
| For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/main/CONTRIBUTING.md). | ||
|
|
||
| 1. Fork it | ||
| 1. Create your feature branch (`git checkout -b my-new-feature`) | ||
| 1. Commit your changes (`git commit -am 'Add some feature'`) | ||
| 1. Push to the branch (`git push origin my-new-feature`) | ||
| 1. Create new Pull Request | ||
|
|
||
| <!-- LINKS --> | ||
| [product_documentation]: https://azure.microsoft.com/services/ | ||
| [docs]: https://azure.github.io/azure-sdk-for-java/ | ||
| [jdk]: https://learn.microsoft.com/azure/developer/java/fundamentals/ | ||
| [azure_subscription]: https://azure.microsoft.com/free/ | ||
| [azure_identity]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/identity/azure-identity | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "AssetsRepo" : "Azure/azure-sdk-assets", | ||
| "AssetsRepoPrefixPath" : "java", | ||
| "TagPrefix" : "java/discovery/azure-ai-discovery", | ||
| "Tag" : "java/discovery/azure-ai-discovery_2380bf9632" | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE suppressions PUBLIC "-//Checkstyle//DTD SuppressionFilter Configuration 1.2//EN" "https://checkstyle.org/dtds/suppressions_1_2.dtd"> | ||
| <!-- This file is generated by the /eng/scripts/linting_suppression_generator.py script. --> | ||
|
|
||
| <suppressions> | ||
| </suppressions> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| <!-- | ||
| ~ Copyright (c) Microsoft Corporation. All rights reserved. | ||
| ~ Licensed under the MIT License. | ||
| ~ Code generated by Microsoft (R) TypeSpec Code Generator. | ||
| --> | ||
| <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> | ||
| <modelVersion>4.0.0</modelVersion> | ||
| <parent> | ||
| <groupId>com.azure</groupId> | ||
| <artifactId>azure-client-sdk-parent</artifactId> | ||
| <version>1.7.0</version> <!-- {x-version-update;com.azure:azure-client-sdk-parent;current} --> | ||
| <relativePath>../../parents/azure-client-sdk-parent</relativePath> | ||
| </parent> | ||
|
|
||
| <groupId>com.azure</groupId> | ||
| <artifactId>azure-ai-discovery</artifactId> | ||
| <version>1.0.0</version> <!-- {x-version-update;com.azure:azure-ai-discovery;current} --> | ||
| <packaging>jar</packaging> | ||
|
|
||
| <name>Microsoft Azure SDK for Discovery</name> | ||
| <description>This package contains Microsoft Azure Discovery client library.</description> | ||
| <url>https://github.com/Azure/azure-sdk-for-java</url> | ||
|
|
||
| <licenses> | ||
| <license> | ||
| <name>The MIT License (MIT)</name> | ||
| <url>http://opensource.org/licenses/MIT</url> | ||
| <distribution>repo</distribution> | ||
| </license> | ||
| </licenses> | ||
|
|
||
| <scm> | ||
| <url>https://github.com/Azure/azure-sdk-for-java</url> | ||
| <connection>scm:git:git@github.com:Azure/azure-sdk-for-java.git</connection> | ||
| <developerConnection>scm:git:git@github.com:Azure/azure-sdk-for-java.git</developerConnection> | ||
| <tag>HEAD</tag> | ||
| </scm> | ||
| <developers> | ||
| <developer> | ||
| <id>microsoft</id> | ||
| <name>Microsoft</name> | ||
| </developer> | ||
| </developers> | ||
| <properties> | ||
| <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> | ||
| </properties> | ||
| <dependencies> | ||
| <dependency> | ||
| <groupId>com.azure</groupId> | ||
| <artifactId>azure-core</artifactId> | ||
| <version>1.58.1</version> <!-- {x-version-update;com.azure:azure-core;dependency} --> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.azure</groupId> | ||
| <artifactId>azure-core-http-netty</artifactId> | ||
| <version>1.16.5</version> <!-- {x-version-update;com.azure:azure-core-http-netty;dependency} --> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.azure</groupId> | ||
| <artifactId>azure-core-test</artifactId> | ||
| <version>1.27.0-beta.16</version> <!-- {x-version-update;com.azure:azure-core-test;dependency} --> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| <dependency> | ||
| <groupId>com.azure</groupId> | ||
| <artifactId>azure-identity</artifactId> | ||
| <version>1.18.4</version> <!-- {x-version-update;com.azure:azure-identity;dependency} --> | ||
| <scope>test</scope> | ||
| </dependency> | ||
| </dependencies> | ||
| </project> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
|
|
||
| <FindBugsFilter xmlns="https://github.com/spotbugs/filter/3.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" | ||
| xsi:schemaLocation="https://github.com/spotbugs/filter/3.0.0 https://raw.githubusercontent.com/spotbugs/spotbugs/3.1.0/spotbugs/etc/findbugsfilter.xsd"> | ||
| <!-- Generated JSON merge-patch serialization emits null checks on required, known-non-null | ||
| date-time fields. These are false positives in generated code. --> | ||
| <Match> | ||
| <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE" /> | ||
| <Or> | ||
| <Class name="com.azure.ai.discovery.models.Conversation" /> | ||
| <Class name="com.azure.ai.discovery.models.ExecutionHistoryEntry" /> | ||
| <Class name="com.azure.ai.discovery.models.TaskComment" /> | ||
| </Or> | ||
| </Match> | ||
| </FindBugsFilter> |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is no
WorkspaceClientin code.