Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::Part (v1.27.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.

#thought

def thought() -> ::Boolean
Returns
  • (::Boolean) — Indicates if the part is thought from the model.

#thought=

def thought=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Indicates if the part is thought from the model.
Returns
  • (::Boolean) — Indicates if the part is thought from the model.

#thought_signature

def thought_signature() -> ::String
Returns
  • (::String) — An opaque signature for the thought so it can be reused in subsequent requests.

#thought_signature=

def thought_signature=(value) -> ::String
Parameter
  • value (::String) — An opaque signature for the thought so it can be reused in subsequent requests.
Returns
  • (::String) — An opaque signature for the thought so it can be reused in subsequent requests.

#video_metadata

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

#video_metadata=

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