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

Parameter
Name
Description
data
mixed

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.

Returns
Type
Description
Content |null

hasContent

clearContent

setContent

Required. Input content to be embedded.

Parameter
Name
Description
var
Returns
Type
Description
$this

getTitle

Optional. Deprecated: Please use EmbedContentConfig.title instead.

The title for the text.

Returns
Type
Description
string

hasTitle

clearTitle

setTitle

Optional. Deprecated: Please use EmbedContentConfig.title instead.

The title for the text.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getTaskType

Optional. Deprecated: Please use EmbedContentConfig.task_type instead.

The task type of the embedding.

Returns
Type
Description
int

hasTaskType

clearTaskType

setTaskType

Optional. Deprecated: Please use EmbedContentConfig.task_type instead.

The task type of the embedding.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getOutputDimensionality

Optional. Deprecated: Please use EmbedContentConfig.output_dimensionality instead. 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. Deprecated: Please use EmbedContentConfig.output_dimensionality instead. 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. Deprecated: Please use EmbedContentConfig.auto_truncate instead.

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

Returns
Type
Description
bool

hasAutoTruncate

clearAutoTruncate

setAutoTruncate

Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead.

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

getEmbedContentConfig

Optional. Configuration for the EmbedContent request.

Returns
Type
Description

hasEmbedContentConfig

clearEmbedContentConfig

setEmbedContentConfig

Optional. Configuration for the EmbedContent request.

Parameter
Name
Description
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.

Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: