Discovery Engine v1 API - Class GenerateGroundedContentRequest (1.5.0)

public sealed class GenerateGroundedContentRequest : IMessage<GenerateGroundedContentRequest>, IEquatable<GenerateGroundedContentRequest>, IDeepCloneable<GenerateGroundedContentRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class GenerateGroundedContentRequest.

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

Inheritance

object > GenerateGroundedContentRequest

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

GenerateGroundedContentRequest()

public GenerateGroundedContentRequest()

GenerateGroundedContentRequest(GenerateGroundedContentRequest)

public GenerateGroundedContentRequest(GenerateGroundedContentRequest other)
Parameter
Name Description
other GenerateGroundedContentRequest

Properties

Contents

public RepeatedField<GroundedGenerationContent> Contents { get; }

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.

Property Value
Type Description
RepeatedFieldGroundedGenerationContent

GenerationSpec

public GenerateGroundedContentRequest.Types.GenerationSpec GenerationSpec { get; set; }

Content generation specification.

Property Value
Type Description
GenerateGroundedContentRequestTypesGenerationSpec

GroundingSpec

public GenerateGroundedContentRequest.Types.GroundingSpec GroundingSpec { get; set; }

Grounding specification.

Property Value
Type Description
GenerateGroundedContentRequestTypesGroundingSpec

Location

public string Location { get; set; }

Required. Location resource.

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

Property Value
Type Description
string

LocationAsLocationName

public LocationName LocationAsLocationName { get; set; }

LocationName-typed view over the Location resource name property.

Property Value
Type Description
LocationName

SystemInstruction

public GroundedGenerationContent SystemInstruction { get; set; }

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.

Property Value
Type Description
GroundedGenerationContent

UserLabels

public MapField<string, string> UserLabels { get; }

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.

Property Value
Type Description
MapFieldstringstring