AIFunctionDeclaration.JsonSchema Eigenschaft
Definition
Wichtig
Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.
Ruft ein JSON-Schema ab, das die Funktion und die zugehörigen Eingabeparameter beschreibt.
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 JsonElementEigenschaftswert
Hinweise
Wenn angegeben, deklariert ein eigenständiges JSON-Schemadokument, das die Funktion und die Eingabeparameter beschreibt. Ein einfaches Beispiel für ein JSON-Schema für eine Funktion, die zwei Zahlen zusammen addiert, wird unten gezeigt:
{
"type": "object",
"properties": {
"a" : { "type": "number" },
"b" : { "type": ["number","null"], "default": 1 }
},
"required" : ["a"]
}
Die im Schemadokument vorhandenen Metadaten spielen eine wichtige Rolle bei der Steuerung von KI-Funktionsaufrufen.
Wenn ein Schema AIFunction über AIFunctionFactoryerstellt wird, wird dieses Schema anhand der konfigurierten und AIJsonSchemaCreateOptionskonfigurierten JsonSerializerOptions Parameter automatisch von den Parametern der Methode abgeleitet.
Wenn kein Schema angegeben wird, sollte die Verwendung von Chatclients das Schema "{}" oder "true" annehmen, das angibt, dass eine JSON-Eingabe zulässig ist.
