Class CoreRESTClient

Namespace

FoundationaLLM.Client.Core

Assembly

FoundationaLLM.Client.Core.dll

Supports all classes in the .NET class hierarchy and provides low-level services to derived classes. This is the ultimate base class of all .NET classes; it is the root of the type hierarchy.

public class CoreRESTClient : ICoreRESTClient

Inheritance

object

CoreRESTClient

Implements

ICoreRESTClient

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

ObjectExtensions.GetPropertyValues(object, List<string>)

Constructors

CoreRESTClient()

Constructor for mocking. This does not initialize the clients.

public CoreRESTClient()

CoreRESTClient(string, TokenCredential, string)

Initializes a new instance of the CoreRESTClient class and configures IHttpClientFactory with a named instance for the CoreAPI (CoreAPI) based on the passed in URL.

public CoreRESTClient(string coreUri, TokenCredential credential, string instanceId)

Parameters

coreUri string

The base URI of the Core API.

credential TokenCredential

A TokenCredential of an authenticated user or service principle from which the client library can generate auth tokens.

instanceId string

The unique (GUID) ID for the FoundationaLLM deployment. Locate this value in the FoundationaLLM Management Portal or in Azure App Config (FoundationaLLM:Instance:Id key)

CoreRESTClient(string, TokenCredential, string, APIClientSettings)

Initializes a new instance of the CoreRESTClient class and configures IHttpClientFactory with a named instance for the CoreAPI (CoreAPI) based on the passed in URL and optional client settings.

public CoreRESTClient(string coreUri, TokenCredential credential, string instanceId, APIClientSettings options)

Parameters

coreUri string

The base URI of the Core API.

credential TokenCredential

A TokenCredential of an authenticated user or service principle from which the client library can generate auth tokens.

instanceId string

The unique (GUID) ID for the FoundationaLLM deployment. Locate this value in the FoundationaLLM Management Portal or in Azure App Config (FoundationaLLM:Instance:Id key)

options APIClientSettings

Additional options to configure the HTTP Client.

CoreRESTClient(string, ApiKeyCredential, string)

Initializes a new instance of the CoreRESTClient class and configures IHttpClientFactory with a named instance for the CoreAPI (CoreAPI) based on the passed in URL.

public CoreRESTClient(string coreUri, ApiKeyCredential credential, string instanceId)

Parameters

coreUri string

The base URI of the Core API.

credential ApiKeyCredential

An System.ClientModel.ApiKeyCredential containing a valid agent access token.

instanceId string

The unique (GUID) ID for the FoundationaLLM deployment. Locate this value in the FoundationaLLM Management Portal or in Azure App Config (FoundationaLLM:Instance:Id key)

CoreRESTClient(string, ApiKeyCredential, string, APIClientSettings)

Initializes a new instance of the CoreRESTClient class and configures IHttpClientFactory with a named instance for the CoreAPI (CoreAPI) based on the passed in URL and optional client settings.

public CoreRESTClient(string coreUri, ApiKeyCredential credential, string instanceId, APIClientSettings options)

Parameters

coreUri string

The base URI of the Core API.

credential ApiKeyCredential

An System.ClientModel.ApiKeyCredential containing a valid agent access token.

instanceId string

The unique (GUID) ID for the FoundationaLLM deployment. Locate this value in the FoundationaLLM Management Portal or in Azure App Config (FoundationaLLM:Instance:Id key)

options APIClientSettings

Additional options to configure the HTTP Client.

Properties

Attachments

Contains methods to interact with the Attachments endpoints.

public IAttachmentRESTClient Attachments { get; }

Property Value

IAttachmentRESTClient

Branding

Contains methods to interact with the Branding endpoints.

public IBrandingRESTClient Branding { get; }

Property Value

IBrandingRESTClient

Completions

Contains methods to interact with the Orchestration endpoints.

public ICompletionRESTClient Completions { get; }

Property Value

ICompletionRESTClient

Sessions

Contains methods to interact with the Sessions endpoints.

public ISessionRESTClient Sessions { get; }

Property Value

ISessionRESTClient

Status

Contains methods to interact with the Status endpoints.

public IStatusRESTClient Status { get; }

Property Value

IStatusRESTClient

UserProfiles

Contains methods to interact with the UserProfiles endpoints.

public IUserProfileRESTClient UserProfiles { get; }

Property Value

IUserProfileRESTClient