Struct EmbedContentConfig 

#[non_exhaustive]
pub struct EmbedContentConfig {
    pub title: Option<String>,
    pub task_type: Option<EmbeddingTaskType>,
    pub auto_truncate: Option<bool>,
    pub output_dimensionality: Option<i32>,
    pub document_ocr: Option<bool>,
    pub audio_track_extraction: Option<bool>,
    /* private fields */
}

Available on crate feature prediction-service only.

Configurations for the EmbedContent API.

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.

title: Option<String>

Optional. The title for the text.

Only applicable to text-only embedding models.

task_type: Option<EmbeddingTaskType>

Optional. The task type of the embedding.

Only applicable to text-only embedding models.

auto_truncate: Option<bool>

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

Only applicable to text-only embedding models.

output_dimensionality: Option<i32>

Optional. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.

document_ocr: Option<bool>

Optional. Whether to enable OCR for document content.

audio_track_extraction: Option<bool>

Optional. Whether to extract audio from video content.

Implementations

impl EmbedContentConfig

pub fn new() -> Self

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

where T: Into<String>,

Sets the value of title.

Example

let x = EmbedContentConfig::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 = EmbedContentConfig::new().set_or_clear_title(Some("example"));
let x = EmbedContentConfig::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 = EmbedContentConfig::new().set_task_type(EmbeddingTaskType::RetrievalQuery);
let x1 = EmbedContentConfig::new().set_task_type(EmbeddingTaskType::RetrievalDocument);
let x2 = EmbedContentConfig::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 = EmbedContentConfig::new().set_or_clear_task_type(Some(EmbeddingTaskType::RetrievalQuery));
let x1 = EmbedContentConfig::new().set_or_clear_task_type(Some(EmbeddingTaskType::RetrievalDocument));
let x2 = EmbedContentConfig::new().set_or_clear_task_type(Some(EmbeddingTaskType::SemanticSimilarity));
let x_none = EmbedContentConfig::new().set_or_clear_task_type(None::<EmbeddingTaskType>);

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

where T: Into<bool>,

Sets the value of auto_truncate.

Example

let x = EmbedContentConfig::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 = EmbedContentConfig::new().set_or_clear_auto_truncate(Some(false));
let x = EmbedContentConfig::new().set_or_clear_auto_truncate(None::<bool>);

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

where T: Into<i32>,

Sets the value of output_dimensionality.

Example

let x = EmbedContentConfig::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 = EmbedContentConfig::new().set_or_clear_output_dimensionality(Some(42));
let x = EmbedContentConfig::new().set_or_clear_output_dimensionality(None::<i32>);

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

where T: Into<bool>,

Sets the value of document_ocr.

Example

let x = EmbedContentConfig::new().set_document_ocr(true);

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

where T: Into<bool>,

Sets or clears the value of document_ocr.

Example

let x = EmbedContentConfig::new().set_or_clear_document_ocr(Some(false));
let x = EmbedContentConfig::new().set_or_clear_document_ocr(None::<bool>);

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

where T: Into<bool>,

Sets the value of audio_track_extraction.

Example

let x = EmbedContentConfig::new().set_audio_track_extraction(true);

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

where T: Into<bool>,

Sets or clears the value of audio_track_extraction.

Example

let x = EmbedContentConfig::new().set_or_clear_audio_track_extraction(Some(false));
let x = EmbedContentConfig::new().set_or_clear_audio_track_extraction(None::<bool>);

Trait Implementations

impl Clone for EmbedContentConfig

fn clone(&self) -> EmbedContentConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EmbedContentConfig

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

Formats the value using the given formatter.

impl Default for EmbedContentConfig

fn default() -> EmbedContentConfig

Returns the “default value” for a type.

impl Message for EmbedContentConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for EmbedContentConfig

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