OpenApiFunctionExecutionParameters Constructor

Definition

Namespace:

Microsoft.SemanticKernel.Plugins.OpenApi

Assembly:

Microsoft.SemanticKernel.Plugins.OpenApi.dll

Package:

Microsoft.SemanticKernel.Plugins.OpenApi v1.20.0-alpha

Initializes a new instance of the OpenApiFunctionExecutionParameters class.

public OpenApiFunctionExecutionParameters (System.Net.Http.HttpClient? httpClient = default, Microsoft.SemanticKernel.Plugins.OpenApi.AuthenticateRequestAsyncCallback? authCallback = default, Uri? serverUrlOverride = default, string? userAgent = default, bool ignoreNonCompliantErrors = false, bool enableDynamicOperationPayload = true, bool enablePayloadNamespacing = false, System.Collections.Generic.IList<string>? operationsToExclude = default);

new Microsoft.SemanticKernel.Plugins.OpenApi.OpenApiFunctionExecutionParameters : System.Net.Http.HttpClient * Microsoft.SemanticKernel.Plugins.OpenApi.AuthenticateRequestAsyncCallback * Uri * string * bool * bool * bool * System.Collections.Generic.IList<string> -> Microsoft.SemanticKernel.Plugins.OpenApi.OpenApiFunctionExecutionParameters

Public Sub New (Optional httpClient As HttpClient = Nothing, Optional authCallback As AuthenticateRequestAsyncCallback = Nothing, Optional serverUrlOverride As Uri = Nothing, Optional userAgent As String = Nothing, Optional ignoreNonCompliantErrors As Boolean = false, Optional enableDynamicOperationPayload As Boolean = true, Optional enablePayloadNamespacing As Boolean = false, Optional operationsToExclude As IList(Of String) = Nothing)

Parameters

httpClient

HttpClient

The HttpClient to use for sending HTTP requests.

authCallback

AuthenticateRequestAsyncCallback

The callback for adding authentication data to HTTP requests.

serverUrlOverride

Uri

The override for the REST API operation server URL.

userAgent

String

Optional user agent header value.

ignoreNonCompliantErrors

Boolean

A flag indicating whether to ignore non-compliant errors or not If set to true, the operation execution will not throw exceptions for non-compliant documents. Please note that enabling this option may result in incomplete or inaccurate execution results.

enableDynamicOperationPayload

Boolean

Determines whether the operation payload is constructed dynamically based on operation payload metadata. If false, the operation payload must be provided via the 'payload' context variable.

enablePayloadNamespacing

Boolean

Determines whether payload parameter names are augmented with namespaces. Namespaces prevent naming conflicts by adding the parent parameter name as a prefix, separated by dots.

operationsToExclude

IList<String>

Optional list of operations not to import, e.g. in case they are not supported