OpenApiFunctionExecutionParameters Class

Definition

Namespace:

Microsoft.SemanticKernel.Plugins.OpenApi

Assembly:

Microsoft.SemanticKernel.Plugins.OpenApi.dll

Package:

Microsoft.SemanticKernel.Plugins.OpenApi v1.45.0

OpenAPI function execution parameters.

public class OpenApiFunctionExecutionParameters

type OpenApiFunctionExecutionParameters = class

Public Class OpenApiFunctionExecutionParameters

Inheritance

Object

OpenApiFunctionExecutionParameters

Constructors

OpenApiFunctionExecutionParameters(HttpClient, AuthenticateRequestAsyncCallback, Uri, String, Boolean, Boolean, Boolean, IList<String>)

Initializes a new instance of the OpenApiFunctionExecutionParameters class.

Properties

AuthCallback	Callback for adding authentication data to HTTP requests.
EnableDynamicPayload	Determines whether the REST API operation payload is constructed dynamically based on payload metadata. It's enabled by default and allows to support operations with simple payload structure - no properties with the same name at different levels. To support more complex payloads, it should be disabled and the payload should be provided via the 'payload' argument. See the 'Providing Payload for OpenAPI Functions' ADR for more details: https://github.com/microsoft/semantic-kernel/blob/main/docs/decisions/0062-open-api-payload.md
EnablePayloadNamespacing	Determines whether payload parameter names are augmented with namespaces. It's only applicable when EnableDynamicPayload property is set to true. Namespaces prevent naming conflicts by adding the parent parameter name as a prefix, separated by dots. For instance, without namespaces, the 'email' parameter for both the 'sender' and 'receiver' parent parameters would be resolved from the same 'email' argument, which is incorrect. However, by employing namespaces, the parameters 'sender.email' and 'sender.receiver' will be correctly resolved from arguments with the same names. See the 'Providing Payload for OpenAPI Functions' ADR for more details: https://github.com/microsoft/semantic-kernel/blob/main/docs/decisions/0062-open-api-payload.md
HttpClient	HttpClient to use for sending HTTP requests.
HttpResponseContentReader	A custom HTTP response content reader. It can be useful when the internal reader for a specific content type is either missing, insufficient, or when custom behavior is desired. For instance, the internal reader for "application/json" HTTP content reads the content as a string. This may not be sufficient in cases where the JSON content is large, streamed chunk by chunk, and needs to be accessed as soon as the first chunk is available. To handle such cases, a custom reader can be provided to read the content as a stream rather than as a string. If the custom reader is not provided, or the reader returns null, the internal reader is used.
IgnoreNonCompliantErrors	Flag indicating whether to ignore non-compliant errors of the OpenAPI document or not. If set to true, the execution will not throw exceptions for non-compliant documents. Please note that enabling this option may result in incomplete or inaccurate execution results.
LoggerFactory	The ILoggerFactory to use for logging. If null, no logging will be performed.
OperationsToExclude	Optional list of HTTP operations to skip when importing the OpenAPI document.
ParameterFilter	A custom REST API parameter filter.
RestApiOperationResponseFactory	A custom factory for the RestApiOperationResponse. It allows modifications of various aspects of the original response, such as adding response headers, changing response content, adjusting the schema, or providing a completely new response. If a custom factory is not supplied, the internal factory will be used by default.
ServerUrlOverride	Override for REST API server url.
UserAgent	Optional user agent header value.