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 \ EmbedContentRequestMethods
__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 |
|