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

Configurations for the EmbedContent API.

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

Namespace

Google \ Cloud \ AIPlatform \ V1 \ EmbedContentRequest

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ title	string Optional. The title for the text. Only applicable to text-only embedding models.
↳ task_type	int Optional. The task type of the embedding. Only applicable to text-only embedding models.
↳ auto_truncate	bool Optional. Whether to silently truncate the input content if it's longer than the maximum sequence length. Only applicable to text-only embedding models.
↳ output_dimensionality	int Optional. Reduced dimension for the output embedding. If set, excessive values in the output embedding are truncated from the end.
↳ document_ocr	bool Optional. Whether to enable OCR for document content.
↳ audio_track_extraction	bool Optional. Whether to extract audio from video content.

getTitle

Optional. The title for the text.

Only applicable to text-only embedding models.

Returns
Type	Description
string

hasTitle

clearTitle

setTitle

Optional. The title for the text.

Only applicable to text-only embedding models.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getTaskType

Optional. The task type of the embedding.

Only applicable to text-only embedding models.

Returns
Type	Description
int

hasTaskType

clearTaskType

setTaskType

Optional. The task type of the embedding.

Only applicable to text-only embedding models.

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.

Only applicable to text-only embedding models.

Returns
Type	Description
bool

hasAutoTruncate

clearAutoTruncate

setAutoTruncate

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

Only applicable to text-only embedding models.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getOutputDimensionality

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. 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

getDocumentOcr

Optional. Whether to enable OCR for document content.

Returns
Type	Description
bool

hasDocumentOcr

clearDocumentOcr

setDocumentOcr

Optional. Whether to enable OCR for document content.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getAudioTrackExtraction

Optional. Whether to extract audio from video content.

Returns
Type	Description
bool

hasAudioTrackExtraction

clearAudioTrackExtraction

setAudioTrackExtraction

Optional. Whether to extract audio from video content.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this