Struct VertexEmbeddingConfig 

#[non_exhaustive]
pub struct VertexEmbeddingConfig {
    pub model_id: String,
    pub text_template: String,
    pub task_type: EmbeddingTaskType,
    /* private fields */
}

Message describing the configuration for generating embeddings for a vector field using Vertex AI embeddings 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.

model_id: String

Required. Required: ID of the embedding model to use. See https://cloud.google.com/vertex-ai/generative-ai/docs/learn/models#embeddings-models for the list of supported models.

text_template: String

Required. Required: Text template for the input to the model. The template must contain one or more references to fields in the DataObject, e.g.: “Movie Title: {title} –– Movie Plot: {plot}”.

task_type: EmbeddingTaskType

Required. Required: Task type for the embeddings.

Implementations

impl VertexEmbeddingConfig

pub fn new() -> Self

pub fn set_model_id<T: Into<String>>(self, v: T) -> Self

Sets the value of model_id.

Example

let x = VertexEmbeddingConfig::new().set_model_id("example");

pub fn set_text_template<T: Into<String>>(self, v: T) -> Self

Sets the value of text_template.

Example

let x = VertexEmbeddingConfig::new().set_text_template("example");

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

Sets the value of task_type.

Example

use google_cloud_vectorsearch_v1::model::EmbeddingTaskType;
let x0 = VertexEmbeddingConfig::new().set_task_type(EmbeddingTaskType::RetrievalQuery);
let x1 = VertexEmbeddingConfig::new().set_task_type(EmbeddingTaskType::RetrievalDocument);
let x2 = VertexEmbeddingConfig::new().set_task_type(EmbeddingTaskType::SemanticSimilarity);

Trait Implementations

impl Clone for VertexEmbeddingConfig

fn clone(&self) -> VertexEmbeddingConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for VertexEmbeddingConfig

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

Formats the value using the given formatter.

impl Default for VertexEmbeddingConfig

fn default() -> VertexEmbeddingConfig

Returns the “default value” for a type.

impl Message for VertexEmbeddingConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for VertexEmbeddingConfig

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