Table of Contents

Class APIEndpointConfiguration

Namespace
FoundationaLLM.Common.Models.ResourceProviders.Configuration
Assembly
FoundationaLLM.Common.dll

Provides the configuration for an API endpoint resource.

public class APIEndpointConfiguration : ResourceBase
Inheritance
APIEndpointConfiguration
Inherited Members
Extension Methods

Constructors

APIEndpointConfiguration()

Creates a new instance of APIEndpointConfiguration.

public APIEndpointConfiguration()

Properties

APIVersion

The version to use when calling the API represented by the endpoint.

[JsonPropertyName("api_version")]
public string? APIVersion { get; set; }

Property Value

string

AuthenticationParameters

Dictionary with values used for authentication.

For the list of supported keys, see AuthenticationParametersKeys. 

[JsonPropertyName("authentication_parameters")]
public Dictionary<string, object> AuthenticationParameters { get; set; }

Property Value

Dictionary<string, object>

AuthenticationType

The type of authentication required for accessing the API.

[JsonPropertyName("authentication_type")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public required AuthenticationTypes AuthenticationType { get; set; }

Property Value

AuthenticationTypes

Category

The api endpoint category.

[JsonPropertyName("category")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public required APIEndpointCategory Category { get; set; }

Property Value

APIEndpointCategory

OperationType

Type of operation the endpoint is performing. This value should be completions or chat. Default value is chat.

[JsonPropertyName("operation_type")]
public string? OperationType { get; set; }

Property Value

string

Provider

The API endpoint provider.

For a list of available API endpoint providers, see APIEndpointProviders. 

[JsonPropertyName("provider")]
public string? Provider { get; set; }

Property Value

string

RetryStrategyName

The name of the retry strategy.

[JsonPropertyName("retry_strategy_name")]
public required string RetryStrategyName { get; set; }

Property Value

string

StatusEndpoint

The relative path for the status endpoint of the API endpoint, if available.

[JsonPropertyName("status_endpoint")]
public string? StatusEndpoint { get; set; }

Property Value

string

Subcategory

The api endpoint subcategory.

[JsonPropertyName("subcategory")]
[JsonConverter(typeof(JsonStringEnumConverter))]
public APIEndpointSubcategory? Subcategory { get; set; }

Property Value

APIEndpointSubcategory?

TimeoutSeconds

The timeout duration in seconds for API calls.

[JsonPropertyName("timeout_seconds")]
public required int TimeoutSeconds { get; set; }

Property Value

int

Url

The base URL of the API endpoint.

[JsonPropertyName("url")]
public required string Url { get; set; }

Property Value

string

UrlExceptions

A list of URL exceptions.

[JsonPropertyName("url_exceptions")]
public List<UrlException> UrlExceptions { get; set; }

Property Value

List<UrlException>
Edit this page