Package google.cloud.discoveryengine.v1

Operation create time.

update_time

CreateTargetSiteRequest

Operation last update time. If the operation is done, this is also the finish time.

BatchCreateTargetSitesRequest

Request message for SiteSearchEngineService.BatchCreateTargetSites method.

Fields

parent

string

Required. The parent resource shared by all TargetSites being created. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine. The parent field in the CreateBookRequest messages must either be empty or match this field.

requests[]

Required. The request message specifying the resources to create. A maximum of 20 TargetSites can be created in a batch.

BatchCreateTargetSitesResponse

Response message for SiteSearchEngineService.BatchCreateTargetSites method.

Fields

target_sites[]

TargetSites created.

BatchVerifyTargetSitesMetadata

Metadata related to the progress of the SiteSearchEngineService.BatchVerifyTargetSites operation. This will be returned by the google.longrunning.Operation.metadata field.

Fields

create_time

Operation create time.

update_time

Operation last update time. If the operation is done, this is also the finish time.

BatchVerifyTargetSitesRequest

Request message for SiteSearchEngineService.BatchVerifyTargetSites method.

Fields

parent

string

Required. The parent resource shared by all TargetSites being verified. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

BatchVerifyTargetSitesResponse

This type has no fields.

Response message for SiteSearchEngineService.BatchVerifyTargetSites method.

BigQuerySource

BigQuery source import data from.

Fields
`project_id`	`string` The project ID (can be project # or ID) that the BigQuery source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
`dataset_id`	`string` Required. The BigQuery data set to copy the data from with a length limit of 1,024 characters.
`table_id`	`string` Required. The BigQuery table to copy the data from with a length limit of 1,024 characters.
`gcs_staging_dir`	`string` Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the BigQuery export to a specific Cloud Storage directory.
`data_schema`	`string` The schema to use when parsing the data from the source. Supported values for user event imports: `user_event` (default): One `UserEvent` per row. Supported values for document imports: `document` (default): One `Document` format per row. Each document must have a valid `Document.id` and one of `Document.json_data` or `Document.struct_data`. `custom`: One custom data per row in arbitrary format that conforms to the defined `Schema` of the data store. This can only be used by the GENERIC Data Store vertical.
Union field `partition`. BigQuery table partition info. Leave this empty if the BigQuery table is not partitioned. `partition` can be only one of the following:
`partition_date`	`Date` BigQuery time partitioned table's _PARTITIONDATE in YYYY-MM-DD format.

BigtableOptions

The Bigtable Options object that contains information to support the import.

Fields

key_field_name

string

The field name used for saving row key value in the document. The name has to match the pattern [a-zA-Z0-9][a-zA-Z0-9-_]*.

families

map<string, BigtableColumnFamily>

The mapping from family names to an object that contains column families level information for the given column family. If a family is not present in this map it will be ignored.

BigtableColumn

The column of the Bigtable.

Fields
`qualifier`	`bytes` Required. Qualifier of the column. If it cannot be decoded with utf-8, use a base-64 encoded string instead.
`field_name`	`string` The field name to use for this column in the document. The name has to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`. If not set, it is parsed from the qualifier bytes with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.
`encoding`	`Encoding` The encoding mode of the values when the type is not `STRING`. Acceptable encoding values are: `TEXT`: indicates values are alphanumeric text strings. `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.
`type`	`Type` The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.

BigtableColumnFamily

The column family of the Bigtable.

Fields
`field_name`	`string` The field name to use for this column family in the document. The name has to match the pattern `[a-zA-Z0-9][a-zA-Z0-9-_]*`. If not set, it is parsed from the family name with best effort. However, due to different naming patterns, field name collisions could happen, where parsing behavior is undefined.
`encoding`	`Encoding` The encoding mode of the values when the type is not STRING. Acceptable encoding values are: `TEXT`: indicates values are alphanumeric text strings. `BINARY`: indicates values are encoded using `HBase Bytes.toBytes` family of functions. This can be overridden for a specific column by listing that column in `columns` and specifying an encoding for it.
`type`	`Type` The type of values in this column family. The values are expected to be encoded using `HBase Bytes.toBytes` function when the encoding value is set to `BINARY`.
`columns[]`	`BigtableColumn` The list of objects that contains column level information for each column. If a column is not present in this list it will be ignored.

Encoding

The encoding mode of a Bigtable column or column family.

Enums
`ENCODING_UNSPECIFIED`	The encoding is unspecified.
`TEXT`	Text encoding.
`BINARY`	Binary encoding.

Type

The type of values in a Bigtable column or column family. The values are expected to be encoded using HBase Bytes.toBytes function when the encoding value is set to BINARY.

Enums
`TYPE_UNSPECIFIED`	The type is unspecified.
`STRING`	String type.
`NUMBER`	Numerical type.
`INTEGER`	Integer type.
`VAR_INTEGER`	Variable length integer type.
`BIG_NUMERIC`	BigDecimal type.
`BOOLEAN`	Boolean type.
`JSON`	JSON type.

BigtableSource

The Cloud Bigtable source for importing data.

Fields
`project_id`	`string` The project ID that the Bigtable source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
`instance_id`	`string` Required. The instance ID of the Cloud Bigtable that needs to be imported.
`table_id`	`string` Required. The table ID of the Cloud Bigtable that needs to be imported.
`bigtable_options`	`BigtableOptions` Required. Bigtable options that contains information needed when parsing data into typed structures. For example, column type annotations.

CheckGroundingRequest

Request message for GroundedGenerationService.CheckGrounding method.

Fields
`grounding_config`	`string` Required. The resource name of the grounding config, such as `projects/*/locations/global/groundingConfigs/default_grounding_config`.
`answer_candidate`	`string` Answer candidate to check. Can have a maximum length of 1024 characters.
`facts[]`	`GroundingFact` List of facts for the grounding check. We support up to 200 facts.
`grounding_spec`	`CheckGroundingSpec` Configuration of the grounding check.
`user_labels`	`map<string, string>` 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.

CheckGroundingResponse

Response message for the GroundedGenerationService.CheckGrounding method.

Fields

cited_chunks[]

FactChunk

List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request.

claims[]

Claim

Claim texts and citation info across all claims in the answer candidate.

support_score

float

The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned.

Claim

Text and citation info for a claim in the answer candidate.

Fields
`claim_text`	`string` Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found.
`citation_indices[]`	`int32` A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact.
`start_pos`	`int32` Position indicating the start of the claim in the answer candidate, measured in bytes.
`end_pos`	`int32` Position indicating the end of the claim in the answer candidate, exclusive.
`grounding_check_required`	`bool` Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore `citation_indices`, and `anti_citation_indices` should not be returned.

CheckGroundingSpec

Specification for the grounding check.

Fields

citation_threshold

double

The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6.

CloudSqlSource

Cloud SQL source import data from.

Fields
`project_id`	`string` The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
`instance_id`	`string` Required. The Cloud SQL instance to copy the data from with a length limit of 256 characters.
`database_id`	`string` Required. The Cloud SQL database to copy the data from with a length limit of 256 characters.
`table_id`	`string` Required. The Cloud SQL table to copy the data from with a length limit of 256 characters.
`gcs_staging_dir`	`string` Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Cloud SQL export to a specific Cloud Storage directory. Ensure that the Cloud SQL service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.
`offload`	`bool` Option for serverless export. Enabling this option will incur additional cost. More info can be found here.

CollectUserEventRequest

Request message for CollectUserEvent method.

Fields
`parent`	`string` Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
`user_event`	`string` Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
`uri`	`string` The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers only send the domain for third-party requests.
`ets`	`int64` The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.

CompleteQueryRequest

Request message for CompletionService.CompleteQuery method.

Fields
`data_store`	`string` Required. The parent data store resource name for which the completion is performed, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
`query`	`string` Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters.
`query_model`	`string` Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: `document` - Using suggestions generated from user-imported documents. `search-history` - Using suggestions generated from the past history of `SearchService.Search` API calls. Do not use it when there is no traffic for Search API. `user-event` - Using suggestions generated from user-imported search events. `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: `document` is the default model for regular dataStores. `search-history` is the default model for site search dataStores.
`user_pseudo_id`	`string` A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as `UserEvent.user_pseudo_id` and `SearchRequest.user_pseudo_id`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
`include_tail_suggestions`	`bool` Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned.

CompleteQueryResponse

Response message for CompletionService.CompleteQuery method.

Fields

query_suggestions[]

QuerySuggestion

Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion.

tail_match_triggered

bool

True if the returned suggestions are all tail suggestions.

For tail matching to be triggered, include_tail_suggestions in the request must be true and there must be no suggestions that match the full query.

QuerySuggestion

Suggestions as search queries.

Fields

suggestion

string

The suggestion for the query.

completable_field_paths[]

string

The unique document field paths that serve as the source of this suggestion if it was generated from completable fields.

This field is only populated for the document-completable model.

CompletionInfo

Detailed completion information including completion attribution token and clicked completion info.

Fields

selected_suggestion

string

End user selected CompleteQueryResponse.QuerySuggestion.suggestion.

selected_position

int32

End user selected CompleteQueryResponse.QuerySuggestion.suggestion position, starting from 0.

Conversation

External conversation proto definition.

Fields
`name`	`string` Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore//conversations/` or `projects/{project}/locations/global/collections/{collection}/engines//conversations/`.
`state`	`State` The state of the Conversation.
`user_pseudo_id`	`string` A unique identifier for tracking users.
`messages[]`	`ConversationMessage` Conversation messages.
`start_time`	`Timestamp` Output only. The time the conversation started.
`end_time`	`Timestamp` Output only. The time the conversation finished.

State

Enumeration of the state of the conversation.

Enums
`STATE_UNSPECIFIED`	Unknown.
`IN_PROGRESS`	Conversation is currently open.
`COMPLETED`	Conversation has been completed.

ConversationContext

Defines context of the conversation

Fields

context_documents[]

string

The current list of documents the user is seeing. It contains the document resource references.

active_document

string

The current active document the user opened. It contains the document resource reference.

ConversationMessage

Defines a conversation message.

Fields
`create_time`	`Timestamp` Output only. Message creation timestamp.
Union field `message`. `message` can be only one of the following:
`user_input`	`TextInput` User text input.
`reply`	`Reply` Search reply.

ConverseConversationRequest

Request message for ConversationalSearchService.ConverseConversation method.

Fields
`name`	`string` Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
`query`	`TextInput` Required. Current user input.
`serving_config`	`string` The resource name of the Serving Config to use. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.
`conversation`	`Conversation` The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
`safe_search`	`bool` Whether to turn on safe search.
`user_labels`	`map<string, string>` 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.
`summary_spec`	`SummarySpec` A specification for configuring the summary returned in the response.
`filter`	`string` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see Filter
`boost_spec`	`BoostSpec` Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see Boosting

ConverseConversationResponse

Response message for ConversationalSearchService.ConverseConversation method.

Fields

reply

Reply

Answer to the current query.

conversation

Updated conversation including the answer.

search_results[]

SearchResult

Search Results.

CreateConversationRequest

Request for CreateConversation method.

Fields

parent

string

Required. Full resource name of parent data store. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}

conversation

Required. The conversation to create.

CreateDataStoreMetadata

Metadata related to the progress of the DataStoreService.CreateDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Fields

create_time

Operation create time.

update_time

Operation last update time. If the operation is done, this is also the finish time.

CreateDataStoreRequest

Request for DataStoreService.CreateDataStore method.

Fields
`parent`	`string` Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`.
`data_store`	`DataStore` Required. The `DataStore` to create.
`data_store_id`	`string` Required. The ID to use for the `DataStore`, which will become the final component of the `DataStore`'s resource name. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.
`create_advanced_site_search`	`bool` A boolean flag indicating whether user want to directly create an advanced data store for site search. If the data store is not configured as site search (GENERIC vertical and PUBLIC_WEBSITE content_config), this flag will be ignored.

CreateDocumentRequest

Request message for DocumentService.CreateDocument method.

Fields

parent

string

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

document

Required. The Document to create.

document_id

string

Required. The ID to use for the Document, which will become the final component of the Document.name.

If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

CreateEngineMetadata

Metadata related to the progress of the EngineService.CreateEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Fields

create_time

Operation create time.

update_time

Operation last update time. If the operation is done, this is also the finish time.

CreateEngineRequest

Request for EngineService.CreateEngine method.

Fields

parent

string

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}.

engine

Engine

Required. The Engine to create.

engine_id

string

Required. The ID to use for the Engine, which will become the final component of the Engine's resource name.

This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned.

CreateSchemaMetadata

Metadata for Create Schema LRO.

Fields

create_time

Operation create time.

update_time

Operation last update time. If the operation is done, this is also the finish time.

CreateSchemaRequest

Request message for SchemaService.CreateSchema method.

Fields

parent

string

Required. The parent data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

schema

Schema

Required. The Schema to create.

schema_id

string

Required. The ID to use for the Schema, which will become the final component of the Schema.name.

This field should conform to RFC-1034 standard with a length limit of 63 characters.

CreateTargetSiteMetadata

Metadata related to the progress of the SiteSearchEngineService.CreateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Fields

create_time

Operation create time.

update_time

Operation last update time. If the operation is done, this is also the finish time.

CreateTargetSiteRequest

Request message for SiteSearchEngineService.CreateTargetSite method.

Fields

parent

string

Required. Parent resource name of TargetSite, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

target_site

Required. The TargetSite to create.

CustomAttribute

A custom attribute that is not explicitly modeled in a resource, e.g. UserEvent.

Fields

text[]

string

The textual values of this custom attribute. For example, ["yellow", "green"] when the key is "color".

Empty string is not allowed. Otherwise, an INVALID_ARGUMENT error is returned.

Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.

numbers[]

double

The numerical values of this custom attribute. For example, [2.3, 15.4] when the key is "lengths_cm".

Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an INVALID_ARGUMENT error is returned.

DataStore

DataStore captures global settings and configs at the DataStore level.

Fields
`name`	`string` Immutable. The full resource name of the data store. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
`display_name`	`string` Required. The data store display name. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
`industry_vertical`	`IndustryVertical` Immutable. The industry vertical that the data store registers.
`solution_types[]`	`SolutionType` The solutions that the data store enrolls. Available solutions for each `industry_vertical`: `MEDIA`: `SOLUTION_TYPE_RECOMMENDATION` and `SOLUTION_TYPE_SEARCH`. `SITE_SEARCH`: `SOLUTION_TYPE_SEARCH` is automatically enrolled. Other solutions cannot be enrolled.
`default_schema_id`	`string` Output only. The id of the default `Schema` asscociated to this data store.
`content_config`	`ContentConfig` Immutable. The content config of the data store. If this field is unset, the server behavior defaults to `ContentConfig.NO_CONTENT`.
`create_time`	`Timestamp` Output only. Timestamp the `DataStore` was created at.
`document_processing_config`	`DocumentProcessingConfig` Configuration for Document understanding and enrichment.
`starting_schema`	`Schema` The start schema to use for this `DataStore` when provisioning it. If unset, a default vertical specialized schema will be used. This field is only used by [CreateDataStore][] API, and will be ignored if used in other APIs. This field will be omitted from all API responses including [CreateDataStore][] API. To retrieve a schema of a `DataStore`, use `SchemaService.GetSchema` API instead. The provided schema will be validated against certain rules on schema. Learn more from this doc.

ContentConfig

Content config of the data store.

Enums
`CONTENT_CONFIG_UNSPECIFIED`	Default value.
`NO_CONTENT`	Only contains documents without any `Document.content`.
`CONTENT_REQUIRED`	Only contains documents with `Document.content`.
`PUBLIC_WEBSITE`	The data store is used for public website search.

DeleteConversationRequest

Request for DeleteConversation method.

Fields

name

string

Required. The resource name of the Conversation to delete. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

DeleteDataStoreMetadata

Metadata related to the progress of the DataStoreService.DeleteDataStore operation. This will be returned by the google.longrunning.Operation.metadata field.

Fields

create_time

Operation create time.

update_time

Operation last update time. If the operation is done, this is also the finish time.

DeleteDataStoreRequest

Request message for DataStoreService.DeleteDataStore method.

Fields

name

string

Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

If the caller does not have permission to delete the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the DataStore to delete does not exist, a NOT_FOUND error is returned.

DeleteDocumentRequest

Request message for DocumentService.DeleteDocument method.

Fields

name

string

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the Document to delete does not exist, a NOT_FOUND error is returned.

DeleteEngineMetadata

Metadata related to the progress of the EngineService.DeleteEngine operation. This will be returned by the google.longrunning.Operation.metadata field.

Fields

create_time

Operation create time.

update_time

Operation last update time. If the operation is done, this is also the finish time.

DeleteEngineRequest

Request message for EngineService.DeleteEngine method.

Fields

name

string

Required. Full resource name of Engine, such as projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the Engine to delete does not exist, a NOT_FOUND error is returned.

DeleteSchemaMetadata

Metadata for DeleteSchema LRO.

Fields

create_time

Operation create time.

update_time

Operation last update time. If the operation is done, this is also the finish time.

DeleteSchemaRequest

Request message for SchemaService.DeleteSchema method.

Fields

name

string

Required. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

DeleteTargetSiteMetadata

Metadata related to the progress of the SiteSearchEngineService.DeleteTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Fields

create_time

Operation create time.

update_time

Operation last update time. If the operation is done, this is also the finish time.

DeleteTargetSiteRequest

Request message for SiteSearchEngineService.DeleteTargetSite method.

Fields

name

string

Required. Full resource name of TargetSite, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}.

If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested TargetSite does not exist, a NOT_FOUND error is returned.

DisableAdvancedSiteSearchMetadata

Metadata related to the progress of the SiteSearchEngineService.DisableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Fields

create_time

Operation create time.

update_time

Operation last update time. If the operation is done, this is also the finish time.

DisableAdvancedSiteSearchRequest

Request message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

Fields

site_search_engine

string

Required. Full resource name of the SiteSearchEngine, such as projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine.

DisableAdvancedSiteSearchResponse

This type has no fields.

Response message for SiteSearchEngineService.DisableAdvancedSiteSearch method.

Document

Document captures all raw metadata information of items to be recommended or searched.

Fields
`name`	`string` Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
`id`	`string` Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 63 characters.
`schema_id`	`string` The identifier of the schema located in the same data store.
`content`	`Content` The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
`parent_document_id`	`string` The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to RFC-1034 standard with a length limit of 63 characters.
`derived_struct_data`	`Struct` Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
`index_time`	`Timestamp` Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.
Union field `data`. Data representation. One of `struct_data` or `json_data` should be provided otherwise an `INVALID_ARGUMENT` error is thrown. `data` can be only one of the following:
`struct_data`	`Struct` The structured JSON data for the document. It should conform to the registered `Schema` or an `INVALID_ARGUMENT` error is thrown.
`json_data`	`string` The JSON string representation of the document. It should conform to the registered `Schema` or an `INVALID_ARGUMENT` error is thrown.

Content

Unstructured data linked to this document.

Fields
`mime_type`	`string` The MIME type of the content. Supported types: `application/pdf` (PDF, only native PDFs are supported for now) `text/html` (HTML) `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
Union field `content`. `content` can be only one of the following:
`raw_bytes`	`bytes` The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
`uri`	`string` The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 100 MB for other formats.

DocumentInfo

Detailed document information associated with a user event.

Fields
`promotion_ids[]`	`string` The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID.
Union field `document_descriptor`. A required descriptor of the associated `Document`. If `id` is specified, then the default values for `{location}`, `{collection_id}`, `{data_store_id}`, and `{branch_id}` are used when annotating with the stored Document. If `name` is specified, then the provided values (default values allowed) for `{location}`, `{collection_id}`, `{data_store_id}`, and `{branch_id}` are used when annotating with the stored Document. `document_descriptor` can be only one of the following:
`id`	`string` The `Document` resource ID.
`name`	`string` The `Document` resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}`
`uri`	`string` The `Document` URI - only allowed for website data stores.
`quantity`	`int32` Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: `add-to-cart` `purchase`

DocumentProcessingConfig

A singleton resource of DataStore. It's empty when DataStore is created, which defaults to digital parser. The first call to [DataStoreService.UpdateDocumentProcessingConfig][] method will initialize the config.

Fields

name

string

The full resource name of the Document Processing Config. Format: projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig.

default_parsing_config

ParsingConfig

Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing.

parsing_config_overrides

map<string, ParsingConfig>

Map from file type to override the default parsing configuration based on the file type. Supported keys:

pdf: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported.
html: Override parsing config for HTML files, only digital parsing and or layout parsing are supported.
docx: Override parsing config for DOCX files, only digital parsing and or layout parsing are supported.

ParsingConfig

Related configurations applied to a specific type of document parser.

Fields

Union field type_dedicated_config. Configs for document processing types. type_dedicated_config can be only one of the following:

digital_parsing_config

DigitalParsingConfig

Configurations applied to digital parser.

ocr_parsing_config

OcrParsingConfig

Configurations applied to OCR parser. Currently it only applies to PDFs.

DigitalParsingConfig

This type has no fields.

The digital parsing configurations for documents.

OcrParsingConfig

The OCR parsing configurations for documents.

Fields

enhanced_document_elements[]
(deprecated)

string

[DEPRECATED] This field is deprecated. To use the additional enhanced document elements processing, please switch to layout_parsing_config.

use_native_text

bool

If true, will use native text instead of OCR text on pages containing native text.

EnableAdvancedSiteSearchMetadata

Metadata related to the progress of the SiteSearchEngineService.EnableAdvancedSiteSearch operation. This will be returned by the google.longrunning.Operation.metadata field.

Fields

create_time

Operation create time.

update_time

Operation last update time. If the operation is done, this is also the finish time.

EnableAdvancedSiteSearchRequest

Request message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Fields

site_search_engine

string

Required. Full resource name of the SiteSearchEngine, such as projects/{project}/locations/{location}/dataStores/{data_store_id}/siteSearchEngine.

EnableAdvancedSiteSearchResponse

This type has no fields.

Response message for SiteSearchEngineService.EnableAdvancedSiteSearch method.

Engine

Metadata that describes the training and serving parameters of an Engine.

Fields
`name`	`string` Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
`display_name`	`string` Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters.
`create_time`	`Timestamp` Output only. Timestamp the Recommendation Engine was created at.
`update_time`	`Timestamp` Output only. Timestamp the Recommendation Engine was last updated.
`data_store_ids[]`	`string` The data stores associated with this engine. For `SOLUTION_TYPE_SEARCH` and `SOLUTION_TYPE_RECOMMENDATION` type of engines, they can only associate with at most one data store. If `solution_type` is `SOLUTION_TYPE_CHAT`, multiple `DataStore`s in the same `Collection` can be associated here. Note that when used in `CreateEngineRequest`, one DataStore id must be provided as the system will use it for necessary initializations.
`solution_type`	`SolutionType` Required. The solutions of the engine.
`industry_vertical`	`IndustryVertical` The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on `DataStore`: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine.
`common_config`	`CommonConfig` Common config spec that specifies the metadata of the engine.
Union field `engine_config`. Additional config specs that defines the behavior of the engine. `engine_config` can be only one of the following:
`chat_engine_config`	`ChatEngineConfig` Configurations for the Chat Engine. Only applicable if `solution_type` is `SOLUTION_TYPE_CHAT`.
`search_engine_config`	`SearchEngineConfig` Configurations for the Search Engine. Only applicable if `solution_type` is `SOLUTION_TYPE_SEARCH`.
Union field `engine_metadata`. Engine metadata to monitor the status of the engine. `engine_metadata` can be only one of the following:
`chat_engine_metadata`	`ChatEngineMetadata` Output only. Additional information of the Chat Engine. Only applicable if `solution_type` is `SOLUTION_TYPE_CHAT`.

ChatEngineConfig

Configurations for a Chat Engine.

Fields

agent_creation_config

AgentCreationConfig

The configurationt generate the Dialogflow agent that is associated to this Engine.

Note that these configurations are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation.

dialogflow_agent_to_link

string

The resource name of an exist Dialogflow agent to link to this Chat Engine. Customers can either provide agent_creation_config to create agent or provide an agent name that links the agent with the Chat engine.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

Note that the dialogflow_agent_to_link are one-time consumed by and passed to Dialogflow service. It means they cannot be retrieved using EngineService.GetEngine or EngineService.ListEngines API after engine creation. Use ChatEngineMetadata.dialogflow_agent for actual agent association after Engine is created.

AgentCreationConfig

Configurations for generating a Dialogflow agent.

Fields
`business`	`string` Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search.
`default_language_code`	`string` Required. The default language of the agent as a language tag. See Language Support for a list of the currently supported language codes.
`time_zone`	`string` Required. The time zone of the agent from the time zone database, e.g., America/New_York, Europe/Paris.
`location`	`string` Agent location for Agent creation, supported values: global/us/eu. If not provided, us Engine will create Agent using us-central-1 by default; eu Engine will create Agent using eu-west-1 by default.

ChatEngineMetadata

Additional information of a Chat Engine. Fields in this message are output only.

Fields

dialogflow_agent

string

The resource name of a Dialogflow agent, that this Chat Engine refers to.

Format: projects/<Project ID>/locations/<Location ID>/agents/<Agent ID>.

CommonConfig

Common configurations for an Engine.

Fields

company_name

string

Immutable. The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features.

SearchEngineConfig

Configurations for a Search Engine.

Fields

search_tier

SearchTier

The search feature tier of this engine.

Different tiers might have different pricing. To learn more, check the pricing documentation.

Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified.

search_add_ons[]

SearchAddOn

The add-on that this search engine enables.

FactChunk

Fact Chunk.

Fields
`chunk_text`	`string` Text content of the fact chunk. Can be at most 10K characters long.
`source`	`string` Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved.
`index`	`int32` The index of this chunk. Currently, only used for the streaming mode.
`source_metadata`	`map<string, string>` More fine-grained information for the source reference.

FetchDomainVerificationStatusRequest

Request message for SiteSearchEngineService.FetchDomainVerificationStatus method.

Fields

site_search_engine

string

Required. The site search engine resource under which we fetch all the domain verification status. projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

page_size

int32

Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

page_token

string

A page token, received from a previous FetchDomainVerificationStatus call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to FetchDomainVerificationStatus must match the call that provided the page token.

FetchDomainVerificationStatusResponse

Response message for SiteSearchEngineService.FetchDomainVerificationStatus method.

Fields

target_sites[]

List of TargetSites containing the site verification status.

next_page_token

string

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_size

int32

The total number of items matching the request. This will always be populated in the response.

FhirStoreSource

Cloud FhirStore source import data from.

Fields

fhir_store

string

Required. The full resource name of the FHIR store to import data from, in the format of projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}.

gcs_staging_dir

string

Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory.

FirestoreSource

Firestore source import data from.

Fields
`project_id`	`string` The project ID that the Cloud SQL source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
`database_id`	`string` Required. The Firestore database to copy the data from with a length limit of 256 characters.
`collection_id`	`string` Required. The Firestore collection to copy the data from with a length limit of 1,500 characters.
`gcs_staging_dir`	`string` Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the Firestore export to a specific Cloud Storage directory. Ensure that the Firestore service account has the necessary Cloud Storage Admin permissions to access the specified Cloud Storage directory.

GcsSource

Cloud Storage location for input content.

Fields

input_uris[]

string

Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, gs://bucket/directory/object.json) or a pattern matching one or more files, such as gs://bucket/directory/*.json.

A request can contain at most 100 files (or 100,000 files if data_schema is content). Each file can be up to 2 GB (or 100 MB if data_schema is content).

data_schema

string

The schema to use when parsing the data from the source.

Supported values for document imports:

document (default): One JSON Document per line. Each document must have a valid Document.id.
content: Unstructured data (e.g. PDF, HTML). Each file matched by input_uris becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string.
custom: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical.
csv: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical.

Supported values for user even imports:

user_event (default): One JSON UserEvent per line.

GetConversationRequest

Request for GetConversation method.

Fields

name

string

Required. The resource name of the Conversation to get. Format: projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}

GetDataStoreRequest

Request message for DataStoreService.GetDataStore method.

Fields

name

string

Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

If the caller does not have permission to access the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested DataStore does not exist, a NOT_FOUND error is returned.

GetDocumentRequest

Request message for DocumentService.GetDocument method.

Fields

name

string

Required. Full resource name of Document, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}.

If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested Document does not exist, a NOT_FOUND error is returned.

GetEngineRequest

Request message for EngineService.GetEngine method.

Fields

name

string

Required. Full resource name of Engine, such as projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}.

GetSchemaRequest

Request message for SchemaService.GetSchema method.

Fields

name

string

Required. The full resource name of the schema, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}.

GetSiteSearchEngineRequest

Request message for SiteSearchEngineService.GetSiteSearchEngine method.

Fields

name

string

Required. Resource name of SiteSearchEngine, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

If the caller does not have permission to access the [SiteSearchEngine], regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

GetTargetSiteRequest

Request message for SiteSearchEngineService.GetTargetSite method.

Fields

name

string

Required. Full resource name of TargetSite, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}.

If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the requested TargetSite does not exist, a NOT_FOUND error is returned.

GroundingFact

Grounding Fact.

Fields

fact_text

string

Text content of the fact. Can be at most 10K characters long.

attributes

map<string, string>

Attributes associated with the fact. Common attributes include source (indicating where the fact was sourced from), author (indicating the author of the fact), and so on.

ImportDocumentsMetadata

Metadata related to the progress of the ImportDocuments operation. This is returned by the google.longrunning.Operation.metadata field.

Fields
`create_time`	`Timestamp` Operation create time.
`update_time`	`Timestamp` Operation last update time. If the operation is done, this is also the finish time.
`success_count`	`int64` Count of entries that were processed successfully.
`failure_count`	`int64` Count of entries that encountered errors while processing.
`total_count`	`int64` Total count of entries that were processed.

ImportDocumentsRequest

Request message for Import methods.

Fields
`parent`	`string` Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission.
`error_config`	`ImportErrorConfig` The desired location of errors incurred during the Import.
`reconciliation_mode`	`ReconciliationMode` The mode of reconciliation between existing documents and the documents to be imported. Defaults to `ReconciliationMode.INCREMENTAL`.
`update_mask`	`FieldMask` Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields.
`auto_generate_ids`	`bool` Whether to automatically generate IDs for the documents if absent. If set to `true`, `Document.id`s are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case `ReconciliationMode.FULL` is highly recommended to avoid duplicate contents. If unset or set to `false`, `Document.id`s have to be specified using `id_field`, otherwise, documents without IDs fail to be imported. Supported data sources: `GcsSource`. `GcsSource.data_schema` must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. `BigQuerySource`. `BigQuerySource.data_schema` must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. `SpannerSource`. `CloudSqlSource`. `FirestoreSource`. `BigtableSource`.
`id_field`	`string` The field indicates the ID field or column to be used as unique IDs of the documents. For `GcsSource` it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the `Document.id`s. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to RFC-1034 with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when `auto_generate_ids` is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: `GcsSource`. `GcsSource.data_schema` must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. `BigQuerySource`. `BigQuerySource.data_schema` must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. `SpannerSource`. `CloudSqlSource`. `FirestoreSource`. `BigtableSource`.
Union field `source`. Required. The source of the input. `source` can be only one of the following:
`inline_source`	`InlineSource` The Inline source for the input content for documents.
`gcs_source`	`GcsSource` Cloud Storage location for the input content.
`bigquery_source`	`BigQuerySource` BigQuery input source.
`fhir_store_source`	`FhirStoreSource` FhirStore input source.
`spanner_source`	`SpannerSource` Spanner input source.
`cloud_sql_source`	`CloudSqlSource` Cloud SQL input source.
`firestore_source`	`FirestoreSource` Firestore input source.
`bigtable_source`	`BigtableSource` Cloud Bigtable input source.

InlineSource

The inline source for the input config for ImportDocuments method.

Fields

documents[]

Required. A list of documents to update/create. Each document must have a valid Document.id. Recommended max of 100 items.

ReconciliationMode

Indicates how imported documents are reconciled with the existing documents created or imported before.

Enums
`RECONCILIATION_MODE_UNSPECIFIED`	Defaults to `INCREMENTAL`.
`INCREMENTAL`	Inserts new documents or updates existing documents.
`FULL`	Calculates diff and replaces the entire document dataset. Existing documents may be deleted if they are not present in the source location.

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.

Fields

error_samples[]

Status

A sample of errors encountered while processing the request.

error_config

ImportErrorConfig

Echoes the destination for the complete errors in the request if set.

ImportErrorConfig

Configuration of destination for Import related errors.

Fields

Union field destination. Required. Errors destination. destination can be only one of the following:

gcs_prefix

string

Cloud Storage prefix for import errors. This must be an empty, existing Cloud Storage directory. Import errors are written to sharded files in this directory, one per line, as a JSON-encoded google.rpc.Status message.

ImportSuggestionDenyListEntriesMetadata

Metadata related to the progress of the ImportSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Fields

create_time

Operation create time.

update_time

SuggestionDenyListEntry

Operation last update time. If the operation is done, this is also the finish time.

ImportSuggestionDenyListEntriesRequest

Request message for CompletionService.ImportSuggestionDenyListEntries method.

Fields
`parent`	`string` Required. The parent data store resource name for which to import denylist entries. Follows pattern projects//locations//collections//dataStores/.
Union field `source`. The source of the updated SuggestionDenyList. `source` can be only one of the following:
`inline_source`	`InlineSource` The Inline source for the input content for suggestion deny list entries.
`gcs_source`	`GcsSource` Cloud Storage location for the input content. Only 1 file can be specified that contains all entries to import. Supported values `gcs_source.schema` for autocomplete suggestion deny list entry imports: `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry] per line.

InlineSource

The inline source for SuggestionDenyListEntry.

Fields

entries[]

Required. A list of all denylist entries to import. Max of 1000 items.

ImportSuggestionDenyListEntriesResponse

Response message for CompletionService.ImportSuggestionDenyListEntries method.

Fields

error_samples[]

Status

A sample of errors encountered while processing the request.

imported_entries_count

int64

Count of deny list entries successfully imported.

failed_entries_count

int64

Count of deny list entries that failed to be imported.

ImportUserEventsMetadata

Metadata related to the progress of the Import operation. This is returned by the google.longrunning.Operation.metadata field.

Fields
`create_time`	`Timestamp` Operation create time.
`update_time`	`Timestamp` Operation last update time. If the operation is done, this is also the finish time.
`success_count`	`int64` Count of entries that were processed successfully.
`failure_count`	`int64` Count of entries that encountered errors while processing.

ImportUserEventsRequest

Request message for the ImportUserEvents request.

Fields
`parent`	`string` Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`
`error_config`	`ImportErrorConfig` The desired location of errors incurred during the Import. Cannot be set for inline user event imports.
Union field `source`. Required - The desired input source of the user event data. `source` can be only one of the following:
`inline_source`	`InlineSource` The Inline source for the input content for UserEvents.
`gcs_source`	`GcsSource` Cloud Storage location for the input content.
`bigquery_source`	`BigQuerySource` BigQuery input source.

InlineSource

The inline source for the input config for ImportUserEvents method.

Fields

user_events[]

UserEvent

Required. A list of user events to import. Recommended max of 10k items.

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.

Fields
`error_samples[]`	`Status` A sample of errors encountered while processing the request.
`error_config`	`ImportErrorConfig` Echoes the destination for the complete errors if this field was set in the request.
`joined_events_count`	`int64` Count of user events imported with complete existing Documents.
`unjoined_events_count`	`int64` Count of user events imported, but with Document information not found in the existing Branch.

IndustryVertical

The industry vertical associated with the DataStore.

Enums
`INDUSTRY_VERTICAL_UNSPECIFIED`	Value used when unset.
`GENERIC`	The generic vertical for documents that are not specific to any industry vertical.
`MEDIA`	The media industry vertical.
`HEALTHCARE_FHIR`	The healthcare FHIR vertical.

Interval

A floating point interval.

Fields

Union field min. The lower bound of the interval. If neither of the min fields are set, then the lower bound is negative infinity.

This field must be not larger than max. Otherwise, an INVALID_ARGUMENT error is returned. min can be only one of the following:

minimum

double

Inclusive lower bound.

exclusive_minimum

double

Exclusive lower bound.

Union field max. The upper bound of the interval. If neither of the max fields are set, then the upper bound is positive infinity.

This field must be not smaller than min. Otherwise, an INVALID_ARGUMENT error is returned. max can be only one of the following:

maximum

double

Inclusive upper bound.

exclusive_maximum

double

Exclusive upper bound.

ListConversationsRequest

Request for ListConversations method.

Fields
`parent`	`string` Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}`
`page_size`	`int32` Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
`page_token`	`string` A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.
`filter`	`string` A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
`order_by`	`string` A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time"

ListConversationsResponse

Response for ListConversations method.

Fields

conversations[]

All the Conversations for a given data store.

next_page_token

string

Pagination token, if not returned indicates the last page.

ListDataStoresRequest

Request message for DataStoreService.ListDataStores method.

Fields
`parent`	`string` Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. If the caller does not have permission to list `DataStore`s under this location, regardless of whether or not this data store exists, a PERMISSION_DENIED error is returned.
`page_size`	`int32` Maximum number of `DataStore`s to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned.
`page_token`	`string` A page token `ListDataStoresResponse.next_page_token`, received from a previous `DataStoreService.ListDataStores` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `DataStoreService.ListDataStores` must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
`filter`	`string` Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH'

ListDataStoresResponse

Response message for DataStoreService.ListDataStores method.

Fields

data_stores[]

DataStore

All the customer's DataStores.

next_page_token

string

A token that can be sent as ListDataStoresRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListDocumentsRequest

Request message for DocumentService.ListDocuments method.

Fields

parent

string

Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Use default_branch as the branch ID, to list documents under the default branch.

If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

page_size

int32

Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

page_token

string

A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

ListDocumentsResponse

Response message for DocumentService.ListDocuments method.

Fields

documents[]

The Documents.

next_page_token

string

A token that can be sent as ListDocumentsRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListEnginesRequest

Request message for EngineService.ListEngines method.

Fields
`parent`	`string` Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`.
`page_size`	`int32` Optional. Not supported.
`page_token`	`string` Optional. Not supported.
`filter`	`string` Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH

ListEnginesResponse

Response message for EngineService.ListEngines method.

Fields

engines[]

Engine

All the customer's Engines.

next_page_token

string

Not supported.

ListSchemasRequest

Request message for SchemaService.ListSchemas method.

Fields

parent

string

Required. The parent data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

page_size

int32

The maximum number of Schemas to return. The service may return fewer than this value.

If unspecified, at most 100 Schemas will be returned.

The maximum value is 1000; values above 1000 will be coerced to 1000.

page_token

string

A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.

ListSchemasResponse

Response message for SchemaService.ListSchemas method.

Fields

schemas[]

Schema

The Schemas.

next_page_token

string

A token that can be sent as ListSchemasRequest.page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

ListTargetSitesRequest

Request message for SiteSearchEngineService.ListTargetSites method.

Fields

parent

string

Required. The parent site search engine resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine.

If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.

page_size

int32

Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

page_token

string

A page token, received from a previous ListTargetSites call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListTargetSites must match the call that provided the page token.

ListTargetSitesResponse

Response message for SiteSearchEngineService.ListTargetSites method.

Fields

target_sites[]

List of TargetSites.

next_page_token

string

A token that can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

total_size

int32

The total number of items matching the request. This will always be populated in the response.

MediaInfo

Media-specific user event information.

Fields

media_progress_duration

Duration

The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90.

media_progress_percentage

float

Media progress should be computed using only the media_progress_duration relative to the media total length.

This value must be between [0, 1.0] inclusive.

If this is not a playback or the progress cannot be computed (e.g. ongoing livestream), this field should be unset.

PageInfo

Detailed page information.

Fields
`pageview_id`	`string` A unique ID of a web page view. This should be kept the same for all user events triggered from the same pageview. For example, an item detail page view could trigger multiple events as the user is browsing the page. The `pageview_id` property should be kept the same for all these events so that they can be grouped together properly. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically.
`page_category`	`string` The most specific category associated with a category page. To represent full path of category, use '>' sign to separate different hierarchies. If '>' is part of the category name, replace it with other character(s). Category pages include special pages such as sales or promotions. For instance, a special sale page may have the category hierarchy: `"pageCategory" : "Sales > 2017 Black Friday Deals"`. Required for `view-category-page` events. Other event types should not set this field. Otherwise, an `INVALID_ARGUMENT` error is returned.
`uri`	`string` Complete URL (window.location.href) of the user's current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. Maximum length 5,000 characters.
`referrer_uri`	`string` The referrer URL of the current page. When using the client side event reporting with JavaScript pixel and Google Tag Manager, this value is filled in automatically. However, some browser privacy restrictions may cause this field to be empty.

PanelInfo

Detailed panel information associated with a user event.

Fields
`panel_id`	`string` Required. The panel ID.
`display_name`	`string` The display name of the panel.
`panel_position`	`int32` The ordered position of the panel, if shown to the user with other panels. If set, then `total_panels` must also be set.
`total_panels`	`int32` The total number of panels, including this one, shown to the user. Must be set if `panel_position` is set.

PurgeDocumentsMetadata

Metadata related to the progress of the PurgeDocuments operation. This will be returned by the google.longrunning.Operation.metadata field.

Fields
`create_time`	`Timestamp` Operation create time.
`update_time`	`Timestamp` Operation last update time. If the operation is done, this is also the finish time.
`success_count`	`int64` Count of entries that were deleted successfully.
`failure_count`	`int64` Count of entries that encountered errors while processing.
`ignored_count`	`int64` Count of entries that were ignored as entries were not found.

PurgeDocumentsRequest

Request message for DocumentService.PurgeDocuments method.

Fields

parent

string

Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.

filter

string

Required. Filter matching documents to purge. Only currently supported value is * (all items).

force

bool

Actually performs the purge. If force is set to false, return the expected purge count without deleting any documents.

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.

Fields

purge_count

int64

The total count of documents purged as a result of the operation.

purge_sample[]

string

A sample of document names that will be deleted. Only populated if force is set to false. A max of 100 names will be returned and the names are chosen at random.

PurgeSuggestionDenyListEntriesMetadata

Metadata related to the progress of the PurgeSuggestionDenyListEntries operation. This is returned by the google.longrunning.Operation.metadata field.

Fields

create_time

Operation create time.

update_time

Operation last update time. If the operation is done, this is also the finish time.

PurgeSuggestionDenyListEntriesRequest

Request message for CompletionService.PurgeSuggestionDenyListEntries method.

Fields

parent

string

Required. The parent data store resource name for which to import denylist entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.

PurgeSuggestionDenyListEntriesResponse

Response message for CompletionService.PurgeSuggestionDenyListEntries method.

Fields

purge_count

int64

Number of suggestion deny list entries purged.

error_samples[]

Status

A sample of errors encountered while processing the request.

RecommendRequest

Request message for Recommend method.

Fields
`serving_config`	`string` Required. Full resource name of a [ServingConfig][]: `projects//locations/global/collections//engines//servingConfigs/`, or `projects//locations/global/collections//dataStores//servingConfigs/` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects//locations/global/collections//engines/my-engine`, you can use `projects//locations/global/collections//engines/my-engine/servingConfigs/my-engine` for your `RecommendationService.Recommend` requests.
`user_event`	`UserEvent` Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set `UserEvent.user_pseudo_id` or `UserEvent.user_info.user_id` to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set `UserEvent.user_pseudo_id` to a random unique ID and leave `UserEvent.user_info.user_id` unset.
`page_size`	`int32` Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100.
`filter`	`string` Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in `RecommendRequest.params` to receive empty results instead. Note that the API will never return `Document`s with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
`validate_only`	`bool` Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready.
`params`	`map<string, Value>` Additional domain specific parameters for the recommendations. Allowed values: `returnDocument`: Boolean. If set to true, the associated Document object will be returned in `RecommendResponse.RecommendationResult.document`. `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in `RecommendResponse.RecommendationResult.metadata`. The given 'score' indicates the probability of a Document conversion given the user's context and history. `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: `no-diversity` `low-diversity` `medium-diversity` `high-diversity` `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax.
`user_labels`	`map<string, string>` 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 Requirements for labels for more details.

RecommendResponse

Response message for Recommend method.

Fields
`results[]`	`RecommendationResult` A list of recommended Documents. The order represents the ranking (from the most relevant Document to the least).
`attribution_token`	`string` A unique attribution token. This should be included in the `UserEvent` logs resulting from this recommendation, which enables accurate attribution of recommendation model performance.
`missing_ids[]`	`string` IDs of documents in the request that were missing from the default Branch associated with the requested ServingConfig.
`validate_only`	`bool` True if `RecommendRequest.validate_only` was set.

RecommendationResult

RecommendationResult represents a generic recommendation result with associated metadata.

Fields

id

string

Resource ID of the recommended Document.

document

Set if returnDocument is set to true in RecommendRequest.params.

metadata

map<string, Value>

Additional Document metadata / annotations.

Possible values:

score: Recommendation score in double value. Is set if returnScore is set to true in RecommendRequest.params.

RecrawlUrisMetadata

Metadata related to the progress of the SiteSearchEngineService.RecrawlUris operation. This will be returned by the google.longrunning.Operation.metadata field.

Fields
`create_time`	`Timestamp` Operation create time.
`update_time`	`Timestamp` Operation last update time. If the operation is done, this is also the finish time.
`invalid_uris[]`	`string` Unique URIs in the request that don't match any TargetSite in the DataStore, only match TargetSites that haven't been fully indexed, or match a TargetSite with type EXCLUDE.
`valid_uris_count`	`int32` Total number of unique URIs in the request that are not in invalid_uris.
`success_count`	`int32` Total number of URIs that have been crawled so far.
`pending_count`	`int32` Total number of URIs that have yet to be crawled.
`quota_exceeded_count`	`int32` Total number of URIs that were rejected due to insufficient indexing resources.

RecrawlUrisRequest

Request message for SiteSearchEngineService.RecrawlUris method.

Fields

site_search_engine

string

Required. Full resource name of the SiteSearchEngine, such as projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine.

uris[]

string

Required. List of URIs to crawl. At most 10K URIs are supported, otherwise an INVALID_ARGUMENT error is thrown. Each URI should match at least one TargetSite in site_search_engine.

RecrawlUrisResponse

Response message for SiteSearchEngineService.RecrawlUris method.

Fields

failure_samples[]

FailureInfo

Details for a sample of up to 10 failed_uris.

failed_uris[]

string

URIs that were not crawled before the LRO terminated.

FailureInfo

Details about why a particular URI failed to be crawled. Each FailureInfo contains one FailureReason per CorpusType.

Fields

uri

string

URI that failed to be crawled.

failure_reasons[]

FailureReason

List of failure reasons by corpus type (e.g. desktop, mobile).

FailureReason

Details about why crawling failed for a particular CorpusType, e.g., DESKTOP and MOBILE crawling may fail for different reasons.

Fields

corpus_type

CorpusType

DESKTOP, MOBILE, or CORPUS_TYPE_UNSPECIFIED.

error_message

string

Reason why the URI was not crawled.

CorpusType

CorpusType for the failed crawling operation.

Enums
`CORPUS_TYPE_UNSPECIFIED`	Default value.
`DESKTOP`	Denotes a crawling attempt for the desktop version of a page.
`MOBILE`	Denotes a crawling attempt for the mobile version of a page.

Reply

Defines a reply message to user.

Fields

summary

Summary

Summary based on search results.

Schema

Defines the structure and layout of a type of document data.

Fields
`name`	`string` Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
Union field `schema`. Schema representation. One of `struct_schema` or `json_schema` should be provided otherwise an `INVALID_ARGUMENT` error is thrown. `schema` can be only one of the following:
`struct_schema`	`Struct` The structured representation of the schema.
`json_schema`	`string` The JSON representation of the schema.

SearchAddOn

Add-on that provides additional functionality for search.

Enums
`SEARCH_ADD_ON_UNSPECIFIED`	Default value when the enum is unspecified. This is invalid to use.
`SEARCH_ADD_ON_LLM`	Large language model add-on.

SearchInfo

Detailed search information.

Fields

search_query

string

The user's search query.

See SearchRequest.query for definition.

The value must be a UTF-8 encoded string with a length limit of 5,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

At least one of search_query or PageInfo.page_category is required for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

order_by

string

The order in which products are returned, if applicable.

See SearchRequest.order_by for definition and syntax.

The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an INVALID_ARGUMENT error is returned.

This can only be set for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

offset

int32

An integer that specifies the current offset for pagination (the 0-indexed starting location, amongst the products deemed by the API as relevant).

See SearchRequest.offset for definition.

If this field is negative, an INVALID_ARGUMENT is returned.

This can only be set for search events. Other event types should not set this field. Otherwise, an INVALID_ARGUMENT error is returned.

SearchRequest

Request message for SearchService.Search method.

Fields
`serving_config`	`string` Required. The resource name of the Search serving config, such as `projects//locations/global/collections/default_collection/engines//servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search.
`branch`	`string` The branch resource name, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch.
`query`	`string` Raw search query.
`image_query`	`ImageQuery` Raw image query.
`page_size`	`int32` Maximum number of `Document`s to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. Websites with basic indexing: Default `10`, Maximum `25`. Websites with advanced indexing: Default `25`, Maximum `50`. Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned.
`page_token`	`string` A page token received from a previous `SearchService.Search` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `SearchService.Search` must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.
`offset`	`int32` A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the `Document`s deemed by the API as relevant) in search results. This field is only considered if `page_token` is unset. If this field is negative, an `INVALID_ARGUMENT` is returned.
`data_store_specs[]`	`DataStoreSpec` A list of data store specs to apply on a search call.
`filter`	`string` The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see Filter
`canonical_filter`	`string` The default filter that is applied when a user performs a search without checking any filters on the search page. The filter applied to every search request when quality improvement such as query expansion is needed. In the case a query does not have a sufficient amount of results this filter will be used to determine whether or not to enable the query expansion flow. The original filter will still be used for the query expanded search. This field is strongly recommended to achieve high search quality. For more information about filter syntax, see `SearchRequest.filter`.
`order_by`	`string` The order in which documents are returned. Documents can be ordered by a field in an `Document` object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see Ordering If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
`user_info`	`UserInfo` Information about the end user. Highly recommended for analytics. `UserInfo.user_agent` is used to deduce `device_type` for analytics.
`facet_specs[]`	`FacetSpec` Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
`boost_spec`	`BoostSpec` Boost specification to boost certain documents. For more information on boosting, see Boosting
`params`	`map<string, Value>` Additional search parameters. For public website search only, supported values are: `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au" For available codes see Country Codes `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1
`query_expansion_spec`	`QueryExpansionSpec` The query expansion specification that specifies the conditions under which query expansion occurs.
`spell_correction_spec`	`SpellCorrectionSpec` The spell correction specification that specifies the mode under which spell correction takes effect.
`user_pseudo_id`	`string` A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as `UserEvent.user_pseudo_id` and `CompleteQueryRequest.user_pseudo_id` The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.
`content_search_spec`	`ContentSearchSpec` A specification for configuring the behavior of content search.
`safe_search`	`bool` Whether to turn on safe search. This is only supported for website search.
`user_labels`	`map<string, string>` 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.

BoostSpec

Boost specification to boost certain documents.

Fields

condition_boost_specs[]

ConditionBoostSpec

Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.

ConditionBoostSpec

Boost applies to documents which match a condition.

Fields

condition

string

An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations.

Examples:

To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))

boost

float

Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0.

Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents.

Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely.

Setting to 0.0 means no boost applied. The boosting condition is ignored. Only one of the (condition, boost) combination or the boost_control_spec below are set. If both are set then the global boost is ignored and the more fine-grained boost_control_spec is applied.

ContentSearchSpec

A specification for configuring the behavior of content search.

Fields

snippet_spec

SnippetSpec

If snippetSpec is not specified, snippets are not included in the search response.

summary_spec

SummarySpec

If summarySpec is not specified, summaries are not included in the search response.

extractive_content_spec

ExtractiveContentSpec

If there is no extractive_content_spec provided, there will be no extractive answer in the search response.

ExtractiveContentSpec

A specification for configuring the extractive content in a search response.

Fields
`max_extractive_answer_count`	`int32` The maximum number of extractive answers returned in each search result. An extractive answer is a verbatim answer extracted from the original document, which provides a precise and contextually relevant answer to the search query. If the number of matching answers is less than the `max_extractive_answer_count`, return all of the answers. Otherwise, return the `max_extractive_answer_count`. At most five answers are returned for each `SearchResult`.
`max_extractive_segment_count`	`int32` The max number of extractive segments returned in each search result. Only applied if the `DataStore` is set to `DataStore.ContentConfig.CONTENT_REQUIRED` or `DataStore.solution_types` is `SOLUTION_TYPE_CHAT`. An extractive segment is a text segment extracted from the original document that is relevant to the search query, and, in general, more verbose than an extractive answer. The segment could then be used as input for LLMs to generate summaries and answers. If the number of matching segments is less than `max_extractive_segment_count`, return all of the segments. Otherwise, return the `max_extractive_segment_count`.
`return_extractive_segment_score`	`bool` Specifies whether to return the confidence score from the extractive segments in each search result. This feature is available only for new or allowlisted data stores. To allowlist your data store, contact your Customer Engineer. The default value is `false`.
`num_previous_segments`	`int32` Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.
`num_next_segments`	`int32` Return at most `num_next_segments` segments after each selected segments.

SnippetSpec

A specification for configuring snippets in a search response.

Fields

max_snippet_count
(deprecated)

int32

[DEPRECATED] This field is deprecated. To control snippet return, use return_snippet field. For backwards compatibility, we will return snippet if max_snippet_count > 0.

reference_only
(deprecated)

bool

[DEPRECATED] This field is deprecated and will have no affect on the snippet.

return_snippet

bool

If true, then return snippet. If no snippet can be generated, we return "No snippet is available for this page." A snippet_status with SUCCESS or NO_SNIPPET_AVAILABLE will also be returned.

SummarySpec

A specification for configuring a summary returned in a search response.

Fields
`summary_result_count`	`int32` The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most 10 results for documents mode, or 50 for chunks mode, can be used to generate a summary. The chunks mode is used when [SearchRequest.ContentSearchSpec.search_result_mode][] is set to [CHUNKS][SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
`include_citations`	`bool` Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
`ignore_adversarial_query`	`bool` Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
`ignore_non_summary_seeking_query`	`bool` Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
`model_prompt_spec`	`ModelPromptSpec` If specified, the spec will be used to modify the prompt provided to the LLM.
`language_code`	`string` Language code for Summary. Use language tags defined by BCP47. Note: This is an experimental feature.
`model_spec`	`ModelSpec` If specified, the spec will be used to modify the model specification provided to the LLM.
`use_semantic_chunks`	`bool` If true, answer will be generated from most relevant chunks from top search results. This feature will improve summary quality. Note that with this feature enabled, not all top search results will be referenced and included in the reference list, so the citation source index only points to the search results listed in the reference list.

ModelPromptSpec

Specification of the prompt to use with the model.

Fields

preamble

string

Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.

ModelSpec

Specification of the model.

Fields

version

string

The model version used to generate the summary.

Supported values are:

stable: string. Default value when no value is specified. Uses a generally available, fine-tuned model. For more information, see Answer generation model versions and lifecycle.
preview: string. (Public preview) Uses a preview model. For more information, see Answer generation model versions and lifecycle.

DataStoreSpec

A struct to define data stores to filter on in a search call.

Fields

data_store

string

Required. Full resource name of DataStore, such as projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}.

FacetSpec

A facet specification to perform faceted search.

Fields
`facet_key`	`FacetKey` Required. The facet key specification.
`limit`	`int32` Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned.
`excluded_filter_keys[]`	`string` List of keys to exclude when faceting. By default, `FacetKey.key` is not excluded from the filter unless it is listed in this field. Listing a facet key in this field allows its values to appear as facet results, even when they are filtered out of search results. Using this field does not affect what search results are returned. For example, suppose there are 100 documents with the color facet "Red" and 200 documents with the color facet "Blue". A query containing the filter "color:ANY("Red")" and having "color" as `FacetKey.key` would by default return only "Red" documents in the search results, and also return "Red" with count 100 as the only color facet. Although there are also blue documents available, "Blue" would not be shown as an available facet value. If "color" is listed in "excludedFilterKeys", then the query returns the facet values "Red" with count 100 and "Blue" with count 200, because the "color" key is now excluded from the filter. Because this field doesn't affect search results, the search results are still correctly filtered to return only "Red" documents. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
`enable_dynamic_position`	`bool` Enables dynamic position for this facet. If set to true, the position of this facet among all facets in the response is determined automatically. If dynamic facets are enabled, it is ordered together. If set to false, the position of this facet in the response is the same as in the request, and it is ranked before the facets with dynamic position enable and all dynamic facets. For example, you may always want to have rating facet returned in the response, but it's not necessarily to always display the rating facet at the top. In that case, you can set enable_dynamic_position to true so that the position of rating facet in response is determined automatically. Another example, assuming you have the following facets in the request: "rating", enable_dynamic_position = true "price", enable_dynamic_position = false "brands", enable_dynamic_position = false And also you have a dynamic facets enabled, which generates a facet `gender`. Then the final order of the facets in the response can be ("price", "brands", "rating", "gender") or ("price", "brands", "gender", "rating") depends on how API orders "gender" and "rating" facets. However, notice that "price" and "brands" are always ranked at first and second position because their enable_dynamic_position is false.

FacetKey

Specifies how a facet is computed.

Fields
`key`	`string` Required. Supported textual and numerical facet keys in `Document` object, over which the facet values are computed. Facet key is case-sensitive.
`intervals[]`	`Interval` Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30.
`restricted_values[]`	`string` Only get facet for the given restricted values. Only supported on textual fields. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "restricted_values" to "Action > 2022", the "category" facet only contains "Action > 2022". Only supported on textual fields. Maximum is 10.
`prefixes[]`	`string` Only get facet values that start with the given string prefix. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "prefixes" to "Action", the "category" facet only contains "Action > 2022" and "Action > 2021". Only supported on textual fields. Maximum is 10.
`contains[]`	`string` Only get facet values that contains the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10.
`case_insensitive`	`bool` True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise.
`order_by`	`string` The order in which documents are returned. Allowed values are: "count desc", which means order by `SearchResponse.Facet.values.count` descending. "value desc", which means order by `SearchResponse.Facet.values.value` descending. Only applies to textual facets. If not set, textual values are sorted in natural order; numerical intervals are sorted in the order given by `FacetSpec.FacetKey.intervals`.

ImageQuery

Specifies the image query input.

Fields

Union field image.

image can be only one of the following:

image_bytes

string

Base64 encoded image bytes. Supported image formats: JPEG, PNG, and BMP.

QueryExpansionSpec

Specification to determine under which conditions query expansion should occur.

Fields

condition

Condition

The condition under which query expansion should occur. Default to Condition.DISABLED.

pin_unexpanded_results

bool

Whether to pin unexpanded results. If this field is set to true, unexpanded products are always at the top of the search results, followed by the expanded results.

Condition

Enum describing under which condition query expansion should occur.

Enums
`CONDITION_UNSPECIFIED`	Unspecified query expansion condition. In this case, server behavior defaults to `Condition.DISABLED`.
`DISABLED`	Disabled query expansion. Only the exact search query is used, even if `SearchResponse.total_size` is zero.
`AUTO`	Automatic query expansion built by the Search API.

SpellCorrectionSpec

The specification for query spell correction.

Fields

mode

Mode

The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO.

Mode

Enum describing under which mode spell correction should occur.

Enums
`MODE_UNSPECIFIED`	Unspecified spell correction mode. In this case, server behavior defaults to `Mode.AUTO`.
`SUGGESTION_ONLY`	Search API will try to find a spell suggestion if there is any and put in the `SearchResponse.corrected_query`. The spell suggestion will not be used as the search query.
`AUTO`	Automatic spell correction built by the Search API. Search will be based on the corrected query if found.

SearchResponse

Response message for SearchService.Search method.

Fields
`results[]`	`SearchResult` A list of matched documents. The order represents the ranking.
`facets[]`	`Facet` Results of facets requested by user.
`total_size`	`int32` The estimated total count of matched items irrespective of pagination. The count of `results` returned by pagination may be less than the `total_size` that matches.
`attribution_token`	`string` A unique search token. This should be included in the `UserEvent` logs resulting from this search, which enables accurate attribution of search model performance.
`redirect_uri`	`string` The URI of a customer-defined redirect page. If redirect action is triggered, no search is performed, and only `redirect_uri` and `attribution_token` are set in the response.
`next_page_token`	`string` A token that can be sent as `SearchRequest.page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
`corrected_query`	`string` Contains the spell corrected query, if found. If the spell correction type is AUTOMATIC, then the search results are based on corrected_query. Otherwise the original query is used for search.
`summary`	`Summary` A summary as part of the search results. This field is only returned if `SearchRequest.ContentSearchSpec.summary_spec` is set.
`query_expansion_info`	`QueryExpansionInfo` Query expansion information for the returned results.

A facet result.

Fields

key

string

The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key.

values[]

FacetValue

The facet values for this field.

dynamic_facet

bool

Whether the facet is dynamically generated.

FacetValue

A facet value which contains value names and their count.

Fields
`count`	`int64` Number of items that have this facet value.
Union field `facet_value`. A facet value which contains values. `facet_value` can be only one of the following:
`value`	`string` Text value of a facet, such as "Black" for facet "colors".
`interval`	`Interval` Interval value for a facet, such as [10, 20) for facet "price". It matches `SearchRequest.FacetSpec.FacetKey.intervals`.

QueryExpansionInfo

Information describing query expansion including whether expansion has occurred.

Fields

expanded_query

bool

Bool describing whether query expansion has occurred.

pinned_result_count

int64

Number of pinned results. This field will only be set when expansion happens and SearchRequest.QueryExpansionSpec.pin_unexpanded_results is set to true.

SearchResult

Represents the search results.

Fields

id

string

Document.id of the searched Document.

document

The document data snippet in the search response. Only fields that are marked as retrievable are populated.

Summary

Summary of the top N search result specified by the summary spec.

Fields
`summary_text`	`string` The summary content.
`summary_skipped_reasons[]`	`SummarySkippedReason` Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
`safety_attributes`	`SafetyAttributes` A collection of Safety Attribute categories and their associated confidence scores.
`summary_with_metadata`	`SummaryWithMetadata` Summary with metadata information.

Citation

Citation info for a segment.

Fields

start_index

int64

Index indicates the start of the segment, measured in bytes/unicode.

end_index

int64

End of the attributed segment, exclusive.

sources[]

CitationSource

Citation sources for the attributed segment.

CitationMetadata

Citation metadata.

Fields

citations[]

Citation

Citations for segments.

CitationSource

Citation source.

Fields

reference_index

int64

Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.

Reference

Document reference.

Fields
`title`	`string` Title of the document.
`document`	`string` Required. `Document.name` of the document. Full resource name of the referenced document, in the format `projects//locations//collections//dataStores//branches//documents/`.
`uri`	`string` Cloud Storage or HTTP uri for the document.
`chunk_contents[]`	`ChunkContent` List of cited chunk contents derived from document content.

ChunkContent

Chunk content.

Fields

content

string

Chunk textual content.

page_identifier

string

Page identifier.

SafetyAttributes

Safety Attribute categories and their associated confidence scores.

Fields

categories[]

string

The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.

scores[]

float

The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.

SummarySkippedReason

An Enum for summary-skipped reasons.

Enums
`SUMMARY_SKIPPED_REASON_UNSPECIFIED`	Default value. The summary skipped reason is not specified.
`ADVERSARIAL_QUERY_IGNORED`	The adversarial query ignored case. Only populated when `SummarySpec.ignore_adversarial_query` is set to `true`.
`NON_SUMMARY_SEEKING_QUERY_IGNORED`	The non-summary seeking query ignored case. Only populated when `SummarySpec.ignore_non_summary_seeking_query` is set to `true`.
`OUT_OF_DOMAIN_QUERY_IGNORED`	The out-of-domain query ignored case. Google skips the summary if there are no high-relevance search results. For example, the data store contains facts about company A but the user query is asking questions about company B.
`POTENTIAL_POLICY_VIOLATION`	The potential policy violation case. Google skips the summary if there is a potential policy violation detected. This includes content that may be violent or toxic.
`LLM_ADDON_NOT_ENABLED`	The LLM addon not enabled case. Google skips the summary if the LLM addon is not enabled.

SummaryWithMetadata

Summary with metadata information.

Fields

summary

string

Summary text with no citation information.

citation_metadata

CitationMetadata

Citation metadata for given summary.

references[]

Reference

Document References.

SearchTier

Tiers of search features. Different tiers might have different pricing. To learn more, check the pricing documentation.

Enums
`SEARCH_TIER_UNSPECIFIED`	Default value when the enum is unspecified. This is invalid to use.
`SEARCH_TIER_STANDARD`	Standard tier.
`SEARCH_TIER_ENTERPRISE`	Enterprise tier.

SiteSearchEngine

SiteSearchEngine captures DataStore level site search persisting configurations. It is a singleton value per data store.

Fields

name

string

The fully qualified resource name of the site search engine. Format: projects/*/locations/*/dataStores/*/siteSearchEngine

SiteVerificationInfo

Verification information for target sites in advanced site search.

Fields

site_verification_state

SiteVerificationState

Site verification state indicating the ownership and validity.

verify_time

Latest site verification time.

SiteVerificationState

Site verification state.

Enums
`SITE_VERIFICATION_STATE_UNSPECIFIED`	Defaults to VERIFIED.
`VERIFIED`	Site ownership verified.
`UNVERIFIED`	Site ownership pending verification or verification failed.
`EXEMPTED`	Site exempt from verification, e.g., a public website that opens to all.

SolutionType

The type of solution.

Enums
`SOLUTION_TYPE_UNSPECIFIED`	Default value.
`SOLUTION_TYPE_RECOMMENDATION`	Used for Recommendations AI.
`SOLUTION_TYPE_SEARCH`	Used for Discovery Search.
`SOLUTION_TYPE_CHAT`	Used for use cases related to the Generative AI agent.
`SOLUTION_TYPE_GENERATIVE_CHAT`	Used for use cases related to the Generative Chat agent. It's used for Generative chat engine only, the associated data stores must enrolled with `SOLUTION_TYPE_CHAT` solution.

SpannerSource

The Spanner source for importing data

Fields
`project_id`	`string` The project ID that the Spanner source is in with a length limit of 128 characters. If not specified, inherits the project ID from the parent request.
`instance_id`	`string` Required. The instance ID of the source Spanner table.
`database_id`	`string` Required. The database ID of the source Spanner table.
`table_id`	`string` Required. The table name of the Spanner database that needs to be imported.
`enable_data_boost`	`bool` Whether to apply data boost on Spanner export. Enabling this option will incur additional cost. More info can be found here.

SuggestionDenyListEntry

Suggestion deny list entry identifying the phrase to block from suggestions and the applied operation for the phrase.

Fields

block_phrase

string

Required. Phrase to block from suggestions served. Can be maximum 125 characters.

match_operator

MatchOperator

Required. The match operator to apply for this phrase. Whether to block the exact phrase, or block any suggestions containing this phrase.

MatchOperator

Operator for matching with the generated suggestions.

Enums
`MATCH_OPERATOR_UNSPECIFIED`	Default value. Should not be used
`EXACT_MATCH`	If the suggestion is an exact match to the block_phrase, then block it.
`CONTAINS`	If the suggestion contains the block_phrase, then block it.

TargetSite

A target site for the SiteSearchEngine.

Fields
`name`	`string` Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated.
`provided_uri_pattern`	`string` Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated.
`type`	`Type` The type of the target site, e.g., whether the site is to be included or excluded.
`exact_match`	`bool` Input only. If set to false, a uri_pattern is generated to include all pages whose address contains the provided_uri_pattern. If set to true, an uri_pattern is generated to try to be an exact match of the provided_uri_pattern or just the specific page if the provided_uri_pattern is a specific one. provided_uri_pattern is always normalized to generate the URI pattern to be used by the search engine.
`generated_uri_pattern`	`string` Output only. This is system-generated based on the provided_uri_pattern.
`root_domain_uri`	`string` Output only. Root domain of the provided_uri_pattern.
`site_verification_info`	`SiteVerificationInfo` Output only. Site ownership and validity verification status.
`indexing_status`	`IndexingStatus` Output only. Indexing status.
`update_time`	`Timestamp` Output only. The target site's last updated time.
`failure_reason`	`FailureReason` Output only. Failure reason.

FailureReason

Site search indexing failure reasons.

Fields

Union field failure. Failure reason. failure can be only one of the following:

quota_failure

QuotaFailure

Failed due to insufficient quota.

QuotaFailure

Failed due to insufficient quota.

Fields

total_required_quota

int64

This number is an estimation on how much total quota this project needs to successfully complete indexing.

IndexingStatus

Target site indexing status enumeration.

Enums
`INDEXING_STATUS_UNSPECIFIED`	Defaults to SUCCEEDED.
`PENDING`	The target site is in the update queue and will be picked up by indexing pipeline.
`FAILED`	The target site fails to be indexed.
`SUCCEEDED`	The target site has been indexed.
`DELETING`	The previously indexed target site has been marked to be deleted. This is a transitioning state which will resulted in either: 1. target site deleted if unindexing is successful; 2. state reverts to SUCCEEDED if the unindexing fails.

Type

Possible target site types.

Enums
`TYPE_UNSPECIFIED`	This value is unused. In this case, server behavior defaults to `Type.INCLUDE`.
`INCLUDE`	Include the target site.
`EXCLUDE`	Exclude the target site.

TextInput

Defines text input.

Fields

input

string

Text input.

context

ConversationContext

Conversation context of the input.

TransactionInfo

A transaction represents the entire purchase transaction.

Fields
`currency`	`string` Required. Currency code. Use three-character ISO-4217 code.
`transaction_id`	`string` The transaction ID with a length limit of 128 characters.
`value`	`float` Required. Total non-zero value associated with the transaction. This value may include shipping, tax, or other adjustments to the total value that you want to include.
`tax`	`float` All the taxes associated with the transaction.
`cost`	`float` All the costs associated with the products. These can be manufacturing costs, shipping expenses not borne by the end user, or any other costs, such that: Profit = `value` - `tax` - `cost`
`discount_value`	`float` The total discount(s) value applied to this transaction. This figure should be excluded from `TransactionInfo.value` For example, if a user paid `TransactionInfo.value` amount, then nominal (pre-discount) value of the transaction is the sum of `TransactionInfo.value` and `TransactionInfo.discount_value` This means that profit is calculated the same way, regardless of the discount value, and that `TransactionInfo.discount_value` can be larger than `TransactionInfo.value`: Profit = `value` - `tax` - `cost`

UpdateConversationRequest

Request for UpdateConversation method.

Fields

conversation

Required. The Conversation to update.

update_mask

Indicates which fields in the provided Conversation to update. The following are NOT supported:

Conversation.name

If not set or empty, all supported fields are updated.

UpdateDataStoreRequest

Request message for DataStoreService.UpdateDataStore method.

Fields

data_store

DataStore

Required. The DataStore to update.

If the caller does not have permission to update the DataStore, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the DataStore to update does not exist, a NOT_FOUND error is returned.

update_mask

Indicates which fields in the provided DataStore to update.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

UpdateDocumentRequest

Request message for DocumentService.UpdateDocument method.

Fields

document

Required. The document to update/create.

If the caller does not have permission to update the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the Document to update does not exist and allow_missing is not set, a NOT_FOUND error is returned.

allow_missing

bool

If set to true, and the Document is not found, a new Document will be created.

update_mask

Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields.

UpdateEngineRequest

Request message for EngineService.UpdateEngine method.

Fields

engine

Engine

Required. The Engine to update.

If the caller does not have permission to update the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned.

If the Engine to update does not exist, a NOT_FOUND error is returned.

update_mask

Indicates which fields in the provided Engine to update.

If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned.

UpdateSchemaMetadata

Metadata for UpdateSchema LRO.

Fields

create_time

Operation create time.

update_time

Operation last update time. If the operation is done, this is also the finish time.

UpdateSchemaRequest

Request message for SchemaService.UpdateSchema method.

Fields

schema

Schema

Required. The Schema to update.

allow_missing

bool

If set to true, and the Schema is not found, a new Schema will be created. In this situation, update_mask is ignored.

UpdateTargetSiteMetadata

Metadata related to the progress of the SiteSearchEngineService.UpdateTargetSite operation. This will be returned by the google.longrunning.Operation.metadata field.

Fields

create_time

Operation create time.

update_time

Operation last update time. If the operation is done, this is also the finish time.

UpdateTargetSiteRequest

Request message for SiteSearchEngineService.UpdateTargetSite method.

Fields

target_site