Vertex AI v1 API - Class EmbedContentRequest (3.54.0)

Version latest

• 3.54.0 (latest)
• 3.53.0
• 3.52.0
• 3.51.0
• 3.50.0
• 3.49.0
• 3.48.0
• 3.47.0
• 3.46.0
• 3.45.0
• 3.44.0
• 3.43.0
• 3.42.0
• 3.41.0
• 3.40.0
• 3.39.0
• 3.38.0
• 3.37.0
• 3.36.0
• 3.35.0
• 3.34.0
• 3.33.0
• 3.32.0
• 3.31.0
• 3.30.0
• 3.29.0
• 3.28.0
• 3.27.0
• 3.26.0
• 3.25.0
• 3.24.0
• 3.23.0
• 3.22.0
• 3.21.0
• 3.20.0
• 3.19.0
• 3.18.0
• 3.17.0
• 3.16.0
• 3.15.0
• 3.14.0
• 3.13.0
• 3.12.0
• 3.11.0
• 3.10.0
• 3.9.0
• 3.8.0
• 3.7.0
• 3.6.0
• 3.5.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.0
• 2.28.0
• 2.27.0
• 2.26.0
• 2.25.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0

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

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

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

Inheritance

object > EmbedContentRequest

Implements

IMessageEmbedContentRequest, IEquatableEmbedContentRequest, IDeepCloneableEmbedContentRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.AIPlatform.V1

Assembly

Google.Cloud.AIPlatform.V1.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