Share via


FunctionInvokingChatClient.DetailedErrors Property

Definition

Gets or sets a value indicating whether detailed exception information should be included in the chat history when calling the underlying IChatClient.

public:
 property bool DetailedErrors { bool get(); void set(bool value); };
public bool DetailedErrors { get; set; }
member this.DetailedErrors : bool with get, set
Public Property DetailedErrors As Boolean

Property Value

Remarks

The default value is false, meaning that only a generic error message will be included in the chat history. This prevents the underlying language model from disclosing raw exception details to the end user, since it does not receive that information. Even in this case, the raw Exception object is available to application code by inspecting the Exception property.

If set to true, the full exception message will be added to the chat history when calling the underlying IChatClient. This can help it to bypass problems on its own, for example by retrying the function call with different arguments. However it may result in disclosing the raw exception information to external users, which may be a security concern depending on the application scenario.

Changing the value of this property while the client is in use may result in inconsistencies as to whether detailed errors are provided during an in-flight request.

Applies to