GenerateTypedContentRequest
class GenerateTypedContentRequest<T : Any>
A request to generate typed content.
This is an experimental feature.
Summary
Nested types |
|---|
class GenerateTypedContentRequest.Builder<T : Any>Builder for |
Public companion functions |
|
|---|---|
GenerateTypedContentRequest.Builder<T> |
<T : Any> builder( |
Public properties |
|
|---|---|
GenerateContentRequest |
the underlying |
Boolean |
Whether to include input schema in prompt. |
KClass<T> |
the target class type to which the model will generate. |
Public companion functions
builder
fun <T : Any> builder(
generateContentRequest: GenerateContentRequest,
outputClass: KClass<T>
): GenerateTypedContentRequest.Builder<T>
Public properties
generateContentRequest
val generateContentRequest: GenerateContentRequest
the underlying GenerateContentRequest that contains the input and configuration for generation.
includeSchemaInPrompt
val includeSchemaInPrompt: Boolean
Whether to include input schema in prompt. Default to true.
outputClass
val outputClass: KClass<T>
the target class type to which the model will generate. This class must be annotated with @Generable, otherwise a GenAiException with GenAiException.ErrorCode.STRUCTURED_OUTPUT_REQUEST_ERROR will be thrown during inference. Refer to Generable for more details on requirements for the annotated class.