FunctionCall¶
-
class
oci.generative_ai_inference.models.
FunctionCall
(**kwargs)¶ Bases:
oci.generative_ai_inference.models.tool_call.ToolCall
The function call generated by the model.
Attributes
TYPE_FUNCTION
str(object=’’) -> str arguments
Gets the arguments of this FunctionCall. id
[Required] Gets the id of this ToolCall. name
Gets the name of this FunctionCall. type
[Required] Gets the type of this ToolCall. Methods
__init__
(**kwargs)Initializes a new FunctionCall object with values from keyword arguments. get_subtype
(object_dictionary)Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype. -
TYPE_FUNCTION
= 'FUNCTION'¶
-
__init__
(**kwargs)¶ Initializes a new FunctionCall object with values from keyword arguments. The default value of the
type
attribute of this class isFUNCTION
and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):Parameters: - id (str) – The value to assign to the id property of this FunctionCall.
- type (str) – The value to assign to the type property of this FunctionCall. Allowed values for this property are: “FUNCTION”
- name (str) – The value to assign to the name property of this FunctionCall.
- arguments (str) – The value to assign to the arguments property of this FunctionCall.
-
arguments
¶ Gets the arguments of this FunctionCall. The arguments to call the function with, as generated by the model in JSON format. Note that the model does not always generate valid JSON, and may hallucinate parameters not defined by your function schema. Validate the arguments in your code before calling your function.
Returns: The arguments of this FunctionCall. Return type: str
-
static
get_subtype
(object_dictionary)¶ Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
-
id
¶ [Required] Gets the id of this ToolCall. The ID of the tool call.
Returns: The id of this ToolCall. Return type: str
-
name
¶ Gets the name of this FunctionCall. The name of the function to call.
Returns: The name of this FunctionCall. Return type: str
-
type
¶ [Required] Gets the type of this ToolCall. The type of the tool.
Allowed values for this property are: “FUNCTION”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
Returns: The type of this ToolCall. Return type: str
-