FunctionInvokingChatClient.DetailedErrors Property
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
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, setPublic Property DetailedErrors As BooleanProperty Value
true if the full exception message is added to the chat history
when calling the underlying IChatClient.
false if a generic error message is included in the chat history.
The default value is false.
Remarks
Setting the value to false prevents the underlying language model from disclosing raw exception details to the end user, since it doesn't receive that information. Even in this case, the raw Exception object is available to application code by inspecting the Exception property.
Setting the value to true can help the underlying IChatClient bypass problems on its own, for example by retrying the function call with different arguments. However it might result in disclosing the raw exception information to external users, which can be a security concern depending on the application scenario.
Changing the value of this property while the client is in use might result in inconsistencies as to whether detailed errors are provided during an in-flight request.
