AIFunctionFactoryOptions.ParameterBindingOptions.ExcludeFromSchema 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 a value indicating whether the parameter should be excluded from the generated schema.
public:
property bool ExcludeFromSchema { bool get(); void set(bool value); };public bool ExcludeFromSchema { get; init; }member this.ExcludeFromSchema : bool with get, setPublic Property ExcludeFromSchema As BooleanProperty Value
Remarks
The default value is false.
Typically, this property is set to true if and only if BindParameter is also set to non-null. While it's possible to exclude the schema when BindParameter is null, doing so means that default marshaling will be used but the AI service won't be aware of the parameter or able to generate an argument for it. This is likely to result in invocation errors, as the parameter information is unlikely to be available. It, however, is permissible for cases where invocation of the AIFunction is tightly controlled, and the caller is expected to augment the argument dictionary with the parameter value.
