Class StoredContentsExample (1.90.0)

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

A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store.

Attributes

Name Description
search_key str
Optional. (Optional) the search key used for retrieval. If not provided at upload-time, the search key will be generated from contents_example.contents using the method provided by search_key_generation_method. The generated search key will be included in retrieved examples.
contents_example google.cloud.aiplatform_v1beta1.types.ContentsExample
Required. The example to be used with GenerateContent.
search_key_generation_method google.cloud.aiplatform_v1beta1.types.StoredContentsExample.SearchKeyGenerationMethod
Optional. The method used to generate the search key from contents_example.contents. This is ignored when uploading an example if search_key is provided.

Classes

SearchKeyGenerationMethod

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

Options for generating the search key from the conversation history.

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

Methods

StoredContentsExample

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

A ContentsExample to be used with GenerateContent alongside information required for storage and retrieval with Example Store.