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 \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ model |
string
Required. The name of the publisher model requested to serve the prediction. Format: |
↳ contents |
array<Google\Cloud\AIPlatform\V1\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. |
↳ tools |
array<Google\Cloud\AIPlatform\V1\Tool>
Optional. A list of |
↳ safety_settings |
array<Google\Cloud\AIPlatform\V1\SafetySetting>
Optional. Per request settings for blocking unsafe content. Enforced on GenerateContentResponse.candidates. |
↳ generation_config |
Google\Cloud\AIPlatform\V1\GenerationConfig
Optional. Generation config. |
getModel
Required. The name of the publisher model requested to serve the
prediction. Format:
projects/{project}/locations/{location}/publishers/*/models/*
| Returns | |
|---|---|
| Type | Description |
string | |
setModel
Required. The name of the publisher model requested to serve the
prediction. Format:
projects/{project}/locations/{location}/publishers/*/models/*
| 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<Google\Cloud\AIPlatform\V1\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. The only supported tool is currently
Function
| 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. The only supported tool is currently
Function
| Parameter | |
|---|---|
| Name | Description |
var |
array<Google\Cloud\AIPlatform\V1\Tool>
|
| 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<Google\Cloud\AIPlatform\V1\SafetySetting>
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getGenerationConfig
Optional. Generation config.
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\AIPlatform\V1\GenerationConfig|null | |
hasGenerationConfig
clearGenerationConfig
setGenerationConfig
Optional. Generation config.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\AIPlatform\V1\GenerationConfig
|
| Returns | |
|---|---|
| Type | Description |
$this | |
static::build
| Parameters | |
|---|---|
| Name | Description |
model |
string
Required. The name of the publisher model requested to serve the
prediction. Format:
|
contents |
array<Google\Cloud\AIPlatform\V1\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 |
Google\Cloud\AIPlatform\V1\GenerateContentRequest | |