autogen_ext.tools.semantic_kernel#

pydantic model KernelFunctionFromTool[source]#

Bases: KernelFunctionFromMethod

Show JSON schema

{
   "title": "KernelFunctionFromTool",
   "type": "object",
   "properties": {
      "metadata": {
         "$ref": "#/$defs/KernelFunctionMetadata"
      },
      "invocation_duration_histogram": {
         "default": null,
         "title": "Invocation Duration Histogram"
      },
      "streaming_duration_histogram": {
         "default": null,
         "title": "Streaming Duration Histogram"
      },
      "method": {
         "default": null,
         "title": "Method"
      },
      "stream_method": {
         "default": null,
         "title": "Stream Method"
      }
   },
   "$defs": {
      "KernelFunctionMetadata": {
         "description": "The kernel function metadata.",
         "properties": {
            "name": {
               "pattern": "^[0-9A-Za-z_]+$",
               "title": "Name",
               "type": "string"
            },
            "plugin_name": {
               "anyOf": [
                  {
                     "pattern": "^[0-9A-Za-z_]+$",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Plugin Name"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "parameters": {
               "items": {
                  "$ref": "#/$defs/KernelParameterMetadata"
               },
               "title": "Parameters",
               "type": "array"
            },
            "is_prompt": {
               "title": "Is Prompt",
               "type": "boolean"
            },
            "is_asynchronous": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": true,
               "title": "Is Asynchronous"
            },
            "return_parameter": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/KernelParameterMetadata"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            },
            "additional_properties": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Additional Properties"
            }
         },
         "required": [
            "name",
            "is_prompt"
         ],
         "title": "KernelFunctionMetadata",
         "type": "object"
      },
      "KernelParameterMetadata": {
         "description": "The kernel parameter metadata.",
         "properties": {
            "name": {
               "anyOf": [
                  {
                     "pattern": "^[0-9A-Za-z_]+$",
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "title": "Name"
            },
            "description": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Description"
            },
            "default_value": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Default Value"
            },
            "type": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": "str",
               "title": "Type"
            },
            "is_required": {
               "anyOf": [
                  {
                     "type": "boolean"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": false,
               "title": "Is Required"
            },
            "type_object": {
               "anyOf": [
                  {},
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Type Object"
            },
            "schema_data": {
               "anyOf": [
                  {
                     "type": "object"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Schema Data"
            },
            "include_in_function_choices": {
               "default": true,
               "title": "Include In Function Choices",
               "type": "boolean"
            }
         },
         "required": [
            "name"
         ],
         "title": "KernelParameterMetadata",
         "type": "object"
      }
   },
   "required": [
      "metadata"
   ]
}

Fields:

• method (collections.abc.Callable[[...], Any])

• stream_method (collections.abc.Callable[[...], Any] | None)

field method: Callable[[...], Any] [Required]#

field stream_method: Callable[[...], Any] | None = None#