google-genai/com.google.genai.types/Part

Part

public abstract class Part extends JsonSerializable

A datatype containing media content.

Exactly one field within a Part should be set, representing the specific type of content being conveyed. Using multiple fields within the same `Part` instance is considered invalid.

Constructors

Part

public void Part()

Types

Builder

public abstract class Builder

Builder for Part.

Properties

MAX_READ_LENGTH_PROPERTY

public final static String MAX_READ_LENGTH_PROPERTY

System property to override the default max JSON string length (20MB) in read constraints.

Functions

builder

public static Part.Builder builder()

Instantiates a builder for Part.

codeExecutionResult

public abstract Optional<CodeExecutionResult> codeExecutionResult()

Optional.

executableCode

public abstract Optional<ExecutableCode> executableCode()

Optional.

fileData

public abstract Optional<FileData> fileData()

Optional.

fromBytes

public static Part fromBytes(Array<byte> bytes, String mimeType)

Constructs a InlineData Part from a byte array and MIME type.

fromFunctionCall

public static Part fromFunctionCall(String name, Map<String, Object> args)

Constructs a FunctionCall Part from a function name and args.

fromFunctionResponse

public static Part fromFunctionResponse(String name, Map<String, Object> response, Array<FunctionResponsePart> functionResponseParts)

Constructs a FunctionResponse Part from a function name, response and function response parts.

fromJson

public static Part fromJson(String jsonString)

Deserializes a JSON string to a Part object.

fromJsonNode

@InternalApi()

public static T fromJsonNode<T extends JsonSerializable>(JsonNode jsonNode, Class<T> clazz)

Deserializes a JsonNode to an object of the given type.

fromJsonString

@InternalApi()

public static T fromJsonString<T extends JsonSerializable>(String jsonString, Class<T> clazz)

Deserializes a Json string to an object of the given type.

fromText

public static Part fromText(String text)

Constructs a Text Part from a text string.

fromUri

public static Part fromUri(String fileUri, String mimeType)

Constructs a FileData Part from a file URI and MIME type.

functionCall

public abstract Optional<FunctionCall> functionCall()

Optional.

functionResponse

public abstract Optional<FunctionResponse> functionResponse()

Optional.

inlineData

public abstract Optional<Blob> inlineData()

Optional.

mediaResolution

public abstract Optional<PartMediaResolution> mediaResolution()

Media resolution for the input media.

objectMapper

public static ObjectMapper objectMapper()

partMetadata

public abstract Optional<Map<String, Object>> partMetadata()

Custom metadata associated with the Part.

setMaxReadLength

public static void setMaxReadLength(int maxReadLength)

Overrides the default maximum JSON string length (20MB) for the JSON parser.

stringToJsonNode

public static JsonNode stringToJsonNode(String string)

Converts a Json string to a JsonNode.

text

public abstract Optional<String> text()

Optional.

thought

public abstract Optional<Boolean> thought()

Optional.

thoughtSignature

public abstract Optional<Array<byte>> thoughtSignature()

Optional.

toBuilder

public abstract Part.Builder toBuilder()

Creates a builder with the same values as this instance.

toJson

public String toJson()

Serializes the instance to a Json string.

toJsonNode

public static JsonNode toJsonNode(Object object)

Serializes an object to a JsonNode.

toJsonString

public static String toJsonString(Object object)

Serializes an object to a Json string.

toolCall

public abstract Optional<ToolCall> toolCall()

Server-side tool call.

toolResponse

public abstract Optional<ToolResponse> toolResponse()

The output from a server-side ToolCall execution.

videoMetadata

public abstract Optional<VideoMetadata> videoMetadata()

Optional.