Google Cloud Ai Platform V1 Client - Class EmbedContentRequest (1.43.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`