google-genai-kotlin/com.google.genai.kotlin.types/FunctionResponse

FunctionResponse

@Serializable

data class FunctionResponse(val willContinue: Boolean? = null, val scheduling: FunctionResponseScheduling? = null, val parts: List<FunctionResponsePart>? = null, val id: String? = null, val name: String? = null, val response: Map<String, JsonElement>? = null)

The result output from a FunctionCall that contains a string representing the FunctionDeclaration.name and a structured JSON object containing any output from the function is used as context to the model. This should contain the result of a FunctionCall made based on model prediction.

Constructors

FunctionResponse

constructor(willContinue: Boolean? = null, scheduling: FunctionResponseScheduling? = null, parts: List<FunctionResponsePart>? = null, id: String? = null, name: String? = null, response: Map<String, JsonElement>? = null)

Properties

val id: String? = null

Optional. The id of the function call this response is for. Populated by the client to match the corresponding function call id.

name

val name: String? = null

Required. The name of the function to call. Matches FunctionDeclaration.name and FunctionCall.name.

parts

val parts: List<FunctionResponsePart>? = null

Optional. Ordered Parts that constitute a function response. Parts may have different IANA MIME types.

response

val response: Map<String, JsonElement>? = null

Required. The function response in JSON object format. Use "output" key to specify function output and "error" key to specify error details (if any). If "output" and "error" keys are not specified, then whole "response" is treated as function output.

scheduling

val scheduling: FunctionResponseScheduling? = null

Optional. Specifies how the response should be scheduled in the conversation. Only applicable to NON_BLOCKING function calls, is ignored otherwise. Defaults to WHEN_IDLE.

willContinue

val willContinue: Boolean? = null

Optional. Signals that function call continues, and more responses will be returned, turning the function call into a generator. Is only applicable to NON_BLOCKING function calls, is ignored otherwise. If set to false, future responses will not be considered. It is allowed to return empty response with will_continue=False to signal that the function call is finished. This may still trigger the model generation. To avoid triggering the generation and finish the function call, additionally set scheduling to SILENT. This field is not supported in Vertex AI.