Google Cloud Ai Platform V1 Client - Class GenerateContentRequest (1.12.0)

Version latest

• 1.12.0 (latest)
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 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.13.0
• 0.12.0
• 0.11.1
• 0.10.0

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class GenerateContentRequest.

Request message for [PredictionService.GenerateContent].

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

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ model	string Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: projects/{project}/locations/{location}/publishers/*/models/* Tuned model endpoint format: projects/{project}/locations/{location}/endpoints/{endpoint}
↳ contents	array<Content> Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.
↳ system_instruction	Content Optional. The user provided system instructions for the model. Note: only text should be used in parts and content in each part will be in a separate paragraph.
↳ tools	array<Tool> Optional. A list of Tools the model may use to generate the next response. A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.
↳ tool_config	ToolConfig Optional. Tool config. This config is shared for all tools provided in the request.
↳ labels	array|Google\Protobuf\Internal\MapField Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only. Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.
↳ safety_settings	array<SafetySetting> Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates.
↳ generation_config	GenerationConfig Optional. Generation config.

getModel

Required. The fully qualified name of the publisher model or tuned model endpoint to use.

Publisher model format: projects/{project}/locations/{location}/publishers/*/models/* Tuned model endpoint format: projects/{project}/locations/{location}/endpoints/{endpoint}

Returns
Type	Description
string

setModel

Required. The fully qualified name of the publisher model or tuned model endpoint to use.

Publisher model format: projects/{project}/locations/{location}/publishers/*/models/* Tuned model endpoint format: projects/{project}/locations/{location}/endpoints/{endpoint}

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getContents

Required. The content of the current conversation with the model.

For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setContents

Required. The content of the current conversation with the model.

For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.

Parameter
Name	Description
var	array<Content>

Returns
Type	Description
$this

getSystemInstruction

Optional. The user provided system instructions for the model.

Note: only text should be used in parts and content in each part will be in a separate paragraph.

Returns
Type	Description
Content|null

hasSystemInstruction

clearSystemInstruction

setSystemInstruction

Optional. The user provided system instructions for the model.

Note: only text should be used in parts and content in each part will be in a separate paragraph.

Parameter
Name	Description
var	Content

Returns
Type	Description
$this

getTools

Optional. A list of Tools the model may use to generate the next response.

A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setTools

Optional. A list of Tools the model may use to generate the next response.

A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model.

Parameter
Name	Description
var	array<Tool>

Returns
Type	Description
$this

getToolConfig

Optional. Tool config. This config is shared for all tools provided in the request.

Returns
Type	Description
ToolConfig|null

hasToolConfig

clearToolConfig

setToolConfig

Optional. Tool config. This config is shared for all tools provided in the request.

Parameter
Name	Description
var	ToolConfig

Returns
Type	Description
$this

getLabels

Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only.

Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

Returns
Type	Description
Google\Protobuf\Internal\MapField

setLabels

Optional. The labels with user-defined metadata for the request. It is used for billing and reporting only.

Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

getSafetySettings

Optional. Per request settings for blocking unsafe content.

Enforced on GenerateContentResponse.candidates.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setSafetySettings

Optional. Per request settings for blocking unsafe content.

Enforced on GenerateContentResponse.candidates.

Parameter
Name	Description
var	array<SafetySetting>

Returns
Type	Description
$this

getGenerationConfig

Optional. Generation config.

Returns
Type	Description
GenerationConfig|null

hasGenerationConfig

clearGenerationConfig

setGenerationConfig

Optional. Generation config.

Parameter
Name	Description
var	GenerationConfig

Returns
Type	Description
$this

static::build

Parameters
Name	Description
model	string Required. The fully qualified name of the publisher model or tuned model endpoint to use. Publisher model format: projects/{project}/locations/{location}/publishers/*/models/* Tuned model endpoint format: projects/{project}/locations/{location}/endpoints/{endpoint}
contents	array<Content> Required. The content of the current conversation with the model. For single-turn queries, this is a single instance. For multi-turn queries, this is a repeated field that contains conversation history + latest request.

Returns
Type	Description
GenerateContentRequest