AIFunctionDeclaration.JsonSchema Propriété

Définition

Obtient un schéma JSON décrivant la fonction et ses paramètres d’entrée.

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.JsonElement
Public Overridable ReadOnly Property JsonSchema As JsonElement

Valeur de propriété

Remarques

Quand elle est spécifiée, déclare un document de schéma JSON autonome qui décrit la fonction et ses paramètres d’entrée. Un exemple simple de schéma JSON pour une fonction qui ajoute deux nombres ensemble est illustré ci-dessous :

{
  "type": "object",
  "properties": {
    "a" : { "type": "number" },
    "b" : { "type": ["number","null"], "default": 1 }
  },
  "required" : ["a"]
}

Les métadonnées présentes dans le document de schéma jouent un rôle important dans l’appel de fonction IA.

Lorsqu’un AIFunction est créé via AIFunctionFactory, ce schéma est automatiquement dérivé des paramètres de la méthode à l’aide de la configuration JsonSerializerOptions et AIJsonSchemaCreateOptions.

Lorsqu’aucun schéma n’est spécifié, l’utilisation de clients de conversation doit supposer le schéma « » ou «{} true », indiquant qu’une entrée JSON est admissible.

S’applique à