API documentation for discoveryengine_v1beta.types package.
Classes
BigQuerySource
BigQuery source import data from.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CollectUserEventRequest
Request message for CollectUserEvent method.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
CompleteQueryRequest
Request message for CompletionService.CompleteQuery method.
CompleteQueryResponse
Response message for CompletionService.CompleteQuery method.
CompletionInfo
Detailed completion information including completion attribution token and clicked completion info.
CreateDocumentRequest
Request message for DocumentService.CreateDocument method.
CreateSchemaMetadata
Metadata for Create Schema LRO.
CreateSchemaRequest
Request message for SchemaService.CreateSchema method.
CustomAttribute
A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.
DeleteDocumentRequest
Request message for DocumentService.DeleteDocument method.
DeleteSchemaMetadata
Metadata for DeleteSchema LRO.
DeleteSchemaRequest
Request message for SchemaService.DeleteSchema method.
Document
Document captures all raw metadata information of items to be recommended or searched.
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
DocumentInfo
Detailed document information associated with a user event.
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
GcsSource
Cloud Storage location for input content.
GetDocumentRequest
Request message for DocumentService.GetDocument method.
GetSchemaRequest
Request message for SchemaService.GetSchema method.
ImportDocumentsMetadata
Metadata related to the progress of the ImportDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
ImportDocumentsRequest
Request message for Import methods.
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
ImportDocumentsResponse
Response of the ImportDocumentsRequest. If the long running operation is done, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
ImportErrorConfig
Configuration of destination for Import related errors.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
ImportUserEventsMetadata
Metadata related to the progress of the Import operation. This will be returned by the google.longrunning.Operation.metadata field.
ImportUserEventsRequest
Request message for the ImportUserEvents request.
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
ImportUserEventsResponse
Response of the ImportUserEventsRequest. If the long running operation was successful, then this message is returned by the google.longrunning.Operations.response field if the operation was successful.
Interval
A floating point interval.
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
ListDocumentsRequest
Request message for DocumentService.ListDocuments method.
ListDocumentsResponse
Response message for DocumentService.ListDocuments method.
ListSchemasRequest
Request message for SchemaService.ListSchemas method.
ListSchemasResponse
Response message for SchemaService.ListSchemas method.
MediaInfo
Media-specific user event information.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PageInfo
Detailed page information.
PanelInfo
Detailed panel information associated with a user event.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
PurgeDocumentsMetadata
Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.
PurgeDocumentsRequest
Request message for DocumentService.PurgeDocuments method.
PurgeDocumentsResponse
Response message for DocumentService.PurgeDocuments method. If the long running operation is successfully done, then this message is returned by the google.longrunning.Operations.response field.
RecommendRequest
Request message for Recommend method.
RecommendResponse
Response message for Recommend method.
Schema
Defines the structure and layout of a type of document data.
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
SearchInfo
Detailed search information.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
SearchRequest
Request message for SearchService.Search method.
SearchResponse
Response message for SearchService.Search method.
TransactionInfo
A transaction represents the entire purchase transaction.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
UpdateDocumentRequest
Request message for DocumentService.UpdateDocument method.
UpdateSchemaMetadata
Metadata for UpdateSchema LRO.
UpdateSchemaRequest
Request message for SchemaService.UpdateSchema method.
UserEvent
UserEvent captures all metadata information Discovery Engine API needs to know about how end users interact with customers' website.
UserInfo
Information of an end user.
WriteUserEventRequest
Request message for WriteUserEvent method.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields