Skip to content

Commit

Permalink
Merge pull request #1221 from solliancenet/jdh-update-management-clie…
Browse files Browse the repository at this point in the history
…nt-readme

Update `ManagementClient` main readme
  • Loading branch information
ciprianjichici authored Jul 11, 2024
2 parents 47f8bc9 + 59d12a0 commit 2f40ec3
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions src/dotnet/ManagementClient/readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This library contains two primary classes:
- `ManagementClient`: A class that provides a set of methods for interacting with the Foundationa**LLM** Management API using a higher-level abstraction. This class is designed to simplify the process of interacting with the Management API by providing a more intuitive interface. It does not contain all the methods available in the `ManagementRESTClient` class, but it provides a more user-friendly way to interact with the Management API.

> [!NOTE]
> These two classes are mutually exclusive, and you should choose one based on your requirements. If you need direct access to all Core API endpoints, use the `ManagementRESTClient` class. If you need a more user-friendly interface, use the `ManagementClient` class.
> These two classes are mutually exclusive, and you should choose one based on your requirements. If you need direct access to all Management API endpoints, use the `ManagementRESTClient` class. If you need a more user-friendly interface, use the `ManagementClient` class.
## Getting started

Expand All @@ -18,7 +18,7 @@ This library contains two primary classes:
Install the NuGet package:

```bash
dotnet add package FoundationaLLM.Client.Core
dotnet add package FoundationaLLM.Client.Management
```

### Manual service instantiation
Expand Down Expand Up @@ -173,7 +173,7 @@ If you prefer to retrieve the configuration settings from Azure App Configuratio
configuration[AppConfigurationKeys.FoundationaLLM_Instance_Id]!);
```

3. Retrieve the `CoreClient` and `CoreRESTClient` instances from the service provider:
3. Retrieve the `ManagementClient` and `ManagementRESTClient` instances from the service provider:

```csharp
var managementClient = serviceProvider.GetRequiredService<IManagementClient>();
Expand All @@ -182,7 +182,7 @@ If you prefer to retrieve the configuration settings from Azure App Configuratio

### Example projects

The `Core.Examples` test project contains several examples that demonstrate how to use the `ManagementClient` and `ManagementRESTClient` classes to interact with the Core API through a series of end-to-end tests.
The `Core.Examples` test project contains several examples that demonstrate how to use the `ManagementClient` and `ManagementRESTClient` classes to interact with the Management API through a series of end-to-end tests.

## Foundationa**LLM**: The platform for deploying, scaling, securing and governing generative AI in the enterprises 🚀

Expand Down

0 comments on commit 2f40ec3

Please sign in to comment.