Vertex AI v1beta1 API - Class EmbedContentRequest (1.0.0-beta57)

public sealed class EmbedContentRequest : IMessage<EmbedContentRequest>, IEquatable<EmbedContentRequest>, IDeepCloneable<EmbedContentRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Vertex AI v1beta1 API class EmbedContentRequest.

Request message for [PredictionService.EmbedContent][google.cloud.aiplatform.v1beta1.PredictionService.EmbedContent].

Inheritance

object > EmbedContentRequest

Namespace

Google.Cloud.AIPlatform.V1Beta1

Assembly

Google.Cloud.AIPlatform.V1Beta1.dll

Constructors

EmbedContentRequest()

public EmbedContentRequest()

EmbedContentRequest(EmbedContentRequest)

public EmbedContentRequest(EmbedContentRequest other)
Parameter
Name Description
other EmbedContentRequest

Properties

AutoTruncate

public bool AutoTruncate { get; set; }

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

Property Value
Type Description
bool

Content

public Content Content { get; set; }

Required. Input content to be embedded. Required.

Property Value
Type Description
Content

HasAutoTruncate

public bool HasAutoTruncate { get; }

Gets whether the "auto_truncate" field is set

Property Value
Type Description
bool

HasModel

public bool HasModel { get; }

Gets whether the "model" field is set

Property Value
Type Description
bool

HasOutputDimensionality

public bool HasOutputDimensionality { get; }

Gets whether the "output_dimensionality" field is set

Property Value
Type Description
bool

HasTaskType

public bool HasTaskType { get; }

Gets whether the "task_type" field is set

Property Value
Type Description
bool

HasTitle

public bool HasTitle { get; }

Gets whether the "title" field is set

Property Value
Type Description
bool

Model

public string Model { get; set; }

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

Property Value
Type Description
string

ModelAsEndpointName

public EndpointName ModelAsEndpointName { get; set; }

EndpointName-typed view over the Model resource name property.

Property Value
Type Description
EndpointName

OutputDimensionality

public int OutputDimensionality { get; set; }

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

Property Value
Type Description
int

TaskType

public EmbedContentRequest.Types.EmbeddingTaskType TaskType { get; set; }

Optional. The task type of the embedding.

Property Value
Type Description
EmbedContentRequestTypesEmbeddingTaskType

Title

public string Title { get; set; }

Optional. An optional title for the text.

Property Value
Type Description
string