Package com.google.genai.types

Class EmbedContentParametersPrivate

java.lang.Object

com.google.genai.JsonSerializable

com.google.genai.types.EmbedContentParametersPrivate

@InternalApi
public abstract class EmbedContentParametersPrivate
extends JsonSerializable

Parameters for the _embed_content method.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	EmbedContentParametersPrivate.Builder	Builder for EmbedContentParametersPrivate.

Field Summary

Fields inherited from class com.google.genai.JsonSerializable

MAX_READ_LENGTH_PROPERTY

Constructor Summary

Constructors

Constructor	Description
EmbedContentParametersPrivate()

Method Summary

Modifier and Type	Method	Description
static EmbedContentParametersPrivate.Builder	builder()	Instantiates a builder for EmbedContentParametersPrivate.
abstract Optional<EmbedContentConfig>	config()	Configuration that contains optional parameters.
abstract Optional<Content>	content()	The single content to embed.
abstract Optional<List<Content>>	contents()	The content to embed.
abstract Optional<EmbeddingApiType>	embeddingApiType()	The Vertex embedding API to use.
static EmbedContentParametersPrivate	fromJson(String jsonString)	Deserializes a JSON string to a EmbedContentParametersPrivate object.
abstract Optional<String>	model()	ID of the model to use.
abstract EmbedContentParametersPrivate.Builder	toBuilder()	Creates a builder with the same values as this instance.

Methods inherited from class com.google.genai.JsonSerializable

fromJsonNode, fromJsonString, objectMapper, setMaxReadLength, stringToJsonNode, toJson, toJsonNode, toJsonString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

EmbedContentParametersPrivate

public EmbedContentParametersPrivate()

Method Details

model

public abstract Optional<String> model()

ID of the model to use. For a list of models, see `Google models <https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models>`_.

contents

public abstract Optional<List<Content>> contents()

The content to embed. Only the `parts.text` fields will be counted.

content

public abstract Optional<Content> content()

The single content to embed. Only the `parts.text` fields will be counted.

embeddingApiType

public abstract Optional<EmbeddingApiType> embeddingApiType()

The Vertex embedding API to use.

config

public abstract Optional<EmbedContentConfig> config()

Configuration that contains optional parameters.

builder

public static EmbedContentParametersPrivate.Builder builder()

Instantiates a builder for EmbedContentParametersPrivate.

toBuilder

public abstract EmbedContentParametersPrivate.Builder toBuilder()

Creates a builder with the same values as this instance.

fromJson

public static EmbedContentParametersPrivate fromJson(String jsonString)

Deserializes a JSON string to a EmbedContentParametersPrivate object.