Gcp/discoveryengine
@swamp/gcp/discoveryenginev2026.09.09.1
01README
Google Cloud discoveryengine infrastructure models
02Release Notes
- Updated: collections_datastores, collections_datastores_widgetconfigs, collections_engines, collections_engines_assistants, collections_engines_widgetconfigs, datastores, datastores_widgetconfigs
03Models
cmekconfigs.tsv2026.09.07.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| setDefault? | string | Set the following CmekConfig as the default to be used for child resources if one is not specified. |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a cmekConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the cmekConfigs |
fn update(identifier?: string, waitForReady?: boolean)
Update cmekConfigs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific cmekConfigs by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the cmekConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the cmekConfigs |
fn sync(identifier?: string)
Sync cmekConfigs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific cmekConfigs by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List cmekConfigs resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
collections_datastores.tsv2026.09.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| 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. |
| dataProtectionPolicy? | object | Optional. Specifies the resource name of the Sensitive Data Protection content policy. |
| 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 | Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. |
| 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. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a dataStores
fn get(identifier: string)
Get a dataStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataStores |
fn update(identifier?: string)
Update dataStores attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific dataStores by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the dataStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataStores |
fn sync(identifier?: string)
Sync dataStores state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific dataStores by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List dataStores resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` |
| pageSize? | number | Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn complete_query(includeTailSuggestions?: any, query?: any, queryModel?: any, userPseudoId?: any)
complete query
| Argument | Type | Description |
|---|---|---|
| includeTailSuggestions? | any | |
| query? | any | |
| queryModel? | any | |
| userPseudoId? | any |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn get_site_search_engine()
get site search engine
fn set_iam_policy(policy?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any |
fn train_custom_model(errorConfig?: any, gcsTrainingInput?: any, modelId?: any, modelType?: any)
train custom model
| Argument | Type | Description |
|---|---|---|
| errorConfig? | any | |
| gcsTrainingInput? | any | |
| modelId? | any | |
| modelType? | any |
collections_datastores_branches_documents.tsv2026.09.07.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| 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. |
| allowMissing? | string | If set to `true` and the Document is not found, a new Document is be created. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a documents
fn get(identifier: string)
Get a documents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the documents |
fn update(identifier?: string)
Update documents attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific documents by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the documents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the documents |
fn sync(identifier?: string)
Sync documents state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific documents by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List documents resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn import(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)
import
| 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 |
fn purge(errorConfig?: any, filter?: any, force?: any, gcsSource?: any, inlineSource?: any)
purge
| Argument | Type | Description |
|---|---|---|
| errorConfig? | any | |
| filter? | any | |
| force? | any | |
| gcsSource? | any | |
| inlineSource? | any |
collections_datastores_controls.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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-_/. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a controls
fn get(identifier: string)
Get a controls
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the controls |
fn update(identifier?: string)
Update controls attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific controls by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the controls
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the controls |
fn sync(identifier?: string)
Sync controls state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific controls by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List controls resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. |
| pageSize? | number | Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
collections_datastores_conversations.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a conversations
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
fn update(identifier?: string, waitForReady?: boolean)
Update conversations attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific conversations by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
fn sync(identifier?: string)
Sync conversations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific conversations by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List conversations resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" |
| orderBy? | string | A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" |
| pageSize? | number | Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn converse(boostSpec?: any, conversation?: any, filter?: any, query?: any, safeSearch?: any, servingConfig?: any, summarySpec?: any, userLabels?: any)
converse
| Argument | Type | Description |
|---|---|---|
| boostSpec? | any | |
| conversation? | any | |
| filter? | any | |
| query? | any | |
| safeSearch? | any | |
| servingConfig? | any | |
| summarySpec? | any | |
| userLabels? | any |
collections_datastores_custommodels.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| dataStore | string | Required. The resource name of the parent Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from. |
fn get(identifier: string)
Get a customModels
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the customModels |
fn sync(identifier?: string)
Sync customModels state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific customModels by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List customModels resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
collections_datastores_schemas.tsv2026.09.07.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| allowMissing? | string | If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a schemas
fn get(identifier: string)
Get a schemas
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the schemas |
fn update(identifier?: string)
Update schemas attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific schemas by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the schemas
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the schemas |
fn sync(identifier?: string)
Sync schemas state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific schemas by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List schemas resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
collections_datastores_servingconfigs.tsv2026.09.01.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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+/. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a servingConfigs
fn get(identifier: string)
Get a servingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the servingConfigs |
fn update(identifier?: string)
Update servingConfigs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific servingConfigs by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the servingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the servingConfigs |
fn sync(identifier?: string)
Sync servingConfigs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific servingConfigs by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List servingConfigs resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn answer(answerGenerationSpec?: any, asynchronousMode?: any, endUserSpec?: any, groundingSpec?: any, query?: any, queryUnderstandingSpec?: any, relatedQuestionsSpec?: any, safetySpec?: any, searchSpec?: any, session?: any, userLabels?: any, userPseudoId?: any)
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 |
fn recommend(filter?: any, pageSize?: any, params?: any, userEvent?: any, userLabels?: any, validateOnly?: any)
recommend
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| pageSize? | any | |
| params? | any | |
| userEvent? | any | |
| userLabels? | any | |
| validateOnly? | any |
fn search(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, relevanceFilterSpec?: any, relevanceScoreSpec?: any, relevanceThreshold?: any, safeSearch?: any, searchAddonSpec?: any, searchAsYouTypeSpec?: any, session?: any, sessionSpec?: any, spellCorrectionSpec?: any, userInfo?: any, userLabels?: any, userPseudoId?: any)
search
| 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 | |
| relevanceFilterSpec? | any | |
| relevanceScoreSpec? | any | |
| relevanceThreshold? | any | |
| safeSearch? | any | |
| searchAddonSpec? | any | |
| searchAsYouTypeSpec? | any | |
| session? | any | |
| sessionSpec? | any | |
| spellCorrectionSpec? | any | |
| userInfo? | any | |
| userLabels? | any | |
| userPseudoId? | any |
fn search_lite(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, relevanceFilterSpec?: any, relevanceScoreSpec?: any, relevanceThreshold?: any, safeSearch?: any, searchAddonSpec?: any, searchAsYouTypeSpec?: any, session?: any, sessionSpec?: any, spellCorrectionSpec?: any, userInfo?: any, userLabels?: any, userPseudoId?: any)
search 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 | |
| relevanceFilterSpec? | any | |
| relevanceScoreSpec? | any | |
| relevanceThreshold? | any | |
| safeSearch? | any | |
| searchAddonSpec? | any | |
| searchAsYouTypeSpec? | any | |
| session? | any | |
| sessionSpec? | any | |
| spellCorrectionSpec? | any | |
| userInfo? | any | |
| userLabels? | any | |
| userPseudoId? | any |
fn stream_answer(answerGenerationSpec?: any, asynchronousMode?: any, endUserSpec?: any, groundingSpec?: any, query?: any, queryUnderstandingSpec?: any, relatedQuestionsSpec?: any, safetySpec?: any, searchSpec?: any, session?: any, userLabels?: any, userPseudoId?: any)
stream 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_datastores_sessions.tsv2026.08.16.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a sessions
fn get(identifier: string)
Get a sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
fn update(identifier?: string)
Update sessions attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific sessions by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
fn sync(identifier?: string)
Sync sessions state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific sessions by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List sessions resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` |
| orderBy? | string | A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. |
| pageSize? | number | Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
collections_datastores_sessions_answers.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
fn get(identifier: string)
Get a answers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the answers |
fn sync(identifier?: string)
Sync answers state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific answers by name (e.g. one discovered by list) |
collections_datastores_sitesearchengine_targetsites.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| providedUriPattern? | string | Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. |
| type? | enum | The type of the target site, e.g., whether the site is to be included or excluded. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a targetSites
fn get(identifier: string)
Get a targetSites
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the targetSites |
fn update(identifier?: string)
Update targetSites attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific targetSites by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the targetSites
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the targetSites |
fn sync(identifier?: string)
Sync targetSites state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific targetSites by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List targetSites resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn batch_create(requests?: any)
batch create
| Argument | Type | Description |
|---|---|---|
| requests? | any |
collections_datastores_widgetconfigs.tsv2026.09.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| batchAuthStatuses? | array | Output only. The batch authorization group the placeholder belongs to. |
| collectionComponents? | array | Output only. The authorization state of the data connector. |
| 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 | Output only. The customer's Assured Workloads compliance level. `customer_type` collapses every compliance level into a single `GOVERNMENT_CUSTOMER` value, so a client that gates a feature on one specific level rather than on government status as a whole must read this field instead. |
| 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. |
fn get(identifier: string)
Get a widgetConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the widgetConfigs |
fn update(identifier?: string)
Update widgetConfigs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific widgetConfigs by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync widgetConfigs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific widgetConfigs by name (e.g. one discovered by list) |
collections_engines.tsv2026.09.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| 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` * `speech-to-text` * `feedback` * `session-sharing` * `personalization-memory` * `personalization-suggested-highlights` * `mobile-app-access` * `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` * `canvas-workspace` * `canvas-app-builder` * `skills` * `skill-sharing` * `skill-sharing-without-admin-approval` * `disable-projects` * `sobi` * `enable-end-user-sharing-with-groups` * `single-agent-orchestration` * `multi-agent-orchestration` * `cross-product-intelligence` * `workflow-agents` * `in-app-notifications` |
| 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. If the required subscription tier is search, user with higher license tier like assist can still access the standalone app associated with this engine. Web grounding feature is only available on the app if it is set as SubscriptionTier.SUBSCRIPTION_TIER_SEARCH_AND_ASSISTANT. |
| sessionConfig? | object | Optional. Session management policy that defines who will manage the session. |
| 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. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a engines
fn get(identifier: string)
Get a engines
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the engines |
fn update(identifier?: string)
Update engines attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific engines by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the engines
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the engines |
fn sync(identifier?: string)
Sync engines state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific engines by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List engines resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH |
| pageSize? | number | Optional. Not supported. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn set_iam_policy(policy?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any |
collections_engines_assistants.tsv2026.09.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a assistants
fn get(identifier: string)
Get a assistants
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the assistants |
fn update(identifier?: string)
Update assistants attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific assistants by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the assistants
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the assistants |
fn sync(identifier?: string)
Sync assistants state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific assistants by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List assistants resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Maximum number of Assistants to return. If unspecified, defaults to 100. The maximum allowed value is 1000; anything above that will be coerced down to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn stream_assist(agentsSpec?: any, generationSpec?: any, query?: any, session?: any, toolsSpec?: any, userMetadata?: any)
stream assist
| Argument | Type | Description |
|---|---|---|
| agentsSpec? | any | |
| generationSpec? | any | |
| query? | any | |
| session? | any | |
| toolsSpec? | any | |
| userMetadata? | any |
collections_engines_assistants_agents_a2a_v1_tasks.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| tenant | string | Optional tenant, provided as a path parameter. Experimental, might still change for 1.0 release. |
fn get(identifier: string)
Get a tasks
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the tasks |
fn sync(identifier?: string)
Sync tasks state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific tasks by name (e.g. one discovered by list) |
fn cancel()
cancel
fn subscribe()
subscribe
collections_engines_assistants_agents_a2a_v1_tasks_pushnotificationconfigs.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a pushNotificationConfigs
fn get(identifier: string)
Get a pushNotificationConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the pushNotificationConfigs |
fn delete(identifier: string)
Delete the pushNotificationConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the pushNotificationConfigs |
fn sync(identifier?: string)
Sync pushNotificationConfigs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific pushNotificationConfigs by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List pushNotificationConfigs resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | For AIP-158 these fields are present. Usually not used/needed. The maximum number of configurations to return. If unspecified, all configs will be returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
collections_engines_controls.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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-_/. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a controls
fn get(identifier: string)
Get a controls
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the controls |
fn update(identifier?: string)
Update controls attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific controls by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the controls
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the controls |
fn sync(identifier?: string)
Sync controls state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific controls by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List controls resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. |
| pageSize? | number | Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
collections_engines_conversations.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a conversations
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
fn update(identifier?: string, waitForReady?: boolean)
Update conversations attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific conversations by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
fn sync(identifier?: string)
Sync conversations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific conversations by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List conversations resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" |
| orderBy? | string | A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" |
| pageSize? | number | Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn converse(boostSpec?: any, conversation?: any, filter?: any, query?: any, safeSearch?: any, servingConfig?: any, summarySpec?: any, userLabels?: any)
converse
| Argument | Type | Description |
|---|---|---|
| boostSpec? | any | |
| conversation? | any | |
| filter? | any | |
| query? | any | |
| safeSearch? | any | |
| servingConfig? | any | |
| summarySpec? | any | |
| userLabels? | any |
collections_engines_servingconfigs.tsv2026.09.01.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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+/. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a servingConfigs
fn get(identifier: string)
Get a servingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the servingConfigs |
fn update(identifier?: string)
Update servingConfigs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific servingConfigs by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the servingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the servingConfigs |
fn sync(identifier?: string)
Sync servingConfigs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific servingConfigs by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List servingConfigs resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn answer(answerGenerationSpec?: any, asynchronousMode?: any, endUserSpec?: any, groundingSpec?: any, query?: any, queryUnderstandingSpec?: any, relatedQuestionsSpec?: any, safetySpec?: any, searchSpec?: any, session?: any, userLabels?: any, userPseudoId?: any)
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 |
fn recommend(filter?: any, pageSize?: any, params?: any, userEvent?: any, userLabels?: any, validateOnly?: any)
recommend
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| pageSize? | any | |
| params? | any | |
| userEvent? | any | |
| userLabels? | any | |
| validateOnly? | any |
fn search(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, relevanceFilterSpec?: any, relevanceScoreSpec?: any, relevanceThreshold?: any, safeSearch?: any, searchAddonSpec?: any, searchAsYouTypeSpec?: any, session?: any, sessionSpec?: any, spellCorrectionSpec?: any, userInfo?: any, userLabels?: any, userPseudoId?: any)
search
| 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 | |
| relevanceFilterSpec? | any | |
| relevanceScoreSpec? | any | |
| relevanceThreshold? | any | |
| safeSearch? | any | |
| searchAddonSpec? | any | |
| searchAsYouTypeSpec? | any | |
| session? | any | |
| sessionSpec? | any | |
| spellCorrectionSpec? | any | |
| userInfo? | any | |
| userLabels? | any | |
| userPseudoId? | any |
fn search_lite(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, relevanceFilterSpec?: any, relevanceScoreSpec?: any, relevanceThreshold?: any, safeSearch?: any, searchAddonSpec?: any, searchAsYouTypeSpec?: any, session?: any, sessionSpec?: any, spellCorrectionSpec?: any, userInfo?: any, userLabels?: any, userPseudoId?: any)
search 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 | |
| relevanceFilterSpec? | any | |
| relevanceScoreSpec? | any | |
| relevanceThreshold? | any | |
| safeSearch? | any | |
| searchAddonSpec? | any | |
| searchAsYouTypeSpec? | any | |
| session? | any | |
| sessionSpec? | any | |
| spellCorrectionSpec? | any | |
| userInfo? | any | |
| userLabels? | any | |
| userPseudoId? | any |
fn stream_answer(answerGenerationSpec?: any, asynchronousMode?: any, endUserSpec?: any, groundingSpec?: any, query?: any, queryUnderstandingSpec?: any, relatedQuestionsSpec?: any, safetySpec?: any, searchSpec?: any, session?: any, userLabels?: any, userPseudoId?: any)
stream 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_sessions.tsv2026.08.16.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a sessions
fn get(identifier: string)
Get a sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
fn update(identifier?: string)
Update sessions attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific sessions by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
fn sync(identifier?: string)
Sync sessions state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific sessions by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List sessions resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` |
| orderBy? | string | A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. |
| pageSize? | number | Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
collections_engines_sessions_answers.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
fn get(identifier: string)
Get a answers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the answers |
fn sync(identifier?: string)
Sync answers state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific answers by name (e.g. one discovered by list) |
collections_engines_widgetconfigs.tsv2026.09.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| batchAuthStatuses? | array | Output only. The batch authorization group the placeholder belongs to. |
| collectionComponents? | array | Output only. The authorization state of the data connector. |
| 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 | Output only. The customer's Assured Workloads compliance level. `customer_type` collapses every compliance level into a single `GOVERNMENT_CUSTOMER` value, so a client that gates a feature on one specific level rather than on government status as a whole must read this field instead. |
| 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. |
fn get(identifier: string)
Get a widgetConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the widgetConfigs |
fn update(identifier?: string)
Update widgetConfigs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific widgetConfigs by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync widgetConfigs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific widgetConfigs by name (e.g. one discovered by list) |
datastores.tsv2026.09.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| 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. |
| dataProtectionPolicy? | object | Optional. Specifies the resource name of the Sensitive Data Protection content policy. |
| 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 | Output only. Obfuscated Dasher customer ID. Derived by the server from the project's GCP organization at data store creation time; any value supplied in the request payload is ignored. |
| 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') |
fn create()
Create a dataStores
fn get(identifier: string)
Get a dataStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataStores |
fn update(identifier?: string)
Update dataStores attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific dataStores by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the dataStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the dataStores |
fn sync(identifier?: string)
Sync dataStores state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific dataStores by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List dataStores resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Filter by solution type . For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'` |
| pageSize? | number | Maximum number of DataStores to return. If unspecified, defaults to 10. The maximum allowed value is 50. Values above 50 will be coerced to 50. If this field is negative, an INVALID_ARGUMENT is returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn complete_query(includeTailSuggestions?: any, query?: any, queryModel?: any, userPseudoId?: any)
complete query
| Argument | Type | Description |
|---|---|---|
| includeTailSuggestions? | any | |
| query? | any | |
| queryModel? | any | |
| userPseudoId? | any |
fn get_iam_policy(options_requestedPolicyVersion?: any)
get iam policy
| Argument | Type | Description |
|---|---|---|
| options_requestedPolicyVersion? | any |
fn get_site_search_engine()
get site search engine
fn set_iam_policy(policy?: any)
set iam policy
| Argument | Type | Description |
|---|---|---|
| policy? | any |
datastores_branches_documents.tsv2026.09.07.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| 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. |
| allowMissing? | string | If set to `true` and the Document is not found, a new Document is be created. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a documents
fn get(identifier: string)
Get a documents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the documents |
fn update(identifier?: string)
Update documents attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific documents by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the documents
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the documents |
fn sync(identifier?: string)
Sync documents state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific documents by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List documents resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn import(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)
import
| 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 |
fn purge(errorConfig?: any, filter?: any, force?: any, gcsSource?: any, inlineSource?: any)
purge
| Argument | Type | Description |
|---|---|---|
| errorConfig? | any | |
| filter? | any | |
| force? | any | |
| gcsSource? | any | |
| inlineSource? | any |
datastores_controls.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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-_/. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a controls
fn get(identifier: string)
Get a controls
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the controls |
fn update(identifier?: string)
Update controls attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific controls by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the controls
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the controls |
fn sync(identifier?: string)
Sync controls state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific controls by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List controls resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. A filter to apply on the list results. Supported features: * List all the products under the parent branch if filter is unset. Currently this field is unsupported. |
| pageSize? | number | Optional. Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
datastores_conversations.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create(waitForReady?: boolean)
Create a conversations
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
fn update(identifier?: string, waitForReady?: boolean)
Update conversations attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific conversations by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn delete(identifier: string)
Delete the conversations
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the conversations |
fn sync(identifier?: string)
Sync conversations state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific conversations by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List conversations resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" |
| orderBy? | string | A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" |
| pageSize? | number | Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn converse(boostSpec?: any, conversation?: any, filter?: any, query?: any, safeSearch?: any, servingConfig?: any, summarySpec?: any, userLabels?: any)
converse
| Argument | Type | Description |
|---|---|---|
| boostSpec? | any | |
| conversation? | any | |
| filter? | any | |
| query? | any | |
| safeSearch? | any | |
| servingConfig? | any | |
| summarySpec? | any | |
| userLabels? | any |
datastores_schemas.tsv2026.09.07.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| allowMissing? | string | If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a schemas
fn get(identifier: string)
Get a schemas
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the schemas |
fn update(identifier?: string)
Update schemas attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific schemas by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the schemas
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the schemas |
fn sync(identifier?: string)
Sync schemas state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific schemas by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List schemas resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
datastores_servingconfigs.tsv2026.09.01.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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+/. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a servingConfigs
fn get(identifier: string)
Get a servingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the servingConfigs |
fn update(identifier?: string)
Update servingConfigs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific servingConfigs by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the servingConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the servingConfigs |
fn sync(identifier?: string)
Sync servingConfigs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific servingConfigs by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List servingConfigs resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Optional. Maximum number of results to return. If unspecified, defaults to 100. If a value greater than 100 is provided, at most 100 results are returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn answer(answerGenerationSpec?: any, asynchronousMode?: any, endUserSpec?: any, groundingSpec?: any, query?: any, queryUnderstandingSpec?: any, relatedQuestionsSpec?: any, safetySpec?: any, searchSpec?: any, session?: any, userLabels?: any, userPseudoId?: any)
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 |
fn recommend(filter?: any, pageSize?: any, params?: any, userEvent?: any, userLabels?: any, validateOnly?: any)
recommend
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| pageSize? | any | |
| params? | any | |
| userEvent? | any | |
| userLabels? | any | |
| validateOnly? | any |
fn search(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, relevanceFilterSpec?: any, relevanceScoreSpec?: any, relevanceThreshold?: any, safeSearch?: any, searchAddonSpec?: any, searchAsYouTypeSpec?: any, session?: any, sessionSpec?: any, spellCorrectionSpec?: any, userInfo?: any, userLabels?: any, userPseudoId?: any)
search
| 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 | |
| relevanceFilterSpec? | any | |
| relevanceScoreSpec? | any | |
| relevanceThreshold? | any | |
| safeSearch? | any | |
| searchAddonSpec? | any | |
| searchAsYouTypeSpec? | any | |
| session? | any | |
| sessionSpec? | any | |
| spellCorrectionSpec? | any | |
| userInfo? | any | |
| userLabels? | any | |
| userPseudoId? | any |
fn search_lite(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, relevanceFilterSpec?: any, relevanceScoreSpec?: any, relevanceThreshold?: any, safeSearch?: any, searchAddonSpec?: any, searchAsYouTypeSpec?: any, session?: any, sessionSpec?: any, spellCorrectionSpec?: any, userInfo?: any, userLabels?: any, userPseudoId?: any)
search 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 | |
| relevanceFilterSpec? | any | |
| relevanceScoreSpec? | any | |
| relevanceThreshold? | any | |
| safeSearch? | any | |
| searchAddonSpec? | any | |
| searchAsYouTypeSpec? | any | |
| session? | any | |
| sessionSpec? | any | |
| spellCorrectionSpec? | any | |
| userInfo? | any | |
| userLabels? | any | |
| userPseudoId? | any |
fn stream_answer(answerGenerationSpec?: any, asynchronousMode?: any, endUserSpec?: any, groundingSpec?: any, query?: any, queryUnderstandingSpec?: any, relatedQuestionsSpec?: any, safetySpec?: any, searchSpec?: any, session?: any, userLabels?: any, userPseudoId?: any)
stream 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_sessions.tsv2026.08.16.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a sessions
fn get(identifier: string)
Get a sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
fn update(identifier?: string)
Update sessions attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific sessions by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the sessions
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the sessions |
fn sync(identifier?: string)
Sync sessions state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific sessions by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List sessions resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | A comma-separated list of fields to filter by, in EBNF grammar. The supported fields are: * `user_pseudo_id` * `state` * `display_name` * `starred` * `is_pinned` * `labels` * `create_time` * `update_time` * `collaborative_project` Examples: * `user_pseudo_id = some_id` * `display_name = "some_name"` * `starred = true` * `is_pinned=true AND (NOT labels:hidden)` * `create_time > "1970-01-01T12:00:00Z"` * `collaborative_project = "projects/123/locations/global/collections/default_collection/engines/" "default_engine/collaborative_projects/cp1"` |
| orderBy? | string | A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` * `is_pinned` * `display_name` Example: * `update_time desc` * `create_time` * `is_pinned desc,update_time desc`: list sessions by is_pinned first, then by update_time. |
| pageSize? | number | Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
datastores_sessions_answers.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
fn get(identifier: string)
Get a answers
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the answers |
fn sync(identifier?: string)
Sync answers state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific answers by name (e.g. one discovered by list) |
datastores_sitesearchengine_targetsites.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| providedUriPattern? | string | Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. |
| type? | enum | The type of the target site, e.g., whether the site is to be included or excluded. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn create()
Create a targetSites
fn get(identifier: string)
Get a targetSites
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the targetSites |
fn update(identifier?: string)
Update targetSites attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific targetSites by name (e.g. one discovered by list) |
fn delete(identifier: string)
Delete the targetSites
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the targetSites |
fn sync(identifier?: string)
Sync targetSites state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific targetSites by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List targetSites resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn batch_create(requests?: any)
batch create
| Argument | Type | Description |
|---|---|---|
| requests? | any |
datastores_widgetconfigs.tsv2026.09.09.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
| batchAuthStatuses? | array | Output only. The batch authorization group the placeholder belongs to. |
| collectionComponents? | array | Output only. The authorization state of the data connector. |
| 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 | Output only. The customer's Assured Workloads compliance level. `customer_type` collapses every compliance level into a single `GOVERNMENT_CUSTOMER` value, so a client that gates a feature on one specific level rather than on government status as a whole must read this field instead. |
| 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. |
fn get(identifier: string)
Get a widgetConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the widgetConfigs |
fn update(identifier?: string)
Update widgetConfigs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific widgetConfigs by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync widgetConfigs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific widgetConfigs by name (e.g. one discovered by list) |
identitymappingstores.tsv2026.09.07.1
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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') |
fn create()
Create a identityMappingStores
fn get(identifier: string)
Get a identityMappingStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the identityMappingStores |
fn delete(identifier: string)
Delete the identityMappingStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the identityMappingStores |
fn sync(identifier?: string)
Sync identityMappingStores state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific identityMappingStores by name (e.g. one discovered by list) |
fn list(pageSize?: number, maxPages?: number)
List identityMappingStores resources
| Argument | Type | Description |
|---|---|---|
| pageSize? | number | Maximum number of IdentityMappingStores to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
fn import_identity_mappings(inlineSource?: any)
import identity mappings
| Argument | Type | Description |
|---|---|---|
| inlineSource? | any |
fn list_identity_mappings(pageSize?: any, pageToken?: any)
list identity mappings
| Argument | Type | Description |
|---|---|---|
| pageSize? | any | |
| pageToken? | any |
fn purge_identity_mappings(filter?: any, force?: any, inlineSource?: any)
purge identity mappings
| Argument | Type | Description |
|---|---|---|
| filter? | any | |
| force? | any | |
| inlineSource? | any |
licenseconfigs.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| autoRenew? | boolean | Optional. Whether the license config should be auto renewed when it reaches the end date. |
| 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. |
| lastUserUpdateTime? | string | Optional. Timestamp of the most recent user-initiated update (seat count change or subscription term change). Unlike `update_time`, this field is only stamped when a customer explicitly updates the license (e.g. via the UI), and is not touched by system-driven writes (subscription pipeline, BALC propagation, etc.). |
| 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') |
fn create(waitForReady?: boolean)
Create a licenseConfigs
| Argument | Type | Description |
|---|---|---|
| waitForReady? | boolean | Wait for the resource to reach a ready state after creation (default: true) |
fn get(identifier: string)
Get a licenseConfigs
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the licenseConfigs |
fn update(identifier?: string, waitForReady?: boolean)
Update licenseConfigs attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific licenseConfigs by name (e.g. one discovered by list) |
| waitForReady? | boolean | Wait for the resource to reach a ready state after update (default: true) |
fn sync(identifier?: string)
Sync licenseConfigs state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific licenseConfigs by name (e.g. one discovered by list) |
fn list(filter?: string, pageSize?: number, maxPages?: number)
List licenseConfigs resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. The filter to apply to the list results. The supported fields are: * `subscription_tier` * `state` Examples: * `subscription_tier=SUBSCRIPTION_TIER_SEARCH,state=ACTIVE` - Lists all active search license configs. * `state=ACTIVE` - Lists all active license configs. The filter string should be a comma-separated list of field=value pairs. |
| pageSize? | number | Optional. Not supported. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
userstores.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| 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. |
fn get(identifier: string)
Get a userStores
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the userStores |
fn update(identifier?: string)
Update userStores attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific userStores by name (e.g. one discovered by list) |
fn sync(identifier?: string)
Sync userStores state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific userStores by name (e.g. one discovered by list) |
fn batch_update_user_licenses(deleteUnassignedUserLicenses?: any, inlineSource?: any)
batch update user licenses
| Argument | Type | Description |
|---|---|---|
| deleteUnassignedUserLicenses? | any | |
| inlineSource? | any |
userstores_licenseconfigsusagestats.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a licenseConfigsUsageStats
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the licenseConfigsUsageStats |
fn sync(identifier?: string)
Sync licenseConfigsUsageStats state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific licenseConfigsUsageStats by name (e.g. one discovered by list) |
fn list(maxPages?: number)
List licenseConfigsUsageStats resources
| Argument | Type | Description |
|---|---|---|
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
userstores_userlicenses.tsv2026.08.12.2
Global Arguments
| Argument | Type | Description |
|---|---|---|
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| accessToken? | string | GCP OAuth2 access token; overrides GCP_ACCESS_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| credentialsJson? | string | GCP service account JSON credentials; overrides GOOGLE_APPLICATION_CREDENTIALS_JSON environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| project? | string | GCP project ID; overrides GCP_PROJECT / GOOGLE_CLOUD_PROJECT environment variables. |
| scopes? | string | Comma-separated OAuth scopes to request when minting access tokens via gcloud. Defaults to the API's Discovery Document scopes. |
| quotaProject? | string | GCP project ID for quota and billing attribution; sets the x-goog-user-project header. Overrides GOOGLE_CLOUD_QUOTA_PROJECT environment variable. Required for APIs like Cloud Identity when using user credentials. |
| apiEndpoint? | string | Custom API endpoint for emulators; overrides GCP_API_ENDPOINT environment variable. Defaults to the service's production URL. |
| parent? | string | The parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456) |
| location? | string | The location for this resource (e.g., 'us', 'us-central1', 'europe-west1') |
fn get(identifier: string)
Get a userLicenses
| Argument | Type | Description |
|---|---|---|
| identifier | string | The name of the userLicenses |
fn sync(identifier?: string)
Sync userLicenses state from GCP
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific userLicenses by name (e.g. one discovered by list) |
fn list(filter?: string, orderBy?: string, pageSize?: number, maxPages?: number)
List userLicenses resources
| Argument | Type | Description |
|---|---|---|
| filter? | string | Optional. Filter for the list request. Supported fields: * `license_assignment_state` * `user_principal` * Examples: * `license_assignment_state = ASSIGNED` to list assigned user licenses. * `license_assignment_state = NO_LICENSE` to list not licensed users. * `license_assignment_state = NO_LICENSE_ATTEMPTED_LOGIN` to list users who attempted login but no license assigned. * `license_assignment_state != NO_LICENSE_ATTEMPTED_LOGIN` to filter out users who attempted login but no license assigned. * `user_principal = user1@example.com` to list user license for `user1@example.com`. |
| orderBy? | string | Optional. The order in which the UserLicenses are listed. The value must be a comma-separated list of fields. Default sorting order is ascending. To specify descending order for a field, append a " desc" suffix. Redundant space characters in the syntax are insignificant. Supported fields (only `user_principal` is supported for now): * `user_principal` If not set, the default ordering is by `user_principal`. Examples: * `user_principal` to order by `user_principal` in ascending order. * `user_principal desc` to order by `user_principal` in descending order. |
| pageSize? | number | Optional. Requested page size. Server may return fewer items than requested. If unspecified, defaults to 100. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. |
| maxPages? | number | Maximum number of pages to fetch (default: 10) |
04Previous Versions
2026.09.07.2
- Updated: collections_datastores, collections_engines, datastores
2026.09.01.1
- Updated: collections_datastores, collections_datastores_servingconfigs, collections_datastores_widgetconfigs, collections_engines, collections_engines_servingconfigs, collections_engines_widgetconfigs, datastores, datastores_servingconfigs, datastores_widgetconfigs
2026.08.25.1
- Updated: collections_datastores_widgetconfigs, collections_engines_assistants, collections_engines_widgetconfigs, datastores_widgetconfigs
2026.08.16.1
- Updated: collections_datastores_sessions, collections_datastores_widgetconfigs, collections_engines, collections_engines_sessions, collections_engines_widgetconfigs, datastores_sessions, datastores_widgetconfigs
2026.08.14.1
- Updated: collections_datastores_servingconfigs, collections_datastores_widgetconfigs, collections_engines_servingconfigs, collections_engines_widgetconfigs, datastores_servingconfigs, datastores_widgetconfigs
2026.08.12.2
- 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
2026.08.06.1
- Updated: collections_datastores_widgetconfigs, collections_engines, collections_engines_widgetconfigs, datastores_widgetconfigs
2026.07.29.2
- 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
2026.07.29.1
- Updated: collections_datastores_widgetconfigs, collections_engines_widgetconfigs, datastores_widgetconfigs
2026.07.28.2
- Updated: collections_datastores_widgetconfigs, collections_engines_widgetconfigs, datastores_widgetconfigs
2026.07.28.1
- Updated: collections_datastores_widgetconfigs, collections_engines_widgetconfigs, datastores_widgetconfigs
2026.07.24.1
- Updated: collections_datastores_widgetconfigs, collections_engines, collections_engines_widgetconfigs, datastores_widgetconfigs
2026.07.21.4
- Updated: collections_datastores, collections_datastores_servingconfigs, collections_datastores_sessions, collections_datastores_widgetconfigs, collections_engines, collections_engines_assistants, collections_engines_servingconfigs, collections_engines_sessions, collections_engines_widgetconfigs, datastores, datastores_servingconfigs, datastores_sessions, datastores_widgetconfigs, licenseconfigs, userstores_userlicenses
2026.07.21.1
- Updated: collections_datastores, collections_datastores_branches_documents, collections_datastores_controls, collections_datastores_conversations, collections_datastores_servingconfigs, collections_datastores_sessions, collections_datastores_sitesearchengine_targetsites, collections_datastores_widgetconfigs, collections_engines, collections_engines_assistants, collections_engines_assistants_agents_a2a_v1_tasks_pushnotificationconfigs, collections_engines_controls, collections_engines_conversations, collections_engines_servingconfigs, collections_engines_sessions, collections_engines_widgetconfigs, datastores, datastores_branches_documents, datastores_controls, datastores_conversations, datastores_servingconfigs, datastores_sessions, datastores_sitesearchengine_targetsites, datastores_widgetconfigs, identitymappingstores, licenseconfigs
2026.07.20.2
- Updated: collections_datastores, collections_datastores_servingconfigs, collections_datastores_sessions, collections_datastores_widgetconfigs, collections_engines, collections_engines_assistants, collections_engines_servingconfigs, collections_engines_sessions, collections_engines_widgetconfigs, datastores, datastores_servingconfigs, datastores_sessions, datastores_widgetconfigs, licenseconfigs, userstores_userlicenses
2026.07.20.1
- 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
2026.07.19.2
- Updated: collections_datastores_custommodels, collections_engines_assistants_agents_a2a_v1_tasks
2026.07.19.1
- 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
2026.07.18.2
- 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
05Stats
A
100 / 100
Downloads
4
Archive size
727.0 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels