Struct EmbedContentRequest 

#[non_exhaustive]
pub struct EmbedContentRequest {
    pub model: Option<String>,
    pub content: Option<Content>,
    pub title: Option<String>,
    pub task_type: Option<EmbeddingTaskType>,
    pub output_dimensionality: Option<i32>,
    pub auto_truncate: Option<bool>,
    /* private fields */
}

Available on crate feature prediction-service only.

Request 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.

model: Option<String>

Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*

content: Option<Content>

Required. Input content to be embedded. Required.

title: Option<String>

Optional. An optional title for the text.

task_type: Option<EmbeddingTaskType>

Optional. The task type of the embedding.

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.

auto_truncate: Option<bool>

Optional. Whether to silently truncate the input content if it’s longer than the maximum sequence length.

Implementations

impl EmbedContentRequest

pub fn new() -> Self

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

where T: Into<String>,

Sets the value of model.

Example

let x = EmbedContentRequest::new().set_model("example");

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

where T: Into<String>,

Sets or clears the value of model.

Example

let x = EmbedContentRequest::new().set_or_clear_model(Some("example"));
let x = EmbedContentRequest::new().set_or_clear_model(None::<String>);

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

where T: Into<Content>,

Sets the value of content.

Example

use google_cloud_aiplatform_v1::model::Content;
let x = EmbedContentRequest::new().set_content(Content::default()/* use setters */);

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

where T: Into<Content>,

Sets or clears the value of content.

Example

use google_cloud_aiplatform_v1::model::Content;
let x = EmbedContentRequest::new().set_or_clear_content(Some(Content::default()/* use setters */));
let x = EmbedContentRequest::new().set_or_clear_content(None::<Content>);

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

where T: Into<String>,

Sets the value of title.

Example

let x = EmbedContentRequest::new().set_title("example");

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

where T: Into<String>,

Sets or clears the value of title.

Example

let x = EmbedContentRequest::new().set_or_clear_title(Some("example"));
let x = EmbedContentRequest::new().set_or_clear_title(None::<String>);

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

where T: Into<EmbeddingTaskType>,

Sets the value of task_type.

Example

use google_cloud_aiplatform_v1::model::embed_content_request::EmbeddingTaskType;
let x0 = EmbedContentRequest::new().set_task_type(EmbeddingTaskType::RetrievalQuery);
let x1 = EmbedContentRequest::new().set_task_type(EmbeddingTaskType::RetrievalDocument);
let x2 = EmbedContentRequest::new().set_task_type(EmbeddingTaskType::SemanticSimilarity);

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

where T: Into<EmbeddingTaskType>,

Sets or clears the value of task_type.

Example

use google_cloud_aiplatform_v1::model::embed_content_request::EmbeddingTaskType;
let x0 = EmbedContentRequest::new().set_or_clear_task_type(Some(EmbeddingTaskType::RetrievalQuery));
let x1 = EmbedContentRequest::new().set_or_clear_task_type(Some(EmbeddingTaskType::RetrievalDocument));
let x2 = EmbedContentRequest::new().set_or_clear_task_type(Some(EmbeddingTaskType::SemanticSimilarity));
let x_none = EmbedContentRequest::new().set_or_clear_task_type(None::<EmbeddingTaskType>);

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

where T: Into<i32>,

Sets the value of output_dimensionality.

Example

let x = EmbedContentRequest::new().set_output_dimensionality(42);

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

where T: Into<i32>,

Sets or clears the value of output_dimensionality.

Example

let x = EmbedContentRequest::new().set_or_clear_output_dimensionality(Some(42));
let x = EmbedContentRequest::new().set_or_clear_output_dimensionality(None::<i32>);

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

where T: Into<bool>,

Sets the value of auto_truncate.

Example

let x = EmbedContentRequest::new().set_auto_truncate(true);

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

where T: Into<bool>,

Sets or clears the value of auto_truncate.

Example

let x = EmbedContentRequest::new().set_or_clear_auto_truncate(Some(false));
let x = EmbedContentRequest::new().set_or_clear_auto_truncate(None::<bool>);

Trait Implementations

impl Clone for EmbedContentRequest

fn clone(&self) -> EmbedContentRequest

Returns a duplicate 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() -> EmbedContentRequest

Returns the “default value” for a type.

impl Message for EmbedContentRequest

fn typename() -> &'static str

The typename of this message.

impl PartialEq for EmbedContentRequest

fn eq(&self, other: &EmbedContentRequest) -> 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 EmbedContentRequest