Google Cloud Ai Platform V1 Client - Class EmbedContentRequest (1.49.0)

1.56.0 (latest) 1.55.0 1.54.0 1.53.0 1.52.0 1.51.0 1.50.0 1.49.0 1.48.0 1.47.0 1.46.0 1.45.0 1.44.0 1.43.0 1.42.0 1.41.0 1.40.0 1.39.0 1.38.0 1.37.0 1.36.0 1.35.0 1.34.0 1.33.0 1.32.1 1.31.0 1.30.0 1.26.0 1.23.0 1.22.0 1.21.0 1.20.0 1.19.0 1.18.0 1.17.0 1.16.0 1.15.0 1.14.0 1.13.1 1.12.0 1.11.0 1.10.0 1.9.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 0.39.0 0.38.0 0.37.1 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.26.2 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.13.0 0.12.0 0.11.1 0.10.0

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class EmbedContentRequest.

Request message for PredictionService.EmbedContent.

Generated from protobuf message google.cloud.aiplatform.v1.EmbedContentRequest

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ model	string Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*
↳ content	Content Required. Input content to be embedded. Required.
↳ title	string Optional. An optional title for the text.
↳ task_type	int Optional. The task type of the embedding.
↳ output_dimensionality	int Optional. Optional reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.
↳ auto_truncate	bool Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length.

getModel

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

Returns
Type	Description
string

hasModel

clearModel

setModel

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getContent

Required. Input content to be embedded. Required.

Returns
Type	Description
Content|null

hasContent

clearContent

setContent

Required. Input content to be embedded. Required.

Parameter
Name	Description
var	Content

Returns
Type	Description
$this

getTitle

Optional. An optional title for the text.

Returns
Type	Description
string

hasTitle

clearTitle

setTitle

Optional. An optional title for the text.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTaskType

Optional. The task type of the embedding.

Returns
Type	Description
int

hasTaskType

clearTaskType

setTaskType

Optional. The task type of the embedding.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getOutputDimensionality

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

Returns
Type	Description
int

hasOutputDimensionality

clearOutputDimensionality

setOutputDimensionality

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

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getAutoTruncate

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

Returns
Type	Description
bool

hasAutoTruncate

clearAutoTruncate

setAutoTruncate

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

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

static::build

Parameters
Name	Description
model	string Required. The name of the publisher model requested to serve the prediction. Format: projects/{project}/locations/{location}/publishers/*/models/*
content	Content Required. Input content to be embedded. Required.

Returns
Type	Description
EmbedContentRequest