AIFunctionDeclaration.JsonSchema Egenskap
Definition
Viktigt
En del information gäller för förhandsversionen av en produkt och kan komma att ändras avsevärt innan produkten blir allmänt tillgänglig. Microsoft lämnar inga garantier, uttryckliga eller underförstådda, avseende informationen som visas här.
Hämtar ett JSON-schema som beskriver funktionen och dess indataparametrar.
public:
virtual property System::Text::Json::JsonElement JsonSchema { System::Text::Json::JsonElement get(); };public virtual System.Text.Json.JsonElement JsonSchema { get; }member this.JsonSchema : System.Text.Json.JsonElementPublic Overridable ReadOnly Property JsonSchema As JsonElementEgenskapsvärde
Kommentarer
När det anges deklareras ett fristående JSON-schemadokument som beskriver funktionen och dess indataparametrar. Ett enkelt exempel på ett JSON-schema för en funktion som lägger till två tal tillsammans visas nedan:
{
"type": "object",
"properties": {
"a" : { "type": "number" },
"b" : { "type": ["number","null"], "default": 1 }
},
"required" : ["a"]
}
Metadata som finns i schemadokumentet spelar en viktig roll när det gäller att vägleda anrop av AI-funktioner.
När en AIFunction skapas via AIFunctionFactoryhärleds det här schemat automatiskt från metodens parametrar med hjälp av den konfigurerade JsonSerializerOptions och AIJsonSchemaCreateOptions.
När inget schema har angetts bör användning av chattklienter förutsätta schemat "{}" eller "true", vilket indikerar att eventuella JSON-indata är tillåtna.
