Function

class oci.generative_ai_agent.models.Function(**kwargs)

Bases: object

Details of Function for Function calling tool.

Methods:

__init__(**kwargs)

Initializes a new Function object with values from keyword arguments.

Attributes:

description

Gets the description of this Function.

name

[Required] Gets the name of this Function.

parameters

Gets the parameters of this Function.

__init__(**kwargs)

Initializes a new Function object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • name (str) – The value to assign to the name property of this Function.

  • description (str) – The value to assign to the description property of this Function.

  • parameters (dict(str, str)) – The value to assign to the parameters property of this Function.

property description

Gets the description of this Function. A description of the function.

Returns

The description of this Function.

Return type

str

property name

[Required] Gets the name of this Function. The name of the function to invoke.

Returns

The name of this Function.

Return type

str

property parameters

Gets the parameters of this Function. The parameters the function accepts, defined using a JSON Schema object. Refer to the guide for examples and the JSON Schema documentation for details on the format.

Returns

The parameters of this Function.

Return type

dict(str, str)