StructuredInputDefinition Class
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.
An structured input that can participate in prompt template substitutions and tool argument binding.
public class StructuredInputDefinition : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.StructuredInputDefinition>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.StructuredInputDefinition>type StructuredInputDefinition = class
interface IJsonModel<StructuredInputDefinition>
interface IPersistableModel<StructuredInputDefinition>Public Class StructuredInputDefinition
Implements IJsonModel(Of StructuredInputDefinition), IPersistableModel(Of StructuredInputDefinition)- Inheritance
-
StructuredInputDefinition
- Implements
Constructors
| Name | Description |
|---|---|
| StructuredInputDefinition() |
Initializes a new instance of StructuredInputDefinition. |
Properties
| Name | Description |
|---|---|
| DefaultValue |
The default value for the input if no run-time value is provided. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples:
|
| Description |
A human-readable description of the input. |
| IsRequired |
Whether this input is required when invoking the agent. |
| Schema |
The JSON schema for the structured input (optional). To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples:
|
