Struct EmbedContentResponse 

#[non_exhaustive]
pub struct EmbedContentResponse {
    pub embedding: Option<Embedding>,
    pub usage_metadata: Option<UsageMetadata>,
    pub truncated: bool,
    /* private fields */
}

Available on crate feature prediction-service only.

Response message for PredictionService.EmbedContent.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

embedding: Option<Embedding>

The embedding generated from the input content.

usage_metadata: Option<UsageMetadata>

Metadata about the response(s).

truncated: bool

Whether the input content was truncated before generating the embedding.

Implementations

impl EmbedContentResponse

pub fn new() -> Self

pub fn set_embedding<T>(self, v: T) -> Self

where T: Into<Embedding>,

Sets the value of embedding.

Example

use google_cloud_aiplatform_v1::model::embed_content_response::Embedding;
let x = EmbedContentResponse::new().set_embedding(Embedding::default()/* use setters */);

pub fn set_or_clear_embedding<T>(self, v: Option<T>) -> Self

where T: Into<Embedding>,

Sets or clears the value of embedding.

Example

use google_cloud_aiplatform_v1::model::embed_content_response::Embedding;
let x = EmbedContentResponse::new().set_or_clear_embedding(Some(Embedding::default()/* use setters */));
let x = EmbedContentResponse::new().set_or_clear_embedding(None::<Embedding>);

pub fn set_usage_metadata<T>(self, v: T) -> Self

where T: Into<UsageMetadata>,

Sets the value of usage_metadata.

Example

use google_cloud_aiplatform_v1::model::UsageMetadata;
let x = EmbedContentResponse::new().set_usage_metadata(UsageMetadata::default()/* use setters */);

pub fn set_or_clear_usage_metadata<T>(self, v: Option<T>) -> Self

where T: Into<UsageMetadata>,

Sets or clears the value of usage_metadata.

Example

use google_cloud_aiplatform_v1::model::UsageMetadata;
let x = EmbedContentResponse::new().set_or_clear_usage_metadata(Some(UsageMetadata::default()/* use setters */));
let x = EmbedContentResponse::new().set_or_clear_usage_metadata(None::<UsageMetadata>);

pub fn set_truncated<T: Into<bool>>(self, v: T) -> Self

Sets the value of truncated.

Example

let x = EmbedContentResponse::new().set_truncated(true);

Trait Implementations

impl Clone for EmbedContentResponse

fn clone(&self) -> EmbedContentResponse

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbedContentResponse

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

Formats the value using the given formatter.

impl Default for EmbedContentResponse

fn default() -> EmbedContentResponse

Returns the “default value” for a type.

impl Message for EmbedContentResponse

fn typename() -> &'static str

The typename of this message.

impl PartialEq for EmbedContentResponse

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for EmbedContentResponse