LiveClientRealtimeInput

public abstract class LiveClientRealtimeInput extends JsonSerializable

User input that is sent in real time.

This is different from `LiveClientContent` in a few ways:

- Can be sent continuously without interruption to model generation. - If there is a need to mix data interleaved across the `LiveClientContent` and the `LiveClientRealtimeInput`, server attempts to optimize for best response, but there are no guarantees. - End of turn is not explicitly specified, but is rather derived from user activity (for example, end of speech). - Even before the end of turn, the data is processed incrementally to optimize for a fast start of the response from the model. - Is always assumed to be the user's input (cannot be used to populate conversation history).

Constructors

Link copied to clipboard

Types

Link copied to clipboard
public abstract class Builder
Builder for LiveClientRealtimeInput.

Properties

Link copied to clipboard
public final static String MAX_READ_LENGTH_PROPERTY
System property to override the default max JSON string length (20MB) in read constraints.

Functions

Link copied to clipboard
public abstract Optional<ActivityEnd> activityEnd()
Marks the end of user activity.
Link copied to clipboard
Marks the start of user activity.
Link copied to clipboard
public abstract Optional<Blob> audio()
The realtime audio input stream.
Link copied to clipboard
public abstract Optional<Boolean> audioStreamEnd()
Indicates that the audio stream has ended, e.g.
Link copied to clipboard
Instantiates a builder for LiveClientRealtimeInput.
Link copied to clipboard
public static LiveClientRealtimeInput fromJson(String jsonString)
Deserializes a JSON string to a LiveClientRealtimeInput object.
Link copied to clipboard
@InternalApi()
public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)
Deserializes a JsonNode to an object of the given type.
Link copied to clipboard
@InternalApi()
public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)
Deserializes a Json string to an object of the given type.
Link copied to clipboard
public abstract Optional<List<Blob>> mediaChunks()
Inlined bytes data for media input.
Link copied to clipboard
public static ObjectMapper objectMapper()
Link copied to clipboard
public static void setMaxReadLength(int maxReadLength)
Overrides the default maximum JSON string length (20MB) for the JSON parser.
Link copied to clipboard
public static JsonNode stringToJsonNode(String string)
Converts a Json string to a JsonNode.
Link copied to clipboard
public abstract Optional<String> text()
The realtime text input stream.
Link copied to clipboard
Creates a builder with the same values as this instance.
Link copied to clipboard
public String toJson()
Serializes the instance to a Json string.
Link copied to clipboard
public static JsonNode toJsonNode(Object object)
Serializes an object to a JsonNode.
Link copied to clipboard
public static String toJsonString(Object object)
Serializes an object to a Json string.
Link copied to clipboard
public abstract Optional<Blob> video()
The realtime video input stream.