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

GenerateContentResponse

@Serializable

data class GenerateContentResponse(val sdkHttpResponse: HttpResponse? = null, val candidates: List<Candidate>? = null, val createTime: Instant? = null, val modelVersion: String? = null, val promptFeedback: GenerateContentResponsePromptFeedback? = null, val responseId: String? = null, val usageMetadata: GenerateContentResponseUsageMetadata? = null, val modelStatus: ModelStatus? = null)

Response message for PredictionService.GenerateContent.

Constructors

constructor(sdkHttpResponse: HttpResponse? = null, candidates: List<Candidate>? = null, createTime: Instant? = null, modelVersion: String? = null, promptFeedback: GenerateContentResponsePromptFeedback? = null, responseId: String? = null, usageMetadata: GenerateContentResponseUsageMetadata? = null, modelStatus: ModelStatus? = null)

Properties

candidates

val candidates: List<Candidate>? = null

Response variations returned by the model.

codeExecutionResult

val codeExecutionResult: String?

Returns the output of running the code the model asked to have run.

createTime

@Serializable(with = InstantSerializer::class)

val createTime: Instant? = null

Timestamp when the request is made to the server.

executableCode

val executableCode: String?

Returns the code the model asked to have run, when the code execution tool is enabled.

finishReason

val finishReason: FinishReason?

Returns why the model stopped generating.

functionCalls

val functionCalls: List<FunctionCall>?

Returns the list of function calls in the response.

modelStatus

val modelStatus: ModelStatus? = null

Output only. The current model status of this model. This field is not supported in Vertex AI.

modelVersion

val modelVersion: String? = null

Output only. The model version used to generate the response.

promptFeedback

val promptFeedback: GenerateContentResponsePromptFeedback? = null

Output only. Content filter results for a prompt sent in the request. Note: Sent only in the first stream chunk. Only happens when no candidates were generated due to content violations.

responseId

val responseId: String? = null

Output only. response_id is used to identify each response. It is the encoding of the event_id.

sdkHttpResponse

val sdkHttpResponse: HttpResponse? = null

Used to retain the full HTTP response.

text

val text: String?

Returns the concatenation of all text parts in the response.

usageMetadata

val usageMetadata: GenerateContentResponseUsageMetadata? = null

Usage metadata about the response(s).