Class GenerateGroundedContentRequest (0.13.5)

GenerateGroundedContentRequest(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

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

Attributes
Name	Description
`location`	`str` Required. Location resource. Format: `projects/{project}/locations/{location}`.
`system_instruction`	`google.cloud.discoveryengine_v1.types.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`	`MutableSequence[google.cloud.discoveryengine_v1.types.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`	`google.cloud.discoveryengine_v1.types.GenerateGroundedContentRequest.GenerationSpec` Content generation specification.
`grounding_spec`	`google.cloud.discoveryengine_v1.types.GenerateGroundedContentRequest.GroundingSpec` Grounding specification.
`user_labels`	`MutableMapping[str, str]` 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

Classes

DynamicRetrievalConfiguration

DynamicRetrievalConfiguration(
    mapping=None, *, ignore_unknown_fields=False, **kwargs
)

Describes the options to customize dynamic retrieval.

GenerationSpec

GenerationSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Content generation specification.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GroundingSource

GroundingSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Grounding source.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

GroundingSpec

GroundingSpec(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Grounding specification.

UserLabelsEntry

UserLabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.