Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Google Cloud Ai Platform V1 Client - Class Part (1.40.0)

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class 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.

Generated from protobuf message google.cloud.aiplatform.v1.Part

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ text`	`string` Optional. Text part (can be code).
`↳ inline_data`	`Blob` Optional. Inlined bytes data.
`↳ file_data`	`FileData` Optional. URI based data.
`↳ function_call`	`FunctionCall` Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.
`↳ function_response`	`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.
`↳ executable_code`	`ExecutableCode` Optional. Code generated by the model that is meant to be executed.
`↳ code_execution_result`	`CodeExecutionResult` Optional. Result of executing the [ExecutableCode].
`↳ thought`	`bool` Indicates if the part is thought from the model.
`↳ thought_signature`	`string` An opaque signature for the thought so it can be reused in subsequent requests.
`↳ video_metadata`	`VideoMetadata` Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.

getText

Optional. Text part (can be code).

Returns
Type	Description
`string`

hasText

setText

Optional. Text part (can be code).

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getInlineData

Optional. Inlined bytes data.

Returns
Type	Description
`Blob\|null`

hasInlineData

setInlineData

Optional. Inlined bytes data.

Parameter
Name	Description
`var`	`Blob`

Returns
Type	Description
`$this`

getFileData

Optional. URI based data.

Returns
Type	Description
`FileData\|null`

hasFileData

setFileData

Optional. URI based data.

Parameter
Name	Description
`var`	`FileData`

Returns
Type	Description
`$this`

getFunctionCall

Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.

Returns
Type	Description
`FunctionCall\|null`

hasFunctionCall

setFunctionCall

Optional. A predicted [FunctionCall] returned from the model that contains a string representing the [FunctionDeclaration.name] with the parameters and their values.

Parameter
Name	Description
`var`	`FunctionCall`

Returns
Type	Description
`$this`

getFunctionResponse

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.

Returns
Type	Description
`FunctionResponse\|null`

hasFunctionResponse

setFunctionResponse

Parameter
Name	Description
`var`	`FunctionResponse`

Returns
Type	Description
`$this`

getExecutableCode

Optional. Code generated by the model that is meant to be executed.

Returns
Type	Description
`ExecutableCode\|null`

hasExecutableCode

setExecutableCode

Optional. Code generated by the model that is meant to be executed.

Parameter
Name	Description
`var`	`ExecutableCode`

Returns
Type	Description
`$this`

getCodeExecutionResult

Optional. Result of executing the [ExecutableCode].

Returns
Type	Description
`CodeExecutionResult\|null`

hasCodeExecutionResult

setCodeExecutionResult

Optional. Result of executing the [ExecutableCode].

Parameter
Name	Description
`var`	`CodeExecutionResult`

Returns
Type	Description
`$this`

getThought

Indicates if the part is thought from the model.

Returns
Type	Description
`bool`

setThought

Indicates if the part is thought from the model.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getThoughtSignature

An opaque signature for the thought so it can be reused in subsequent requests.

Returns
Type	Description
`string`

setThoughtSignature

An opaque signature for the thought so it can be reused in subsequent requests.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getVideoMetadata

Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.

Returns
Type	Description
`VideoMetadata\|null`

hasVideoMetadata

setVideoMetadata

Optional. Video metadata. The metadata should only be specified while the video data is presented in inline_data or file_data.

Parameter
Name	Description
`var`	`VideoMetadata`

Returns
Type	Description
`$this`

getData

Returns
Type	Description
`string`

getMetadata

Returns
Type	Description
`string`