|
| 1 | +# Azure.AI.Agents.Persistent client library for .NET |
| 2 | + |
| 3 | +Azure.AI.Agents.Persistent is a managed service that helps developers get secret simply and securely. |
| 4 | + |
| 5 | +Use the client library for to: |
| 6 | + |
| 7 | +* [Get secret](https://docs.microsoft.com/azure) |
| 8 | + |
| 9 | +[Source code][source_root] | [Package (NuGet)][package] | [API reference documentation][reference_docs] | [Product documentation][azconfig_docs] | [Samples][source_samples] |
| 10 | + |
| 11 | + [Source code](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/ai/Azure.AI.Agents.Persistent/src) | [Package (NuGet)](https://www.nuget.org/packages) | [API reference documentation](https://azure.github.io/azure-sdk-for-net) | [Product documentation](https://docs.microsoft.com/azure) |
| 12 | + |
| 13 | +## Getting started |
| 14 | + |
| 15 | +This section should include everything a developer needs to do to install and create their first client connection *very quickly*. |
| 16 | + |
| 17 | +### Install the package |
| 18 | + |
| 19 | +First, provide instruction for obtaining and installing the package or library. This section might include only a single line of code, like `dotnet add package package-name`, but should enable a developer to successfully install the package from NuGet, npm, or even cloning a GitHub repository. |
| 20 | + |
| 21 | +Install the client library for .NET with [NuGet](https://www.nuget.org/ ): |
| 22 | + |
| 23 | +```dotnetcli |
| 24 | +dotnet add package Azure.AI.Agents.Persistent --prerelease |
| 25 | +``` |
| 26 | + |
| 27 | +### Prerequisites |
| 28 | + |
| 29 | +Include a section after the install command that details any requirements that must be satisfied before a developer can [authenticate](#authenticate-the-client) and test all of the snippets in the [Examples](#examples) section. For example, for Cosmos DB: |
| 30 | + |
| 31 | +> You must have an [Azure subscription](https://azure.microsoft.com/free/dotnet/) and [Cosmos DB account](https://docs.microsoft.com/azure/cosmos-db/account-overview) (SQL API). In order to take advantage of the C# 8.0 syntax, it is recommended that you compile using the [.NET Core SDK](https://dotnet.microsoft.com/download) 3.0 or higher with a [language version](https://docs.microsoft.com/dotnet/csharp/language-reference/configure-language-version#override-a-default) of `latest`. It is also possible to compile with the .NET Core SDK 2.1.x using a language version of `preview`. |
| 32 | +
|
| 33 | +### Authenticate the client |
| 34 | + |
| 35 | +If your library requires authentication for use, such as for Azure services, include instructions and example code needed for initializing and authenticating. |
| 36 | + |
| 37 | +For example, include details on obtaining an account key and endpoint URI, setting environment variables for each, and initializing the client object. |
| 38 | + |
| 39 | +### Service API versions |
| 40 | + |
| 41 | +The client library targets the latest service API version by default. A client instance accepts an optional service API version parameter from its options to specify which API version service to communicate. |
| 42 | + |
| 43 | +#### Select a service API version |
| 44 | + |
| 45 | +You have the flexibility to explicitly select a supported service API version when instantiating a client by configuring its associated options. This ensures that the client can communicate with services using the specified API version. |
| 46 | + |
| 47 | +For example, |
| 48 | + |
| 49 | +```C# Snippet:Create<YourService>ClientForSpecificApiVersion |
| 50 | +Uri endpoint = new Uri("<your endpoint>"); |
| 51 | +DefaultAzureCredential credential = new DefaultAzureCredential(); |
| 52 | +<YourService>ClientOptions options = new <YourService>ClientOptions(<YourService>ClientOptions.ServiceVersion.<API Version>) |
| 53 | +var client = new <YourService>Client(endpoint, credential, options); |
| 54 | +``` |
| 55 | + |
| 56 | +When selecting an API version, it's 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. |
| 57 | + |
| 58 | +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. |
| 59 | + |
| 60 | +## Key concepts |
| 61 | + |
| 62 | +The *Key concepts* section should describe the functionality of the main classes. Point out the most important and useful classes in the package (with links to their reference pages) and explain how those classes work together. Feel free to use bulleted lists, tables, code blocks, or even diagrams for clarity. |
| 63 | + |
| 64 | +Include the *Thread safety* and *Additional concepts* sections below at the end of your *Key concepts* section. You may remove or add links depending on what your library makes use of: |
| 65 | + |
| 66 | +### Thread safety |
| 67 | + |
| 68 | +We guarantee that all client instance methods are thread-safe and independent of each other ([guideline](https://azure.github.io/azure-sdk/dotnet_introduction.html#dotnet-service-methods-thread-safety)). This ensures that the recommendation of reusing client instances is always safe, even across threads. |
| 69 | + |
| 70 | +### Additional concepts |
| 71 | +<!-- CLIENT COMMON BAR --> |
| 72 | +[Client options](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#configuring-service-clients-using-clientoptions) | |
| 73 | +[Accessing the response](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#accessing-http-response-details-using-responset) | |
| 74 | +[Long-running operations](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#consuming-long-running-operations-using-operationt) | |
| 75 | +[Handling failures](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#reporting-errors-requestfailedexception) | |
| 76 | +[Diagnostics](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/samples/Diagnostics.md) | |
| 77 | +[Mocking](https://github.com/Azure/azure-sdk-for-net/blob/main/sdk/core/Azure.Core/README.md#mocking) | |
| 78 | +[Client lifetime](https://devblogs.microsoft.com/azure-sdk/lifetime-management-and-thread-safety-guarantees-of-azure-sdk-net-clients/) |
| 79 | +<!-- CLIENT COMMON BAR --> |
| 80 | + |
| 81 | +## Examples |
| 82 | + |
| 83 | +You can familiarize yourself with different APIs using [Samples](https://github.com/Azure/azure-sdk-for-net/tree/main/sdk/ai/Azure.AI.Agents.Persistent/samples). |
| 84 | + |
| 85 | +## Troubleshooting |
| 86 | + |
| 87 | +Describe common errors and exceptions, how to "unpack" them if necessary, and include guidance for graceful handling and recovery. |
| 88 | + |
| 89 | +Provide information to help developers avoid throttling or other service-enforced errors they might encounter. For example, provide guidance and examples for using retry or connection policies in the API. |
| 90 | + |
| 91 | +If the package or a related package supports it, include tips for logging or enabling instrumentation to help them debug their code. |
| 92 | + |
| 93 | +## Next steps |
| 94 | + |
| 95 | +* Provide a link to additional code examples, ideally to those sitting alongside the README in the package's `/samples` directory. |
| 96 | +* If appropriate, point users to other packages that might be useful. |
| 97 | +* If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for. |
| 98 | + |
| 99 | +## Contributing |
| 100 | + |
| 101 | +This is a template, but your SDK readme should include details on how to contribute code to the repo/package. |
| 102 | + |
| 103 | +<!-- LINKS --> |
| 104 | +[style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization |
| 105 | +[style-guide-cloud]: https://aka.ms/azsdk/cloud-style-guide |
| 106 | + |
| 107 | + |
0 commit comments