Share via


ProjectsOpenAIModelFactory.StructuredInputDefinition Method

Definition

An structured input that can participate in prompt template substitutions and tool argument binding.

public static Azure.AI.Projects.OpenAI.StructuredInputDefinition StructuredInputDefinition(string description = default, BinaryData defaultValue = default, BinaryData schema = default, bool? isRequired = default);
static member StructuredInputDefinition : string * BinaryData * BinaryData * Nullable<bool> -> Azure.AI.Projects.OpenAI.StructuredInputDefinition
Public Shared Function StructuredInputDefinition (Optional description As String = Nothing, Optional defaultValue As BinaryData = Nothing, Optional schema As BinaryData = Nothing, Optional isRequired As Nullable(Of Boolean) = Nothing) As StructuredInputDefinition

Parameters

description
String

A human-readable description of the input.

defaultValue
BinaryData

The default value for the input if no run-time value is provided.

schema
BinaryData

The JSON schema for the structured input (optional).

isRequired
Nullable<Boolean>

Whether the input property is required when the agent is invoked.

Returns

A new StructuredInputDefinition instance for mocking.

Applies to