|
| 1 | +# Azure Agents client library for Java |
| 2 | + |
| 3 | +Azure Agents client library for Java. |
| 4 | + |
| 5 | +This package contains Microsoft Azure Agents client library. |
| 6 | + |
| 7 | +## Documentation |
| 8 | + |
| 9 | +Various documentation is available to help you get started |
| 10 | + |
| 11 | +- [API reference documentation][docs] |
| 12 | +- [Product documentation][product_documentation] |
| 13 | + |
| 14 | +## Getting started |
| 15 | + |
| 16 | +### Prerequisites |
| 17 | + |
| 18 | +- [Java Development Kit (JDK)][jdk] with version 8 or above |
| 19 | +- [Azure Subscription][azure_subscription] |
| 20 | + |
| 21 | +### Adding the package to your product |
| 22 | + |
| 23 | +[//]: # ({x-version-update-start;com.azure:azure-ai-agents-persistent;current}) |
| 24 | +```xml |
| 25 | +<dependency> |
| 26 | + <groupId>com.azure</groupId> |
| 27 | + <artifactId>azure-ai-agents-persistent</artifactId> |
| 28 | + <version>1.0.0-beta.1</version> |
| 29 | +</dependency> |
| 30 | +``` |
| 31 | +[//]: # ({x-version-update-end}) |
| 32 | + |
| 33 | +### Authentication |
| 34 | + |
| 35 | +[Azure Identity][azure_identity] package provides the default implementation for authenticating the client. |
| 36 | + |
| 37 | +## Key concepts |
| 38 | + |
| 39 | +## Examples |
| 40 | + |
| 41 | +```java com.azure.ai.agents.persistent.readme |
| 42 | +``` |
| 43 | + |
| 44 | +### Service API versions |
| 45 | + |
| 46 | +The client library targets the latest service API version by default. |
| 47 | +The service client builder accepts an optional service API version parameter to specify which API version to communicate. |
| 48 | + |
| 49 | +#### Select a service API version |
| 50 | + |
| 51 | +You have the flexibility to explicitly select a supported service API version when initializing a service client via the service client builder. |
| 52 | +This ensures that the client can communicate with services using the specified API version. |
| 53 | + |
| 54 | +When selecting an API version, it is important to verify that there are no breaking changes compared to the latest API version. |
| 55 | +If there are significant differences, API calls may fail due to incompatibility. |
| 56 | + |
| 57 | +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. |
| 58 | + |
| 59 | +## Troubleshooting |
| 60 | + |
| 61 | +## Next steps |
| 62 | + |
| 63 | +## Contributing |
| 64 | + |
| 65 | +For details on contributing to this repository, see the [contributing guide](https://github.com/Azure/azure-sdk-for-java/blob/main/CONTRIBUTING.md). |
| 66 | + |
| 67 | +1. Fork it |
| 68 | +1. Create your feature branch (`git checkout -b my-new-feature`) |
| 69 | +1. Commit your changes (`git commit -am 'Add some feature'`) |
| 70 | +1. Push to the branch (`git push origin my-new-feature`) |
| 71 | +1. Create new Pull Request |
| 72 | + |
| 73 | +<!-- LINKS --> |
| 74 | +[product_documentation]: https://azure.microsoft.com/services/ |
| 75 | +[docs]: https://azure.github.io/azure-sdk-for-java/ |
| 76 | +[jdk]: https://learn.microsoft.com/azure/developer/java/fundamentals/ |
| 77 | +[azure_subscription]: https://azure.microsoft.com/free/ |
| 78 | +[azure_identity]: https://github.com/Azure/azure-sdk-for-java/blob/main/sdk/identity/azure-identity |
0 commit comments