Google Cloud Discovery Engine V1 Client - Class GenerateGroundedContentRequest (1.3.1)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class GenerateGroundedContentRequest.

Top-level message sent by the client for the GenerateGroundedContent method.

Generated from protobuf message google.cloud.discoveryengine.v1.GenerateGroundedContentRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ location string

Required. Location resource. Format: projects/{project}/locations/{location}.
↳ system_instruction GroundedGenerationContent

Content of the system instruction for the current API. These instructions will take priority over any other prompt instructions if the selected model is supporting them.
↳ contents array<GroundedGenerationContent>

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. Only a single-turn query is supported currently.
↳ generation_spec GenerateGroundedContentRequest\GenerationSpec

Content generation specification.
↳ grounding_spec GenerateGroundedContentRequest\GroundingSpec

Grounding specification.
↳ user_labels array|Google\Protobuf\Internal\MapField

The user labels applied to a resource must meet the following requirements: * * Each resource can have multiple labels, up to a maximum of 64. * * Each label must be a key-value pair. * * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * * The key portion of a label must be unique. However, you can use the same key with multiple resources. * * Keys must start with a lowercase letter or international character. See Google Cloud Document for more details.

getLocation

Required. Location resource.

Format: projects/{project}/locations/{location}.

Returns
Type Description
string

setLocation

Required. Location resource.

Format: projects/{project}/locations/{location}.

Parameter
Name Description
var string
Returns
Type Description
$this

getSystemInstruction

Content of the system instruction for the current API.

These instructions will take priority over any other prompt instructions if the selected model is supporting them.

Returns
Type Description
GroundedGenerationContent|null

hasSystemInstruction

clearSystemInstruction

setSystemInstruction

Content of the system instruction for the current API.

These instructions will take priority over any other prompt instructions if the selected model is supporting them.

Parameter
Name Description
var GroundedGenerationContent
Returns
Type Description
$this

getContents

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. Only a single-turn query is supported currently.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setContents

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. Only a single-turn query is supported currently.

Parameter
Name Description
var array<GroundedGenerationContent>
Returns
Type Description
$this

getGenerationSpec

Content generation specification.

Returns
Type Description
GenerateGroundedContentRequest\GenerationSpec|null

hasGenerationSpec

clearGenerationSpec

setGenerationSpec

Content generation specification.

Parameter
Name Description
var GenerateGroundedContentRequest\GenerationSpec
Returns
Type Description
$this

getGroundingSpec

Grounding specification.

Returns
Type Description
GenerateGroundedContentRequest\GroundingSpec|null

hasGroundingSpec

clearGroundingSpec

setGroundingSpec

Grounding specification.

Parameter
Name Description
var GenerateGroundedContentRequest\GroundingSpec
Returns
Type Description
$this

getUserLabels

The user labels applied to a resource must meet the following requirements:

  • Each resource can have multiple labels, up to a maximum of 64.

  • Each label must be a key-value pair.

  • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
  • The key portion of a label must be unique. However, you can use the same key with multiple resources.
  • Keys must start with a lowercase letter or international character. See Google Cloud Document for more details.
Returns
Type Description
Google\Protobuf\Internal\MapField

setUserLabels

The user labels applied to a resource must meet the following requirements:

  • Each resource can have multiple labels, up to a maximum of 64.

  • Each label must be a key-value pair.

  • Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters.
  • Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed.
  • The key portion of a label must be unique. However, you can use the same key with multiple resources.
  • Keys must start with a lowercase letter or international character. See Google Cloud Document for more details.
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this