Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::EmbedContentRequest.
Request message for PredictionService.EmbedContent.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#auto_truncate
def auto_truncate() -> ::Boolean
Returns
- (::Boolean) — Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead. Whether to silently truncate the input content if it's longer than the maximum sequence length.
#auto_truncate=
def auto_truncate=(value) -> ::Boolean
Parameter
- value (::Boolean) — 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
- (::Boolean) — Optional. Deprecated: Please use EmbedContentConfig.auto_truncate instead. Whether to silently truncate the input content if it's longer than the maximum sequence length.
#content
def content() -> ::Google::Cloud::AIPlatform::V1::Content
Returns
- (::Google::Cloud::AIPlatform::V1::Content) — Required. Input content to be embedded.
#content=
def content=(value) -> ::Google::Cloud::AIPlatform::V1::Content
Parameter
- value (::Google::Cloud::AIPlatform::V1::Content) — Required. Input content to be embedded.
Returns
- (::Google::Cloud::AIPlatform::V1::Content) — Required. Input content to be embedded.
#embed_content_config
def embed_content_config() -> ::Google::Cloud::AIPlatform::V1::EmbedContentRequest::EmbedContentConfig
Returns
- (::Google::Cloud::AIPlatform::V1::EmbedContentRequest::EmbedContentConfig) — Optional. Configuration for the EmbedContent request.
#embed_content_config=
def embed_content_config=(value) -> ::Google::Cloud::AIPlatform::V1::EmbedContentRequest::EmbedContentConfig
Parameter
- value (::Google::Cloud::AIPlatform::V1::EmbedContentRequest::EmbedContentConfig) — Optional. Configuration for the EmbedContent request.
Returns
- (::Google::Cloud::AIPlatform::V1::EmbedContentRequest::EmbedContentConfig) — Optional. Configuration for the EmbedContent request.
#model
def model() -> ::String
Returns
-
(::String) — Required. The name of the publisher model requested to serve the
prediction. Format:
projects/{project}/locations/{location}/publishers/*/models/*
#model=
def model=(value) -> ::String
Parameter
-
value (::String) — Required. The name of the publisher model requested to serve the
prediction. Format:
projects/{project}/locations/{location}/publishers/*/models/*
Returns
-
(::String) — Required. The name of the publisher model requested to serve the
prediction. Format:
projects/{project}/locations/{location}/publishers/*/models/*
#output_dimensionality
def output_dimensionality() -> ::Integer
Returns
- (::Integer) — 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.
#output_dimensionality=
def output_dimensionality=(value) -> ::Integer
Parameter
- value (::Integer) — 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
- (::Integer) — 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.
#task_type
def task_type() -> ::Google::Cloud::AIPlatform::V1::EmbedContentRequest::EmbeddingTaskType
Returns
- (::Google::Cloud::AIPlatform::V1::EmbedContentRequest::EmbeddingTaskType) — Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding.
#task_type=
def task_type=(value) -> ::Google::Cloud::AIPlatform::V1::EmbedContentRequest::EmbeddingTaskType
Parameter
- value (::Google::Cloud::AIPlatform::V1::EmbedContentRequest::EmbeddingTaskType) — Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding.
Returns
- (::Google::Cloud::AIPlatform::V1::EmbedContentRequest::EmbeddingTaskType) — Optional. Deprecated: Please use EmbedContentConfig.task_type instead. The task type of the embedding.
#title
def title() -> ::String
Returns
- (::String) — Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text.
#title=
def title=(value) -> ::String
Parameter
- value (::String) — Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text.
Returns
- (::String) — Optional. Deprecated: Please use EmbedContentConfig.title instead. The title for the text.