Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Part (v1.1.0)

Version latest

• 1.1.0 (latest)
• 1.0.0
• 0.64.0
• 0.63.0
• 0.62.0
• 0.61.0
• 0.60.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.48.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 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.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.1
• 0.8.0
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Part.

A datatype containing media that is part of a multi-part Content message.

A Part consists of data which has an associated datatype. A Part can only contain one of the accepted types in Part.data.

A Part must have a fixed IANA MIME type identifying the type and subtype of the media if inline_data or file_data field is filled with raw bytes.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#code_execution_result

def code_execution_result() -> ::Google::Cloud::AIPlatform::V1::CodeExecutionResult

Returns

• (::Google::Cloud::AIPlatform::V1::CodeExecutionResult) — Optional. Result of executing the [ExecutableCode].

  Note: The following fields are mutually exclusive: code_execution_result, text, inline_data, file_data, function_call, function_response, executable_code. If a field in that set is populated, all other fields in the set will automatically be cleared.

#code_execution_result=

def code_execution_result=(value) -> ::Google::Cloud::AIPlatform::V1::CodeExecutionResult

Parameter

• value (::Google::Cloud::AIPlatform::V1::CodeExecutionResult) — Optional. Result of executing the [ExecutableCode].

  Note: The following fields are mutually exclusive: code_execution_result, text, inline_data, file_data, function_call, function_response, executable_code. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::CodeExecutionResult) — Optional. Result of executing the [ExecutableCode].

  Note: The following fields are mutually exclusive: code_execution_result, text, inline_data, file_data, function_call, function_response, executable_code. If a field in that set is populated, all other fields in the set will automatically be cleared.

#executable_code

def executable_code() -> ::Google::Cloud::AIPlatform::V1::ExecutableCode

Returns

• (::Google::Cloud::AIPlatform::V1::ExecutableCode) — Optional. Code generated by the model that is meant to be executed.

  Note: The following fields are mutually exclusive: executable_code, text, inline_data, file_data, function_call, function_response, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

#executable_code=

def executable_code=(value) -> ::Google::Cloud::AIPlatform::V1::ExecutableCode

Parameter

• value (::Google::Cloud::AIPlatform::V1::ExecutableCode) — Optional. Code generated by the model that is meant to be executed.

  Note: The following fields are mutually exclusive: executable_code, text, inline_data, file_data, function_call, function_response, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::ExecutableCode) — Optional. Code generated by the model that is meant to be executed.

  Note: The following fields are mutually exclusive: executable_code, text, inline_data, file_data, function_call, function_response, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

#file_data

def file_data() -> ::Google::Cloud::AIPlatform::V1::FileData

Returns

• (::Google::Cloud::AIPlatform::V1::FileData) — Optional. URI based data.

  Note: The following fields are mutually exclusive: file_data, text, inline_data, function_call, function_response, executable_code, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

#file_data=

def file_data=(value) -> ::Google::Cloud::AIPlatform::V1::FileData

Parameter

• value (::Google::Cloud::AIPlatform::V1::FileData) — Optional. URI based data.

  Note: The following fields are mutually exclusive: file_data, text, inline_data, function_call, function_response, executable_code, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::FileData) — Optional. URI based data.

  Note: The following fields are mutually exclusive: file_data, text, inline_data, function_call, function_response, executable_code, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

#function_call

def function_call() -> ::Google::Cloud::AIPlatform::V1::FunctionCall

Returns

• (::Google::Cloud::AIPlatform::V1::FunctionCall) — Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.

  Note: The following fields are mutually exclusive: function_call, text, inline_data, file_data, function_response, executable_code, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

#function_call=

def function_call=(value) -> ::Google::Cloud::AIPlatform::V1::FunctionCall

Parameter

• value (::Google::Cloud::AIPlatform::V1::FunctionCall) — Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.

  Note: The following fields are mutually exclusive: function_call, text, inline_data, file_data, function_response, executable_code, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::FunctionCall) — Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.

  Note: The following fields are mutually exclusive: function_call, text, inline_data, file_data, function_response, executable_code, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

#function_response

def function_response() -> ::Google::Cloud::AIPlatform::V1::FunctionResponse

Returns

• (::Google::Cloud::AIPlatform::V1::FunctionResponse) — Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.

  Note: The following fields are mutually exclusive: function_response, text, inline_data, file_data, function_call, executable_code, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

#function_response=

def function_response=(value) -> ::Google::Cloud::AIPlatform::V1::FunctionResponse

Parameter

• value (::Google::Cloud::AIPlatform::V1::FunctionResponse) — Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.

  Note: The following fields are mutually exclusive: function_response, text, inline_data, file_data, function_call, executable_code, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::FunctionResponse) — Optional. The result output of a [FunctionCall] that contains a string representing the [FunctionDeclaration.name] and a structured JSON object containing any output from the function call. It is used as context to the model.

  Note: The following fields are mutually exclusive: function_response, text, inline_data, file_data, function_call, executable_code, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

#inline_data

def inline_data() -> ::Google::Cloud::AIPlatform::V1::Blob

Returns

• (::Google::Cloud::AIPlatform::V1::Blob) — Optional. Inlined bytes data.

  Note: The following fields are mutually exclusive: inline_data, text, file_data, function_call, function_response, executable_code, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

#inline_data=

def inline_data=(value) -> ::Google::Cloud::AIPlatform::V1::Blob

Parameter

• value (::Google::Cloud::AIPlatform::V1::Blob) — Optional. Inlined bytes data.

  Note: The following fields are mutually exclusive: inline_data, text, file_data, function_call, function_response, executable_code, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Cloud::AIPlatform::V1::Blob) — Optional. Inlined bytes data.

  Note: The following fields are mutually exclusive: inline_data, text, file_data, function_call, function_response, executable_code, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text

def text() -> ::String

Returns

• (::String) — Optional. Text part (can be code).

  Note: The following fields are mutually exclusive: text, inline_data, file_data, function_call, function_response, executable_code, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

#text=

def text=(value) -> ::String

Parameter

• value (::String) — Optional. Text part (can be code).

  Note: The following fields are mutually exclusive: text, inline_data, file_data, function_call, function_response, executable_code, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::String) — Optional. Text part (can be code).

  Note: The following fields are mutually exclusive: text, inline_data, file_data, function_call, function_response, executable_code, code_execution_result. If a field in that set is populated, all other fields in the set will automatically be cleared.

#video_metadata

def video_metadata() -> ::Google::Cloud::AIPlatform::V1::VideoMetadata

Returns

• (::Google::Cloud::AIPlatform::V1::VideoMetadata) — Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.

#video_metadata=

def video_metadata=(value) -> ::Google::Cloud::AIPlatform::V1::VideoMetadata

Parameter

• value (::Google::Cloud::AIPlatform::V1::VideoMetadata) — Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.

Returns

• (::Google::Cloud::AIPlatform::V1::VideoMetadata) — Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.