Struct google_api_proto::google::ai::generativelanguage::v1::EmbedContentRequest

pub struct EmbedContentRequest {
    pub model: String,
    pub content: Option<Content>,
    pub task_type: Option<i32>,
    pub title: Option<String>,
    pub output_dimensionality: Option<i32>,
}

Request containing the Content for the model to embed.

Fields

model: String

Required. The model’s resource name. This serves as an ID for the Model to use.

This name should match a model name returned by the ListModels method.

Format: models/{model}

content: Option<Content>

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

task_type: Option<i32>

Optional. Optional task type for which the embeddings will be used. Can only be set for models/embedding-001.

title: Option<String>

Optional. An optional title for the text. Only applicable when TaskType is RETRIEVAL_DOCUMENT.

Note: Specifying a title for RETRIEVAL_DOCUMENT provides better quality embeddings for retrieval.

output_dimensionality: Option<i32>

Optional. Optional reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end. Supported by newer models since 2024 only. You cannot set this value if using the earlier model (models/embedding-001).

Implementations

impl EmbedContentRequest

pub fn task_type(&self) -> TaskType

Returns the enum value of task_type, or the default if the field is unset or set to an invalid enum value.

pub fn set_task_type(&mut self, value: TaskType)

Sets task_type to the provided enum value.

pub fn title(&self) -> &str

Returns the value of title, or the default value if title is unset.

pub fn output_dimensionality(&self) -> i32

Returns the value of output_dimensionality, or the default value if output_dimensionality is unset.

Trait Implementations

impl Clone for EmbedContentRequest

fn clone(&self) -> EmbedContentRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EmbedContentRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EmbedContentRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for EmbedContentRequest

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for EmbedContentRequest

fn eq(&self, other: &EmbedContentRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for EmbedContentRequest