@swamp/gcp/discoveryengine
v2026.04.23.1
Google Cloud discoveryengine infrastructure models
Repository
https://github.com/systeminit/swamp-extensions
Labels
gcpgoogle-clouddiscoveryenginecloudinfrastructure
Contents
Quality score
Verified by SwampHow well-documented and verifiable this extension is.
Grade A
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types1/1earned
- Has description1/1earned
- At least one platform tag (or universal)1/1earned
- Two or more platform tags (or universal)1/1earned
- License declared1/1earned
- Verified public repository2/2earned
Install
$ swamp extension pull @swamp/gcp/discoveryenginecollections_engines_controls.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| boostAction? | object | Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). |
| conditions? | array | End of time range. Range is inclusive. Must be in the future. |
| displayName? | string | Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| filterAction? | object | Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| name? | string | Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` |
| promoteAction? | object | Required. Data store with which this promotion is attached to. |
| redirectAction? | object | Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| solutionType? | enum | Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. |
| synonymsAction? | object | Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. |
| useCases? | array | Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. |
| controlId? | string | Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a controls
getGet a controls
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the controls |
updateUpdate controls attributes
deleteDelete the controls
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the controls |
syncSync controls state from GCP
collections_datastores_sitesearchengine_targetsites.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| exactMatch? | boolean | Immutable. 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. |
| failureReason? | object | This number is an estimation on how much total quota this project needs to successfully complete indexing. |
| providedUriPattern? | string | Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. |
| siteVerificationInfo? | object | Site verification state indicating the ownership and validity. |
| type? | enum | The type of the target site, e.g., whether the site is to be included or excluded. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a targetSites
getGet a targetSites
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the targetSites |
updateUpdate targetSites attributes
deleteDelete the targetSites
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the targetSites |
syncSync targetSites state from GCP
batch_createbatch create
| Argument | Type | Description |
|---|---|---|
| requests? | any |
collections_engines_servingconfigs.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| answerGenerationSpec? | object | Optional. Whether or not to enable and include user defined classifier. |
| boostControlIds? | array | Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. |
| displayName? | string | Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| dissociateControlIds? | array | Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. |
| diversityLevel? | string | How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. |
| filterControlIds? | array | Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls. |
| genericConfig? | object | The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. |
| ignoreControlIds? | array | Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100. |
| mediaConfig? | object | Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. |
| modelId? | string | The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. |
| name? | string | Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` |
| onewaySynonymsControlIds? | array | Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. |
| promoteControlIds? | array | Condition promote specifications. Maximum number of specifications is 100. |
| rankingExpression? | string | The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if `SearchRequest.ranking_expression` is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. |
| redirectControlIds? | array | IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. |
| replacementControlIds? | array | Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. |
| solutionType? | enum | Required. Immutable. Specifies the solution type that a serving config can be associated with. |
| synonymsControlIds? | array | Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. |
| servingConfigId? | string | Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a servingConfigs
getGet a servingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the servingConfigs |
updateUpdate servingConfigs attributes
deleteDelete the servingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the servingConfigs |
syncSync servingConfigs state from GCP
answeranswer
| Argument | Type | Description |
|---|---|---|
| answerGenerationSpec? | any | |
| asynchronousMode? | any | |
| endUserSpec? | any | |
| groundingSpec? | any | |
| query? | any | |
| queryUnderstandingSpec? | any | |
| relatedQuestionsSpec? | any | |
| safetySpec? | any | |
| searchSpec? | any | |
| session? | any | |
| userLabels? | any | |
| userPseudoId? | any |
recommendrecommend
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| pageSize? | any | |
| params? | any | |
| userEvent? | any | |
| userLabels? | any | |
| validateOnly? | any |
searchsearch
| Argument | Type | Description |
|---|---|---|
| boostSpec? | any | |
| branch? | any | |
| canonicalFilter? | any | |
| contentSearchSpec? | any | |
| crowdingSpecs? | any | |
| customRankingParams? | any | |
| dataStoreSpecs? | any | |
| displaySpec? | any | |
| entity? | any | |
| facetSpecs? | any | |
| filter? | any | |
| imageQuery? | any | |
| languageCode? | any | |
| naturalLanguageQueryUnderstandingSpec? | any | |
| numResultsPerDataStore? | any | |
| offset? | any | |
| oneBoxPageSize? | any | |
| orderBy? | any | |
| pageCategories? | any | |
| pageSize? | any | |
| pageToken? | any | |
| params? | any | |
| query? | any | |
| queryExpansionSpec? | any | |
| rankingExpression? | any | |
| rankingExpressionBackend? | any | |
| relevanceScoreSpec? | any | |
| relevanceThreshold? | any | |
| safeSearch? | any | |
| searchAsYouTypeSpec? | any | |
| session? | any | |
| sessionSpec? | any | |
| spellCorrectionSpec? | any | |
| userInfo? | any | |
| userLabels? | any | |
| userPseudoId? | any |
search_litesearch lite
| Argument | Type | Description |
|---|---|---|
| boostSpec? | any | |
| branch? | any | |
| canonicalFilter? | any | |
| contentSearchSpec? | any | |
| crowdingSpecs? | any | |
| customRankingParams? | any | |
| dataStoreSpecs? | any | |
| displaySpec? | any | |
| entity? | any | |
| facetSpecs? | any | |
| filter? | any | |
| imageQuery? | any | |
| languageCode? | any | |
| naturalLanguageQueryUnderstandingSpec? | any | |
| numResultsPerDataStore? | any | |
| offset? | any | |
| oneBoxPageSize? | any | |
| orderBy? | any | |
| pageCategories? | any | |
| pageSize? | any | |
| pageToken? | any | |
| params? | any | |
| query? | any | |
| queryExpansionSpec? | any | |
| rankingExpression? | any | |
| rankingExpressionBackend? | any | |
| relevanceScoreSpec? | any | |
| relevanceThreshold? | any | |
| safeSearch? | any | |
| searchAsYouTypeSpec? | any | |
| session? | any | |
| sessionSpec? | any | |
| spellCorrectionSpec? | any | |
| userInfo? | any | |
| userLabels? | any | |
| userPseudoId? | any |
stream_answerstream answer
| Argument | Type | Description |
|---|---|---|
| answerGenerationSpec? | any | |
| asynchronousMode? | any | |
| endUserSpec? | any | |
| groundingSpec? | any | |
| query? | any | |
| queryUnderstandingSpec? | any | |
| relatedQuestionsSpec? | any | |
| safetySpec? | any | |
| searchSpec? | any | |
| session? | any | |
| userLabels? | any | |
| userPseudoId? | any |
collections_engines_assistants_agents_a2a_v1_tasks.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a tasks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tasks |
syncSync tasks state from GCP
cancelcancel
subscribesubscribe
collections_datastores_widgetconfigs.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessSettings? | object | Whether public unauthenticated access is allowed. |
| assistantSettings? | object | Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled. |
| collectionComponents? | array | Output only. The icon link of the connector source. |
| configId? | string | Output only. Unique obfuscated identifier of a WidgetConfig. |
| contentSearchSpec? | object | The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. |
| createTime? | string | Output only. Timestamp the WidgetConfig was created. |
| customerProvidedConfig? | object | Customer type. |
| dataStoreType? | enum | Output only. The type of the parent data store. |
| displayName? | string | Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| enablePrivateKnowledgeGraph? | boolean | Optional. Output only. Whether to enable private knowledge graph. |
| enableResultScore? | boolean | Whether to show the result score. |
| geminiBundle? | boolean | Output only. Whether the subscription is gemini bundle or not. |
| homepageSetting? | object | Optional. Destination URL of shortcut. |
| industryVertical? | enum | Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine. |
| llmEnabled? | boolean | Output only. Whether LLM is enabled in the corresponding data store. |
| minimumDataTermAccepted? | boolean | Output only. Whether the customer accepted data use terms. |
| name? | string | Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| nodes? | array | Output only. A detailed description of what the node does. |
| solutionType? | enum | Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. |
| uiBranding? | object | Image URL. |
| uiSettings? | object | Optional. The field name that end users will see. |
| updateTime? | string | Output only. Timestamp the WidgetConfig was updated. |
getGet a widgetConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the widgetConfigs |
updateUpdate widgetConfigs attributes
syncSync widgetConfigs state from GCP
collections_datastores.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| aclEnabled? | boolean | Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. |
| advancedSiteSearchConfig? | object | If set true, automatic refresh is disabled for the DataStore. |
| billingEstimation? | object | Data size for structured data in terms of bytes. |
| cmekConfig? | object | Output only. The default CmekConfig for the Customer. |
| configurableBillingApproach? | enum | Optional. Configuration for configurable billing approach. See |
| contentConfig? | enum | Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. |
| displayName? | 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. |
| documentProcessingConfig? | object | The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. |
| federatedSearchConfig? | object | Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. |
| healthcareFhirConfig? | object | Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. |
| identityMappingStore? | string | Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. |
| industryVertical? | enum | Immutable. The industry vertical that the data store registers. |
| isInfobotFaqDataStore? | boolean | Optional. If set, this DataStore is an Infobot FAQ DataStore. |
| kmsKeyName? | string | Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. |
| name? | string | Immutable. Identifier. 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. |
| naturalLanguageQueryUnderstandingConfig? | object | Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. |
| servingConfigDataStore? | object | Optional. If set true, the DataStore will not be available for serving search requests. |
| solutionTypes? | array | 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. |
| startingSchema? | object | The JSON representation of the schema. |
| workspaceConfig? | object | Obfuscated Dasher customer ID. |
| cmekConfigName? | string | Resource name of the CmekConfig to use for protecting this DataStore. |
| createAdvancedSiteSearch? | string | 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. |
| dataStoreId? | 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](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| disableCmek? | string | DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. |
| skipDefaultSchemaCreation? | string | A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a dataStores
getGet a dataStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataStores |
updateUpdate dataStores attributes
deleteDelete the dataStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataStores |
syncSync dataStores state from GCP
complete_querycomplete query
get_site_search_engineget site search engine
train_custom_modeltrain custom model
| Argument | Type | Description |
|---|---|---|
| errorConfig? | any | |
| gcsTrainingInput? | any | |
| modelId? | any | |
| modelType? | any |
datastores_sessions.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| displayName? | string | Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. |
| isPinned? | boolean | Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. |
| labels? | array | Optional. The labels for the session. Can be set as filter in ListSessionsRequest. |
| name? | string | Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` |
| state? | enum | The state of the session. |
| turns? | array | Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. |
| userPseudoId? | string | A unique identifier for tracking users. |
| sessionId? | string | Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a sessions
getGet a sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
updateUpdate sessions attributes
deleteDelete the sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
syncSync sessions state from GCP
collections_engines_conversations.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| messages? | array | Output only. Message creation timestamp. |
| name? | string | Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. |
| state? | enum | The state of the Conversation. |
| userPseudoId? | string | A unique identifier for tracking users. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a conversations
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
updateUpdate conversations attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
syncSync conversations state from GCP
converseconverse
| Argument | Type | Description |
|---|---|---|
| boostSpec? | any | |
| conversation? | any | |
| filter? | any | |
| query? | any | |
| safeSearch? | any | |
| servingConfig? | any | |
| summarySpec? | any | |
| userLabels? | any |
userstores_userlicenses.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
getGet a userLicenses
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the userLicenses |
syncSync userLicenses state from GCP
collections_datastores_schemas.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| jsonSchema? | string | The JSON representation of the schema. |
| 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. |
| structSchema? | record | The structured representation of the schema. |
| schemaId? | string | Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a schemas
getGet a schemas
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the schemas |
updateUpdate schemas attributes
deleteDelete the schemas
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the schemas |
syncSync schemas state from GCP
collections_engines_widgetconfigs.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessSettings? | object | Whether public unauthenticated access is allowed. |
| assistantSettings? | object | Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled. |
| collectionComponents? | array | Output only. The icon link of the connector source. |
| configId? | string | Output only. Unique obfuscated identifier of a WidgetConfig. |
| contentSearchSpec? | object | The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. |
| createTime? | string | Output only. Timestamp the WidgetConfig was created. |
| customerProvidedConfig? | object | Customer type. |
| dataStoreType? | enum | Output only. The type of the parent data store. |
| displayName? | string | Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| enablePrivateKnowledgeGraph? | boolean | Optional. Output only. Whether to enable private knowledge graph. |
| enableResultScore? | boolean | Whether to show the result score. |
| geminiBundle? | boolean | Output only. Whether the subscription is gemini bundle or not. |
| homepageSetting? | object | Optional. Destination URL of shortcut. |
| industryVertical? | enum | Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine. |
| llmEnabled? | boolean | Output only. Whether LLM is enabled in the corresponding data store. |
| minimumDataTermAccepted? | boolean | Output only. Whether the customer accepted data use terms. |
| name? | string | Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| nodes? | array | Output only. A detailed description of what the node does. |
| solutionType? | enum | Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. |
| uiBranding? | object | Image URL. |
| uiSettings? | object | Optional. The field name that end users will see. |
| updateTime? | string | Output only. Timestamp the WidgetConfig was updated. |
getGet a widgetConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the widgetConfigs |
updateUpdate widgetConfigs attributes
syncSync widgetConfigs state from GCP
licenseconfigs.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| autoRenew? | boolean | Optional. Whether the license config should be auto renewed when it reaches the end date. |
| earlyTerminationDate? | object | Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| endDate? | object | Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| freeTrial? | boolean | Optional. Whether the license config is for free trial. |
| licenseCount? | string | Required. Number of licenses purchased. |
| name? | string | Immutable. Identifier. The fully qualified resource name of the license config. Format: `projects/{project}/locations/{location}/licenseConfigs/{license_config}` |
| startDate? | object | Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant. |
| subscriptionTerm? | enum | Required. Subscription term. |
| subscriptionTier? | enum | Required. Subscription tier information for the license config. |
| licenseConfigId? | string | Optional. The ID to use for the LicenseConfig, which will become the final component of the LicenseConfig's resource name. We are using the tier (product edition) name as the license config id such as `search` or `search_and_assistant`. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a licenseConfigs
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a licenseConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the licenseConfigs |
updateUpdate licenseConfigs attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
syncSync licenseConfigs state from GCP
collections_engines_assistants_agents_a2a_v1_tasks_pushnotificationconfigs.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name? | string | The resource name of the config. Format: tasks/{task_id}/pushNotificationConfigs/{config_id} |
| pushNotificationConfig? | object | Optional credentials |
| tenant | string | Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. |
| configId? | string | Required. The ID for the new config. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a pushNotificationConfigs
getGet a pushNotificationConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the pushNotificationConfigs |
deleteDelete the pushNotificationConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the pushNotificationConfigs |
syncSync pushNotificationConfigs state from GCP
datastores_sessions_answers.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a answers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the answers |
syncSync answers state from GCP
collections_datastores_custommodels.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a customModels
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customModels |
syncSync customModels state from GCP
datastores_widgetconfigs.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessSettings? | object | Whether public unauthenticated access is allowed. |
| assistantSettings? | object | Output only. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled. |
| collectionComponents? | array | Output only. The icon link of the connector source. |
| configId? | string | Output only. Unique obfuscated identifier of a WidgetConfig. |
| contentSearchSpec? | object | The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. |
| createTime? | string | Output only. Timestamp the WidgetConfig was created. |
| customerProvidedConfig? | object | Customer type. |
| dataStoreType? | enum | Output only. The type of the parent data store. |
| displayName? | string | Required. The human readable widget config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| enablePrivateKnowledgeGraph? | boolean | Optional. Output only. Whether to enable private knowledge graph. |
| enableResultScore? | boolean | Whether to show the result score. |
| geminiBundle? | boolean | Output only. Whether the subscription is gemini bundle or not. |
| homepageSetting? | object | Optional. Destination URL of shortcut. |
| industryVertical? | enum | Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine. |
| llmEnabled? | boolean | Output only. Whether LLM is enabled in the corresponding data store. |
| minimumDataTermAccepted? | boolean | Output only. Whether the customer accepted data use terms. |
| name? | string | Immutable. The full resource name of the widget config. Format: `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/widgetConfigs/{widget_config_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| nodes? | array | Output only. A detailed description of what the node does. |
| solutionType? | enum | Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. |
| uiBranding? | object | Image URL. |
| uiSettings? | object | Optional. The field name that end users will see. |
| updateTime? | string | Output only. Timestamp the WidgetConfig was updated. |
getGet a widgetConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the widgetConfigs |
updateUpdate widgetConfigs attributes
syncSync widgetConfigs state from GCP
datastores.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| aclEnabled? | boolean | Immutable. Whether data in the DataStore has ACL information. If set to `true`, the source data must have ACL. ACL will be ingested when data is ingested by DocumentService.ImportDocuments methods. When ACL is enabled for the DataStore, Document can't be accessed by calling DocumentService.GetDocument or DocumentService.ListDocuments. Currently ACL is only supported in `GENERIC` industry vertical with non-`PUBLIC_WEBSITE` content config. |
| advancedSiteSearchConfig? | object | If set true, automatic refresh is disabled for the DataStore. |
| billingEstimation? | object | Data size for structured data in terms of bytes. |
| cmekConfig? | object | Output only. The default CmekConfig for the Customer. |
| configurableBillingApproach? | enum | Optional. Configuration for configurable billing approach. See |
| contentConfig? | enum | Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. |
| displayName? | 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. |
| documentProcessingConfig? | object | The token size limit for each chunk. Supported values: 100-500 (inclusive). Default value: 500. |
| federatedSearchConfig? | object | Optional. AlloyDb AI NL config id, i.e. the value that was used for calling `SELECT alloydb_ai_nl.g_create_configuration(...)`. Can be empty. |
| healthcareFhirConfig? | object | Whether to enable configurable schema for `HEALTHCARE_FHIR` vertical. If set to `true`, the predefined healthcare fhir schema can be extended for more customized searching and filtering. |
| identityMappingStore? | string | Immutable. The fully qualified resource name of the associated IdentityMappingStore. This field can only be set for acl_enabled DataStores with `THIRD_PARTY` or `GSUITE` IdP. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. |
| industryVertical? | enum | Immutable. The industry vertical that the data store registers. |
| isInfobotFaqDataStore? | boolean | Optional. If set, this DataStore is an Infobot FAQ DataStore. |
| kmsKeyName? | string | Input only. The KMS key to be used to protect this DataStore at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the DataStore will be protected by the KMS key, as indicated in the cmek_config field. |
| name? | string | Immutable. Identifier. 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. |
| naturalLanguageQueryUnderstandingConfig? | object | Mode of Natural Language Query Understanding. If this field is unset, the behavior defaults to NaturalLanguageQueryUnderstandingConfig.Mode.DISABLED. |
| servingConfigDataStore? | object | Optional. If set true, the DataStore will not be available for serving search requests. |
| solutionTypes? | array | 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. |
| startingSchema? | object | The JSON representation of the schema. |
| workspaceConfig? | object | Obfuscated Dasher customer ID. |
| cmekConfigName? | string | Resource name of the CmekConfig to use for protecting this DataStore. |
| createAdvancedSiteSearch? | string | 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. |
| dataStoreId? | 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](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| disableCmek? | string | DataStore without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. |
| skipDefaultSchemaCreation? | string | A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a dataStores
getGet a dataStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataStores |
updateUpdate dataStores attributes
deleteDelete the dataStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataStores |
syncSync dataStores state from GCP
complete_querycomplete query
get_site_search_engineget site search engine
collections_datastores_branches_documents.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| aclInfo? | object | All users within the Identity Provider. |
| content? | object | The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml. |
| id? | string | Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. |
| indexStatus? | object | The status code, which should be an enum value of google.rpc.Code. |
| jsonData? | string | The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. |
| 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. |
| parentDocumentId? | string | The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. |
| schemaId? | string | The identifier of the schema located in the same data store. |
| structData? | record | The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. |
| documentId? | string | Required. The ID to use for the Document, which becomes 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](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a documents
getGet a documents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the documents |
updateUpdate documents attributes
deleteDelete the documents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the documents |
syncSync documents state from GCP
importimport
| Argument | Type | Description |
|---|---|---|
| alloyDbSource? | any | |
| autoGenerateIds? | any | |
| bigquerySource? | any | |
| bigtableSource? | any | |
| cloudSqlSource? | any | |
| errorConfig? | any | |
| fhirStoreSource? | any | |
| firestoreSource? | any | |
| forceRefreshContent? | any | |
| gcsSource? | any | |
| idField? | any | |
| inlineSource? | any | |
| reconciliationMode? | any | |
| spannerSource? | any | |
| updateMask? | any |
purgepurge
| Argument | Type | Description |
|---|---|---|
| errorConfig? | any | |
| filter? | any | |
| force? | any | |
| gcsSource? | any | |
| inlineSource? | any |
collections_datastores_servingconfigs.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| answerGenerationSpec? | object | Optional. Whether or not to enable and include user defined classifier. |
| boostControlIds? | array | Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. |
| displayName? | string | Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| dissociateControlIds? | array | Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. |
| diversityLevel? | string | How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. |
| filterControlIds? | array | Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls. |
| genericConfig? | object | The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. |
| ignoreControlIds? | array | Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100. |
| mediaConfig? | object | Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. |
| modelId? | string | The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. |
| name? | string | Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` |
| onewaySynonymsControlIds? | array | Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. |
| promoteControlIds? | array | Condition promote specifications. Maximum number of specifications is 100. |
| rankingExpression? | string | The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if `SearchRequest.ranking_expression` is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. |
| redirectControlIds? | array | IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. |
| replacementControlIds? | array | Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. |
| solutionType? | enum | Required. Immutable. Specifies the solution type that a serving config can be associated with. |
| synonymsControlIds? | array | Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. |
| servingConfigId? | string | Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a servingConfigs
getGet a servingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the servingConfigs |
updateUpdate servingConfigs attributes
deleteDelete the servingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the servingConfigs |
syncSync servingConfigs state from GCP
answeranswer
| Argument | Type | Description |
|---|---|---|
| answerGenerationSpec? | any | |
| asynchronousMode? | any | |
| endUserSpec? | any | |
| groundingSpec? | any | |
| query? | any | |
| queryUnderstandingSpec? | any | |
| relatedQuestionsSpec? | any | |
| safetySpec? | any | |
| searchSpec? | any | |
| session? | any | |
| userLabels? | any | |
| userPseudoId? | any |
recommendrecommend
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| pageSize? | any | |
| params? | any | |
| userEvent? | any | |
| userLabels? | any | |
| validateOnly? | any |
searchsearch
| Argument | Type | Description |
|---|---|---|
| boostSpec? | any | |
| branch? | any | |
| canonicalFilter? | any | |
| contentSearchSpec? | any | |
| crowdingSpecs? | any | |
| customRankingParams? | any | |
| dataStoreSpecs? | any | |
| displaySpec? | any | |
| entity? | any | |
| facetSpecs? | any | |
| filter? | any | |
| imageQuery? | any | |
| languageCode? | any | |
| naturalLanguageQueryUnderstandingSpec? | any | |
| numResultsPerDataStore? | any | |
| offset? | any | |
| oneBoxPageSize? | any | |
| orderBy? | any | |
| pageCategories? | any | |
| pageSize? | any | |
| pageToken? | any | |
| params? | any | |
| query? | any | |
| queryExpansionSpec? | any | |
| rankingExpression? | any | |
| rankingExpressionBackend? | any | |
| relevanceScoreSpec? | any | |
| relevanceThreshold? | any | |
| safeSearch? | any | |
| searchAsYouTypeSpec? | any | |
| session? | any | |
| sessionSpec? | any | |
| spellCorrectionSpec? | any | |
| userInfo? | any | |
| userLabels? | any | |
| userPseudoId? | any |
search_litesearch lite
| Argument | Type | Description |
|---|---|---|
| boostSpec? | any | |
| branch? | any | |
| canonicalFilter? | any | |
| contentSearchSpec? | any | |
| crowdingSpecs? | any | |
| customRankingParams? | any | |
| dataStoreSpecs? | any | |
| displaySpec? | any | |
| entity? | any | |
| facetSpecs? | any | |
| filter? | any | |
| imageQuery? | any | |
| languageCode? | any | |
| naturalLanguageQueryUnderstandingSpec? | any | |
| numResultsPerDataStore? | any | |
| offset? | any | |
| oneBoxPageSize? | any | |
| orderBy? | any | |
| pageCategories? | any | |
| pageSize? | any | |
| pageToken? | any | |
| params? | any | |
| query? | any | |
| queryExpansionSpec? | any | |
| rankingExpression? | any | |
| rankingExpressionBackend? | any | |
| relevanceScoreSpec? | any | |
| relevanceThreshold? | any | |
| safeSearch? | any | |
| searchAsYouTypeSpec? | any | |
| session? | any | |
| sessionSpec? | any | |
| spellCorrectionSpec? | any | |
| userInfo? | any | |
| userLabels? | any | |
| userPseudoId? | any |
stream_answerstream answer
| Argument | Type | Description |
|---|---|---|
| answerGenerationSpec? | any | |
| asynchronousMode? | any | |
| endUserSpec? | any | |
| groundingSpec? | any | |
| query? | any | |
| queryUnderstandingSpec? | any | |
| relatedQuestionsSpec? | any | |
| safetySpec? | any | |
| searchSpec? | any | |
| session? | any | |
| userLabels? | any | |
| userPseudoId? | any |
datastores_sitesearchengine_targetsites.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| exactMatch? | boolean | Immutable. 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. |
| failureReason? | object | This number is an estimation on how much total quota this project needs to successfully complete indexing. |
| providedUriPattern? | string | Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. |
| siteVerificationInfo? | object | Site verification state indicating the ownership and validity. |
| type? | enum | The type of the target site, e.g., whether the site is to be included or excluded. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a targetSites
getGet a targetSites
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the targetSites |
updateUpdate targetSites attributes
deleteDelete the targetSites
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the targetSites |
syncSync targetSites state from GCP
batch_createbatch create
| Argument | Type | Description |
|---|---|---|
| requests? | any |
datastores_controls.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| boostAction? | object | Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). |
| conditions? | array | End of time range. Range is inclusive. Must be in the future. |
| displayName? | string | Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| filterAction? | object | Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| name? | string | Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` |
| promoteAction? | object | Required. Data store with which this promotion is attached to. |
| redirectAction? | object | Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| solutionType? | enum | Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. |
| synonymsAction? | object | Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. |
| useCases? | array | Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. |
| controlId? | string | Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a controls
getGet a controls
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the controls |
updateUpdate controls attributes
deleteDelete the controls
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the controls |
syncSync controls state from GCP
collections_datastores_sessions_answers.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a answers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the answers |
syncSync answers state from GCP
datastores_schemas.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| jsonSchema? | string | The JSON representation of the schema. |
| 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. |
| structSchema? | record | The structured representation of the schema. |
| schemaId? | string | Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a schemas
getGet a schemas
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the schemas |
updateUpdate schemas attributes
deleteDelete the schemas
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the schemas |
syncSync schemas state from GCP
collections_engines_sessions.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| displayName? | string | Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. |
| isPinned? | boolean | Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. |
| labels? | array | Optional. The labels for the session. Can be set as filter in ListSessionsRequest. |
| name? | string | Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` |
| state? | enum | The state of the session. |
| turns? | array | Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. |
| userPseudoId? | string | A unique identifier for tracking users. |
| sessionId? | string | Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a sessions
getGet a sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
updateUpdate sessions attributes
deleteDelete the sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
syncSync sessions state from GCP
userstores_licenseconfigsusagestats.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
getGet a licenseConfigsUsageStats
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the licenseConfigsUsageStats |
syncSync licenseConfigsUsageStats state from GCP
collections_engines_sessions_answers.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
getGet a answers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the answers |
syncSync answers state from GCP
collections_engines.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| agentGatewaySetting? | object | Required. Immutable. The resource name of the agent gateway. Expected format: `projects/{project_number}/locations/{location}/agentGateways/{agent_gateway}`. |
| appType? | enum | Optional. Immutable. This the application type which this engine resource represents. NOTE: this is a new concept independ of existing industry vertical or solution type. |
| chatEngineConfig? | object | Name of the company, organization or other entity that the agent represents. Used for knowledge connector LLM prompt and for knowledge search. |
| cmekConfig? | object | Output only. The default CmekConfig for the Customer. |
| commonConfig? | object | The name of the company, business or entity that is associated with the engine. Setting this may help improve LLM related features. |
| configurableBillingApproach? | enum | Optional. Configuration for configurable billing approach. |
| connectorTenantInfo? | record | Optional. Maps a connector ID (e.g., "hybrid-github", "shopify") to tenant-specific information required for that connector. The structure of the tenant information string is connector-dependent. |
| dataStoreIds? | array | Optional. 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 DataStores 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. |
| disableAnalytics? | boolean | Optional. Whether to disable analytics for searches performed on this engine. |
| displayName? | string | Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. |
| features? | record | Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `disable-agent-sharing` * `disable-image-generation` * `disable-video-generation` * `disable-onedrive-upload` * `disable-talk-to-content` * `disable-google-drive-upload` * `disable-welcome-emails` * `disable-canvas` * `disable-canvas-workspace` * `disable-skills` |
| industryVertical? | enum | Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. |
| knowledgeGraphConfig? | object | Specify entity types to support. |
| marketplaceAgentVisibility? | enum | Optional. The visibility of marketplace agents in the agent gallery. |
| mediaRecommendationEngineConfig? | object | The time window of which the engine is queried at training and prediction time. Positive integers only. The value translates to the last X days of events. Currently required for the `most-popular-items` engine. |
| modelConfigs? | record | Optional. Maps a model name to its specific configuration for this engine. This allows admin users to turn on/off individual models. This only stores models whose states are overridden by the admin. When the state is unspecified, or model_configs is empty for this model, the system will decide if this model should be available or not based on the default configuration. For example, a preview model should be disabled by default if the admin has not chosen to enable it. |
| name? | string | Immutable. Identifier. 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}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*/. Otherwise, an INVALID_ARGUMENT error is returned. |
| observabilityConfig? | object | Optional. Enables observability. If `false`, all other flags are ignored. |
| procurementContactEmails? | array | Optional. The emails of the procurement contacts. |
| searchEngineConfig? | object | Optional. The required subscription tier of this engine. They cannot be modified after engine creation. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. |
| solutionType? | enum | Required. The solutions of the engine. |
| engineId? | 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](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a engines
getGet a engines
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the engines |
updateUpdate engines attributes
deleteDelete the engines
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the engines |
syncSync engines state from GCP
datastores_servingconfigs.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| answerGenerationSpec? | object | Optional. Whether or not to enable and include user defined classifier. |
| boostControlIds? | array | Boost controls to use in serving path. All triggered boost controls will be applied. Boost controls must be in the same data store as the serving config. Maximum of 20 boost controls. |
| displayName? | string | Required. The human readable serving config display name. Used in Discovery UI. This field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned. |
| dissociateControlIds? | array | Condition do not associate specifications. If multiple do not associate conditions match, all matching do not associate controls in the list will execute. Order does not matter. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. |
| diversityLevel? | string | How much diversity to use in recommendation model results e.g. `medium-diversity` or `high-diversity`. Currently supported values: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` If not specified, we choose default based on recommendation model type. Default value: `no-diversity`. Can only be set if SolutionType is SOLUTION_TYPE_RECOMMENDATION. |
| filterControlIds? | array | Filter controls to use in serving path. All triggered filter controls will be applied. Filter controls must be in the same data store as the serving config. Maximum of 20 filter controls. |
| genericConfig? | object | The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned. |
| ignoreControlIds? | array | Condition ignore specifications. If multiple ignore conditions match, all matching ignore controls in the list will execute. Order does not matter. Maximum number of specifications is 100. |
| mediaConfig? | object | Specifies the content freshness used for recommendation result. Contents will be demoted if contents were published for more than content freshness cutoff days. |
| modelId? | string | The id of the model to use at serving time. Currently only RecommendationModels are supported. Can be changed but only to a compatible model (e.g. others-you-may-like CTR to others-you-may-like CVR). Required when SolutionType is SOLUTION_TYPE_RECOMMENDATION. |
| name? | string | Immutable. Fully qualified name `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}/servingConfigs/{serving_config_id}` |
| onewaySynonymsControlIds? | array | Condition oneway synonyms specifications. If multiple oneway synonyms conditions match, all matching oneway synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. |
| promoteControlIds? | array | Condition promote specifications. Maximum number of specifications is 100. |
| rankingExpression? | string | The ranking expression controls the customized ranking on retrieval documents. To leverage this, document embedding is required. The ranking expression setting in ServingConfig applies to all search requests served by the serving config. However, if `SearchRequest.ranking_expression` is specified, it overrides the ServingConfig ranking expression. The ranking expression is a single function or multiple functions that are joined by "+". * ranking_expression = function, { " + ", function }; Supported functions: * double * relevance_score * double * dotProduct(embedding_field_path) Function variables: * `relevance_score`: pre-defined keywords, used for measure relevance between query and document. * `embedding_field_path`: the document embedding field used with query embedding vector. * `dotProduct`: embedding function between embedding_field_path and query embedding vector. Example ranking expression: If document has an embedding field doc_embedding, the ranking expression could be `0.5 * relevance_score + 0.3 * dotProduct(doc_embedding)`. |
| redirectControlIds? | array | IDs of the redirect controls. Only the first triggered redirect action is applied, even if multiple apply. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. |
| replacementControlIds? | array | Condition replacement specifications. Applied according to the order in the list. A previously replaced term can not be re-replaced. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. |
| solutionType? | enum | Required. Immutable. Specifies the solution type that a serving config can be associated with. |
| synonymsControlIds? | array | Condition synonyms specifications. If multiple synonyms conditions match, all matching synonyms controls in the list will execute. Maximum number of specifications is 100. Can only be set if SolutionType is SOLUTION_TYPE_SEARCH. |
| servingConfigId? | string | Required. The ID to use for the ServingConfig, which will become the final component of the ServingConfig's resource name. This value should be 4-63 characters, and valid characters are /a-zA-Z0-9+/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a servingConfigs
getGet a servingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the servingConfigs |
updateUpdate servingConfigs attributes
deleteDelete the servingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the servingConfigs |
syncSync servingConfigs state from GCP
answeranswer
| Argument | Type | Description |
|---|---|---|
| answerGenerationSpec? | any | |
| asynchronousMode? | any | |
| endUserSpec? | any | |
| groundingSpec? | any | |
| query? | any | |
| queryUnderstandingSpec? | any | |
| relatedQuestionsSpec? | any | |
| safetySpec? | any | |
| searchSpec? | any | |
| session? | any | |
| userLabels? | any | |
| userPseudoId? | any |
recommendrecommend
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| pageSize? | any | |
| params? | any | |
| userEvent? | any | |
| userLabels? | any | |
| validateOnly? | any |
searchsearch
| Argument | Type | Description |
|---|---|---|
| boostSpec? | any | |
| branch? | any | |
| canonicalFilter? | any | |
| contentSearchSpec? | any | |
| crowdingSpecs? | any | |
| customRankingParams? | any | |
| dataStoreSpecs? | any | |
| displaySpec? | any | |
| entity? | any | |
| facetSpecs? | any | |
| filter? | any | |
| imageQuery? | any | |
| languageCode? | any | |
| naturalLanguageQueryUnderstandingSpec? | any | |
| numResultsPerDataStore? | any | |
| offset? | any | |
| oneBoxPageSize? | any | |
| orderBy? | any | |
| pageCategories? | any | |
| pageSize? | any | |
| pageToken? | any | |
| params? | any | |
| query? | any | |
| queryExpansionSpec? | any | |
| rankingExpression? | any | |
| rankingExpressionBackend? | any | |
| relevanceScoreSpec? | any | |
| relevanceThreshold? | any | |
| safeSearch? | any | |
| searchAsYouTypeSpec? | any | |
| session? | any | |
| sessionSpec? | any | |
| spellCorrectionSpec? | any | |
| userInfo? | any | |
| userLabels? | any | |
| userPseudoId? | any |
search_litesearch lite
| Argument | Type | Description |
|---|---|---|
| boostSpec? | any | |
| branch? | any | |
| canonicalFilter? | any | |
| contentSearchSpec? | any | |
| crowdingSpecs? | any | |
| customRankingParams? | any | |
| dataStoreSpecs? | any | |
| displaySpec? | any | |
| entity? | any | |
| facetSpecs? | any | |
| filter? | any | |
| imageQuery? | any | |
| languageCode? | any | |
| naturalLanguageQueryUnderstandingSpec? | any | |
| numResultsPerDataStore? | any | |
| offset? | any | |
| oneBoxPageSize? | any | |
| orderBy? | any | |
| pageCategories? | any | |
| pageSize? | any | |
| pageToken? | any | |
| params? | any | |
| query? | any | |
| queryExpansionSpec? | any | |
| rankingExpression? | any | |
| rankingExpressionBackend? | any | |
| relevanceScoreSpec? | any | |
| relevanceThreshold? | any | |
| safeSearch? | any | |
| searchAsYouTypeSpec? | any | |
| session? | any | |
| sessionSpec? | any | |
| spellCorrectionSpec? | any | |
| userInfo? | any | |
| userLabels? | any | |
| userPseudoId? | any |
stream_answerstream answer
| Argument | Type | Description |
|---|---|---|
| answerGenerationSpec? | any | |
| asynchronousMode? | any | |
| endUserSpec? | any | |
| groundingSpec? | any | |
| query? | any | |
| queryUnderstandingSpec? | any | |
| relatedQuestionsSpec? | any | |
| safetySpec? | any | |
| searchSpec? | any | |
| session? | any | |
| userLabels? | any | |
| userPseudoId? | any |
datastores_branches_documents.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| aclInfo? | object | All users within the Identity Provider. |
| content? | object | The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `text/plain` (TXT) * `application/xml` or `text/xml` (XML) * `application/json` (JSON) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `application/vnd.openxmlformats-officedocument.spreadsheetml.sheet` (XLSX) * `application/vnd.ms-excel.sheet.macroenabled.12` (XLSM) The following types are supported only if layout parser is enabled in the data store: * `image/bmp` (BMP) * `image/gif` (GIF) * `image/jpeg` (JPEG) * `image/png` (PNG) * `image/tiff` (TIFF) See https://www.iana.org/assignments/media-types/media-types.xhtml. |
| id? | string | Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. |
| indexStatus? | object | The status code, which should be an enum value of google.rpc.Code. |
| jsonData? | string | The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. |
| 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. |
| parentDocumentId? | string | The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. |
| schemaId? | string | The identifier of the schema located in the same data store. |
| structData? | record | The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown. |
| documentId? | string | Required. The ID to use for the Document, which becomes 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](https://tools.ietf.org/html/rfc1034) standard with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a documents
getGet a documents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the documents |
updateUpdate documents attributes
deleteDelete the documents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the documents |
syncSync documents state from GCP
importimport
| Argument | Type | Description |
|---|---|---|
| alloyDbSource? | any | |
| autoGenerateIds? | any | |
| bigquerySource? | any | |
| bigtableSource? | any | |
| cloudSqlSource? | any | |
| errorConfig? | any | |
| fhirStoreSource? | any | |
| firestoreSource? | any | |
| forceRefreshContent? | any | |
| gcsSource? | any | |
| idField? | any | |
| inlineSource? | any | |
| reconciliationMode? | any | |
| spannerSource? | any | |
| updateMask? | any |
purgepurge
| Argument | Type | Description |
|---|---|---|
| errorConfig? | any | |
| filter? | any | |
| force? | any | |
| gcsSource? | any | |
| inlineSource? | any |
datastores_conversations.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| messages? | array | Output only. Message creation timestamp. |
| name? | string | Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. |
| state? | enum | The state of the Conversation. |
| userPseudoId? | string | A unique identifier for tracking users. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a conversations
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
updateUpdate conversations attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
syncSync conversations state from GCP
converseconverse
| Argument | Type | Description |
|---|---|---|
| boostSpec? | any | |
| conversation? | any | |
| filter? | any | |
| query? | any | |
| safeSearch? | any | |
| servingConfig? | any | |
| summarySpec? | any | |
| userLabels? | any |
collections_datastores_sessions.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| displayName? | string | Optional. The display name of the session. This field is used to identify the session in the UI. By default, the display name is the first turn query text in the session. |
| isPinned? | boolean | Optional. Whether the session is pinned, pinned session will be displayed on the top of the session list. |
| labels? | array | Optional. The labels for the session. Can be set as filter in ListSessionsRequest. |
| name? | string | Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` |
| state? | enum | The state of the session. |
| turns? | array | Optional. The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. |
| userPseudoId? | string | A unique identifier for tracking users. |
| sessionId? | string | Optional. The ID to use for the session, which will become the final component of the session's resource name. This value should be 1-63 characters, and valid characters are /a-z0-9{0,61}[a-z0-9]/. If not specified, a unique ID will be generated. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a sessions
getGet a sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
updateUpdate sessions attributes
deleteDelete the sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
syncSync sessions state from GCP
collections_datastores_controls.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| boostAction? | object | Strength of the boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0 (No-op). |
| conditions? | array | End of time range. Range is inclusive. Must be in the future. |
| displayName? | string | Required. Human readable name. The identifier used in UI views. Must be UTF-8 encoded string. Length limit is 128 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| filterAction? | object | Required. Specifies which data store's documents can be filtered by this control. Full data store name e.g. projects/123/locations/global/collections/default_collection/dataStores/default_data_store |
| name? | string | Immutable. Fully qualified name `projects/*/locations/global/dataStore/*/controls/*` |
| promoteAction? | object | Required. Data store with which this promotion is attached to. |
| redirectAction? | object | Required. The URI to which the shopper will be redirected. Required. URI must have length equal or less than 2000 characters. Otherwise an INVALID ARGUMENT error is thrown. |
| solutionType? | enum | Required. Immutable. What solution the control belongs to. Must be compatible with vertical of resource. Otherwise an INVALID ARGUMENT error is thrown. |
| synonymsAction? | object | Defines a set of synonyms. Can specify up to 100 synonyms. Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is thrown. |
| useCases? | array | Specifies the use case for the control. Affects what condition fields can be set. Only applies to SOLUTION_TYPE_SEARCH. Currently only allow one use case per control. Must be set when solution_type is SolutionType.SOLUTION_TYPE_SEARCH. |
| controlId? | string | Required. The ID to use for the Control, which will become the final component of the Control's resource name. This value must be within 1-63 characters. Valid characters are /a-z-_/. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a controls
getGet a controls
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the controls |
updateUpdate controls attributes
deleteDelete the controls
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the controls |
syncSync controls state from GCP
collections_engines_assistants.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| customerPolicy? | object | Optional. If true, diacritical marks (e.g., accents, umlauts) are ignored when matching banned phrases. For example, "cafe" would match "café". |
| defaultWebGroundingToggleOff? | boolean | Optional. This field controls the default web grounding toggle for end users if `web_grounding_type` is set to `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`. By default, this field is set to false. If `web_grounding_type` is `WEB_GROUNDING_TYPE_GOOGLE_SEARCH` or `WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH`, end users will have web grounding enabled by default on UI. If true, grounding toggle will be disabled by default on UI. End users can still enable web grounding in the UI if web grounding is enabled. |
| description? | string | Optional. Description for additional information. Expected to be shown on the configuration UI, not to the users of the assistant. |
| displayName? | string | Required. The assistant display name. It must be a UTF-8 encoded string with a length limit of 128 characters. |
| enabledTools? | record | The display name of the tool. |
| generationConfig? | object | Optional. The list of models that are allowed to be used for assistant. |
| name? | string | Immutable. Resource name of the assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` It must be a UTF-8 encoded string with a length limit of 1024 characters. |
| webGroundingType? | enum | Optional. The type of web grounding to use. |
| assistantId? | string | Required. The ID to use for the Assistant, which will become the final component of the Assistant's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with a length limit of 63 characters. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a assistants
getGet a assistants
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the assistants |
updateUpdate assistants attributes
deleteDelete the assistants
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the assistants |
syncSync assistants state from GCP
stream_assiststream assist
| Argument | Type | Description |
|---|---|---|
| generationSpec? | any | |
| query? | any | |
| session? | any | |
| toolsSpec? | any | |
| userMetadata? | any |
userstores.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| defaultLicenseConfig? | string | Optional. The default subscription LicenseConfig for the UserStore, if UserStore.enable_license_auto_register is true, new users will automatically register under the default subscription. If default LicenseConfig doesn't have remaining license seats left, new users will not be assigned with license and will be blocked for Vertex AI Search features. This is used if `license_assignment_tier_rules` is not configured. |
| displayName? | string | The display name of the User Store. |
| enableExpiredLicenseAutoUpdate? | boolean | Optional. Whether to enable license auto update for users in this User Store. If true, users with expired licenses will automatically be updated to use the default license config as long as the default license config has seats left. |
| enableLicenseAutoRegister? | boolean | Optional. Whether to enable license auto register for users in this User Store. If true, new users will automatically register under the default license config as long as the default license config has seats left. |
| name? | string | Immutable. The full resource name of the User Store, in the format of `projects/{project}/locations/{location}/userStores/{user_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
getGet a userStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the userStores |
updateUpdate userStores attributes
syncSync userStores state from GCP
batch_update_user_licensesbatch update user licenses
| Argument | Type | Description |
|---|---|---|
| deleteUnassignedUserLicenses? | any | |
| inlineSource? | any |
collections_datastores_conversations.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| messages? | array | Output only. Message creation timestamp. |
| name? | string | Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`. |
| state? | enum | The state of the Conversation. |
| userPseudoId? | string | A unique identifier for tracking users. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a conversations
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
getGet a conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
updateUpdate conversations attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
syncSync conversations state from GCP
converseconverse
| Argument | Type | Description |
|---|---|---|
| boostSpec? | any | |
| conversation? | any | |
| filter? | any | |
| query? | any | |
| safeSearch? | any | |
| servingConfig? | any | |
| summarySpec? | any | |
| userLabels? | any |
cmekconfigs.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| isDefault? | boolean | Output only. The default CmekConfig for the Customer. |
| kmsKey? | string | Required. KMS key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. |
| kmsKeyVersion? | string | Output only. KMS key version resource name which will be used to encrypt resources `/cryptoKeyVersions/{keyVersion}`. |
| lastRotationTimestampMicros? | string | Output only. The timestamp of the last key rotation. |
| name? | string | Required. The name of the CmekConfig of the form `projects/{project}/locations/{location}/cmekConfig` or `projects/{project}/locations/{location}/cmekConfigs/{cmek_config}`. |
| notebooklmState? | enum | Output only. Whether the NotebookLM Corpus is ready to be used. |
| singleRegionKeys? | array | Required. Single-regional kms key resource name which will be used to encrypt resources `projects/{project}/locations/{location}/keyRings/{keyRing}/cryptoKeys/{keyId}`. |
| state? | enum | Output only. The states of the CmekConfig. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
getGet a cmekConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the cmekConfigs |
updateUpdate cmekConfigs attributes
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
deleteDelete the cmekConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the cmekConfigs |
syncSync cmekConfigs state from GCP
identitymappingstores.tsv2026.04.23.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| cmekConfig? | object | Output only. The default CmekConfig for the Customer. |
| kmsKeyName? | string | Input only. The KMS key to be used to protect this Identity Mapping Store at creation time. Must be set for requests that need to comply with CMEK Org Policy protections. If this field is set and processed successfully, the Identity Mapping Store will be protected by the KMS key, as indicated in the cmek_config field. |
| name? | string | Immutable. The full resource name of the identity mapping store. Format: `projects/{project}/locations/{location}/identityMappingStores/{identity_mapping_store}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. |
| cmekConfigName? | string | Resource name of the CmekConfig to use for protecting this Identity Mapping Store. |
| disableCmek? | string | Identity Mapping Store without CMEK protections. If a default CmekConfig is set for the project, setting this field will override the default CmekConfig as well. |
| identityMappingStoreId? | string | Required. The ID of the Identity Mapping Store to create. The ID must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), and hyphens (-). The maximum length is 63 characters. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
createCreate a identityMappingStores
getGet a identityMappingStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the identityMappingStores |
deleteDelete the identityMappingStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the identityMappingStores |
syncSync identityMappingStores state from GCP
import_identity_mappingsimport identity mappings
| Argument | Type | Description |
|---|---|---|
| inlineSource? | any |
list_identity_mappingslist identity mappings
purge_identity_mappingspurge identity mappings
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| force? | any | |
| inlineSource? | any |
2026.04.14.1347.9 KBApr 14, 2026
Google Cloud discoveryengine infrastructure models
Release Notes
- Updated: collections_datastores_widgetconfigs, collections_engines, collections_engines_assistants, collections_engines_widgetconfigs, datastores_widgetconfigs, licenseconfigs
Changelog
Models
~methods: +import_identity_mappings, +list_identity_mappings, +purge_identity_mappings, -update
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddiscoveryenginecloudinfrastructure
2026.04.08.1333.1 KBApr 8, 2026
Google Cloud discoveryengine infrastructure models
Release Notes
- Updated: collections_datastores_servingconfigs, collections_datastores_sessions, collections_datastores_widgetconfigs, collections_engines, collections_engines_servingconfigs, collections_engines_sessions, collections_engines_widgetconfigs, datastores_servingconfigs, datastores_sessions, datastores_widgetconfigs, licenseconfigs, userstores_userlicenses
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddiscoveryenginecloudinfrastructure
2026.04.04.1329.9 KBApr 4, 2026
Google Cloud discoveryengine infrastructure models
Release Notes
- Updated: collections_datastores, collections_datastores_branches_documents, collections_datastores_conversations, collections_datastores_sessions, collections_datastores_sessions_answers, collections_datastores_widgetconfigs, collections_engines_assistants_agents_a2a_v1_tasks, collections_engines_conversations, collections_engines_sessions, collections_engines_sessions_answers, collections_engines_widgetconfigs, datastores, datastores_branches_documents, datastores_conversations, datastores_sessions, datastores_sessions_answers, datastores_widgetconfigs
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddiscoveryenginecloudinfrastructure
2026.04.03.3369.1 KBApr 3, 2026
Google Cloud discoveryengine infrastructure models
Release Notes
- Updated: cmekconfigs, collections_datastores, collections_datastores_branches_documents, collections_datastores_controls, collections_datastores_conversations, collections_datastores_custommodels, collections_datastores_schemas, collections_datastores_servingconfigs, collections_datastores_sessions, collections_datastores_sessions_answers, collections_datastores_sitesearchengine_targetsites, collections_datastores_widgetconfigs, collections_engines, collections_engines_assistants, collections_engines_assistants_agents_a2a_v1_tasks, collections_engines_assistants_agents_a2a_v1_tasks_pushnotificationconfigs, collections_engines_controls, collections_engines_conversations, collections_engines_servingconfigs, collections_engines_sessions, collections_engines_sessions_answers, collections_engines_widgetconfigs, datastores, datastores_branches_documents, datastores_controls, datastores_conversations, datastores_schemas, datastores_servingconfigs, datastores_sessions, datastores_sessions_answers, datastores_sitesearchengine_targetsites, datastores_widgetconfigs, identitymappingstores, licenseconfigs, userstores, userstores_licenseconfigsusagestats, userstores_userlicenses
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddiscoveryenginecloudinfrastructure
2026.04.03.1365.4 KBApr 3, 2026
Google Cloud discoveryengine infrastructure models
Release Notes
- Updated: cmekconfigs, collections_datastores, collections_datastores_branches_documents, collections_datastores_controls, collections_datastores_conversations, collections_datastores_custommodels, collections_datastores_schemas, collections_datastores_servingconfigs, collections_datastores_sessions, collections_datastores_sessions_answers, collections_datastores_sitesearchengine_targetsites, collections_datastores_widgetconfigs, collections_engines, collections_engines_assistants, collections_engines_assistants_agents_a2a_v1_tasks, collections_engines_assistants_agents_a2a_v1_tasks_pushnotificationconfigs, collections_engines_controls, collections_engines_conversations, collections_engines_servingconfigs, collections_engines_sessions, collections_engines_sessions_answers, collections_engines_widgetconfigs, datastores, datastores_branches_documents, datastores_controls, datastores_conversations, datastores_schemas, datastores_servingconfigs, datastores_sessions, datastores_sessions_answers, datastores_sitesearchengine_targetsites, datastores_widgetconfigs, identitymappingstores, licenseconfigs, userstores, userstores_licenseconfigsusagestats, userstores_userlicenses
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddiscoveryenginecloudinfrastructure
2026.04.02.2364.7 KBApr 2, 2026
Google Cloud discoveryengine infrastructure models
Changelog
Models
~methods: +create, +delete
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddiscoveryenginecloudinfrastructure
2026.03.27.1364.5 KBMar 27, 2026
Google Cloud discoveryengine infrastructure models
Release Notes
- Added: cmekconfigs, collections_datastores, collections_datastores_branches_documents, collections_datastores_controls, collections_datastores_conversations, collections_datastores_custommodels, collections_datastores_schemas, collections_datastores_servingconfigs, collections_datastores_sessions, collections_datastores_sessions_answers, collections_datastores_sitesearchengine_targetsites, collections_datastores_widgetconfigs, collections_engines, collections_engines_assistants, collections_engines_assistants_agents_a2a_v1_tasks, collections_engines_assistants_agents_a2a_v1_tasks_pushnotificationconfigs, collections_engines_controls, collections_engines_conversations, collections_engines_servingconfigs, collections_engines_sessions, collections_engines_sessions_answers, collections_engines_widgetconfigs, datastores, datastores_branches_documents, datastores_controls, datastores_conversations, datastores_schemas, datastores_servingconfigs, datastores_sessions, datastores_sessions_answers, datastores_sitesearchengine_targetsites, datastores_widgetconfigs, identitymappingstores, licenseconfigs, userstores, userstores_licenseconfigsusagestats, userstores_userlicenses
linux-x86_64linux-aarch64darwin-x86_64darwin-aarch64
gcpgoogle-clouddiscoveryenginecloudinfrastructure