@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20240415 → 0.0.20240503

package/index.d.ts

@@ -9,7 +9,7 @@
 // This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
 // In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
 // Generated from: https://discoveryengine.googleapis.com/$discovery/rest?version=v1alpha
-// Revision: 20240415
+// Revision: 20240503
 
 /// <reference types="gapi.client" />
 
@@ -88,10 +88,6 @@ declare namespace gapi.client {
       /** Immutable. The full resource name of the acl configuration. Format: `projects/{project}/locations/{location}/aclConfig`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
       name?: string;
     }
-    interface GoogleCloudDiscoveryengineV1alphaAdditionalParams {
-      /** Token that used for non-human user check. */
-      token?: string;
-    }
     interface GoogleCloudDiscoveryengineV1alphaAnswer {
       /** Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
       answerSkippedReasons?: string[];
@@ -440,12 +436,14 @@ declare namespace gapi.client {
       tableId?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaCheckGroundingRequest {
-      /** Answer candidate to check. */
+      /** Answer candidate to check. Can have a maximum length of 1024 characters. */
       answerCandidate?: string;
       /** List of facts for the grounding check. We support up to 200 facts. */
       facts?: GoogleCloudDiscoveryengineV1alphaGroundingFact[];
       /** Configuration of the grounding check. */
       groundingSpec?: GoogleCloudDiscoveryengineV1alphaCheckGroundingSpec;
+      /** The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */
+      userLabels?: {[P in string]: string};
     }
     interface GoogleCloudDiscoveryengineV1alphaCheckGroundingResponse {
       /** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
@@ -462,6 +460,8 @@ declare namespace gapi.client {
       claimText?: string;
       /** Position indicating the end of the claim in the answer candidate, exclusive. */
       endPos?: number;
+      /** Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned. */
+      groundingCheckRequired?: boolean;
       /** Position indicating the start of the claim in the answer candidate, measured in bytes. */
       startPos?: number;
     }
@@ -519,18 +519,6 @@ declare namespace gapi.client {
       /** Required. The Cloud SQL table to copy the data from with a length limit of 256 characters. */
       tableId?: string;
     }
-    interface GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest {
-      /** Required. The parent data store resource name for which the completion is performed, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store`. */
-      dataStore?: string;
-      /** Indicates if tail suggestions should be returned if there are no suggestions that match the full query. Even if set to true, if there are suggestions that match the full query, those are returned and no tail suggestions are returned. */
-      includeTailSuggestions?: boolean;
-      /** Required. The typeahead input used to fetch suggestions. Maximum length is 128 characters. */
-      query?: string;
-      /** Specifies the autocomplete data model. This overrides any model specified in the Configuration > Autocomplete section of the Cloud console. Currently supported values: * `document` - Using suggestions generated from user-imported documents. * `search-history` - Using suggestions generated from the past history of SearchService.Search API calls. Do not use it when there is no traffic for Search API. * `user-event` - Using suggestions generated from user-imported search events. * `document-completable` - Using suggestions taken directly from user-imported document fields marked as completable. Default values: * `document` is the default model for regular dataStores. * `search-history` is the default model for site search dataStores. */
-      queryModel?: string;
-      /** A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. This should be the same identifier as UserEvent.user_pseudo_id and SearchRequest.user_pseudo_id. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
-      userPseudoId?: string;
-    }
     interface GoogleCloudDiscoveryengineV1alphaCompleteQueryResponse {
       /** Results of the matched query suggestions. The result list is ordered and the first result is a top suggestion. */
       querySuggestions?: GoogleCloudDiscoveryengineV1alphaCompleteQueryResponseQuerySuggestion[];
@@ -584,8 +572,6 @@ declare namespace gapi.client {
       conversation?: GoogleCloudDiscoveryengineV1alphaConversation;
       /** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
       filter?: string;
-      /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
-      name?: string;
       /** Required. Current user input. */
       query?: GoogleCloudDiscoveryengineV1alphaTextInput;
       /** Whether to turn on safe search. */
@@ -647,6 +633,19 @@ declare namespace gapi.client {
       /** Whether or not to enable and include custom fine tuned search adaptor model. */
       enableSearchAdaptor?: boolean;
     }
+    interface GoogleCloudDiscoveryengineV1alphaCustomTuningModel {
+      /** Timestamp the Model was created at. */
+      createTime?: string;
+      /** The display name of the model. */
+      displayName?: string;
+      /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
+      modelState?: string;
+      modelVersion?: string;
+      /** Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters. */
+      name?: string;
+      /** Timestamp the model training was initiated. */
+      trainingStartTime?: string;
+    }
     interface GoogleCloudDiscoveryengineV1alphaDataStore {
       /** 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. */
       aclEnabled?: boolean;
@@ -931,6 +930,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaFactChunk {
       /** Text content of the fact chunk. Can be at most 10K characters long. */
       chunkText?: string;
+      /** The index of this chunk. Currently, only used for the streaming mode. */
+      index?: number;
       /** Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved. */
       source?: string;
       /** More fine-grained information for the source reference. */
@@ -1146,6 +1147,10 @@ declare namespace gapi.client {
       /** Pagination token, if not returned indicates the last page. */
       nextPageToken?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse {
+      /** List of custom tuning models. */
+      models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
+    }
     interface GoogleCloudDiscoveryengineV1alphaListDataStoresResponse {
       /** All the customer's DataStores. */
       dataStores?: GoogleCloudDiscoveryengineV1alphaDataStore[];
@@ -1190,14 +1195,6 @@ declare namespace gapi.client {
       /** The total number of items matching the request. This will always be populated in the response. */
       totalSize?: number;
     }
-    interface GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest {
-      /** Required. The UUID of the Widget Config. */
-      widgetConfigId?: string;
-    }
-    interface GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse {
-      /** The Anonymous Widget Config associated with the UUID. */
-      anonymousWidgetConfig?: GoogleCloudDiscoveryengineV1alphaWidgetConfig;
-    }
     interface GoogleCloudDiscoveryengineV1alphaMediaInfo {
       /** The media progress time in seconds, if applicable. For example, if the end user has finished 90 seconds of a playback video, then MediaInfo.media_progress_duration.seconds should be set to 90. */
       mediaProgressDuration?: string;
@@ -1503,7 +1500,7 @@ declare namespace gapi.client {
       imageQuery?: GoogleCloudDiscoveryengineV1alphaSearchRequestImageQuery;
       /** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
       offset?: number;
-      /** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
+      /** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering for retail search, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
       orderBy?: string;
       /** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
       pageSize?: number;
@@ -1519,8 +1516,6 @@ declare namespace gapi.client {
       rankingExpression?: string;
       /** Whether to turn on safe search. This is only supported for website search. */
       safeSearch?: boolean;
-      /** Required. The resource name of the Search serving config, such as `projects/*‍/locations/global/collections/default_collection/engines/*‍/servingConfigs/default_serving_config`, or `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
-      servingConfig?: string;
       /** The spell correction specification that specifies the mode under which spell correction takes effect. */
       spellCorrectionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSpellCorrectionSpec;
       /** Information about the end user. Highly recommended for analytics. UserInfo.user_agent is used to deduce `device_type` for analytics. */
@@ -1928,6 +1923,8 @@ declare namespace gapi.client {
       name?: string;
       /** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
       providedUriPattern?: string;
+      /** Output only. Root domain of the provided_uri_pattern. */
+      rootDomainUri?: string;
       /** Output only. Site ownership and validity verification status. */
       siteVerificationInfo?: GoogleCloudDiscoveryengineV1alphaSiteVerificationInfo;
       /** The type of the target site, e.g., whether the site is to be included or excluded. */
@@ -1960,6 +1957,8 @@ declare namespace gapi.client {
       errorConfig?: GoogleCloudDiscoveryengineV1alphaImportErrorConfig;
       /** Cloud Storage training input. */
       gcsTrainingInput?: GoogleCloudDiscoveryengineV1alphaTrainCustomModelRequestGcsTrainingInput;
+      /** If not provided, a UUID will be generated. */
+      modelId?: string;
       /** Model to be trained. Supported values are: * **search-tuning**: Fine tuning the search system based on data provided. */
       modelType?: string;
     }
@@ -1980,6 +1979,8 @@ declare namespace gapi.client {
       errorSamples?: GoogleRpcStatus[];
       /** The metrics of the trained model. */
       metrics?: {[P in string]: number};
+      /** Fully qualified name of the CustomTuningModel. */
+      modelName?: string;
       /** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */
       modelStatus?: string;
     }
@@ -2061,158 +2062,6 @@ declare namespace gapi.client {
       /** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
       userId?: string;
     }
-    interface GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest {
-      /** Additional params for security and privacy enhancement. */
-      additionalParams?: GoogleCloudDiscoveryengineV1alphaAdditionalParams;
-      /** Required. The CompleteQuery request to perform auto-complete suggestion query. */
-      completeQueryRequest?: GoogleCloudDiscoveryengineV1alphaCompleteQueryRequest;
-      /** Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the auto complete query. */
-      configId?: string;
-    }
-    interface GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse {
-      /** The token in response. */
-      uToken?: string;
-      /** Results of the matched query suggestions in widget. The result list is ordered and the first result is a top suggestion. */
-      widgetQuerySuggestions?: GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion[];
-    }
-    interface GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponseWidgetQuerySuggestion {
-      /** The suggestion for the query. */
-      suggestion?: string;
-    }
-    interface GoogleCloudDiscoveryengineV1alphaWidgetConfig {
-      /** Allowlisted domains that can load this widget. */
-      allowlistedDomains?: string[];
-      /** Whether allow no-auth integration with widget. If set true, public access to search or other solutions from widget is allowed without authenication token provided by customer hosted backend server. */
-      allowPublicAccess?: boolean;
-      /** Output only. Collection components that lists all collections and child data stores associated with the widget config, those data sources can be used for filtering in widget service APIs, users can return results that from selected data sources. */
-      collectionComponents?: GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent[];
-      /** Output only. Unique obfuscated identifier of a WidgetConfig. */
-      configId?: string;
-      /** The content search spec that configs the desired behavior of content search. */
-      contentSearchSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpec;
-      /** Output only. Timestamp the WidgetConfig was created. */
-      createTime?: string;
-      /** Output only. The type of the parent data store. */
-      dataStoreType?: string;
-      /** Configurable UI configurations per data store. */
-      dataStoreUiConfigs?: GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig[];
-      /** 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. */
-      displayName?: string;
-      /** Whether or not to enable autocomplete. */
-      enableAutocomplete?: boolean;
-      /** Whether to allow conversational search (LLM, multi-turn) or not (non-LLM, single-turn). */
-      enableConversationalSearch?: boolean;
-      /** Turn on or off collecting the search result quality feedback from end users. */
-      enableQualityFeedback?: boolean;
-      /** Whether to show the result score. */
-      enableResultScore?: boolean;
-      /** Whether to enable safe search. */
-      enableSafeSearch?: boolean;
-      /** Whether to enable search-as-you-type behavior for the search widget */
-      enableSearchAsYouType?: boolean;
-      /** Turn on or off summary for each snippets result. */
-      enableSnippetResultSummary?: boolean;
-      /** Turn on or off summarization for the search response. */
-      enableSummarization?: boolean;
-      /** Whether to enable standalone web app. */
-      enableWebApp?: boolean;
-      /** The configuration and appearance of facets in the end user view. */
-      facetField?: GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
-      /** The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed. */
-      fieldsUiComponentsMap?: {
-        [P in string]: GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
-      };
-      /** Output only. The industry vertical that the WidgetConfig registers. The WidgetConfig industry vertical is based on the associated Engine. */
-      industryVertical?: string;
-      /** Output only. Whether LLM is enabled in the corresponding data store. */
-      llmEnabled?: boolean;
-      /** Output only. Whether the customer accepted data use terms. */
-      minimumDataTermAccepted?: boolean;
-      /** 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. */
-      name?: string;
-      /** The type of snippet to display in UCS widget. - RESULT_DISPLAY_TYPE_UNSPECIFIED for existing users. - SNIPPET for new non-enterprise search users. - EXTRACTIVE_ANSWER for new enterprise search users. */
-      resultDisplayType?: string;
-      /** Required. Immutable. Specifies the solution type that this WidgetConfig can be used for. */
-      solutionType?: string;
-      /** Output only. Timestamp the WidgetConfig was updated. */
-      updateTime?: string;
-    }
-    interface GoogleCloudDiscoveryengineV1alphaWidgetConfigCollectionComponent {
-      /** For the data store collection, list of the children data stores. */
-      dataStoreComponents?: GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent[];
-      /** The display name of the collection. */
-      displayName?: string;
-      /** Output only. the identifier of the collection, used for widget service. For now it refers to collection_id, in the future we will migrate the field to encrypted collection name UUID. */
-      id?: string;
-      /** The name of the collection. It should be collection resource name. Format: `projects/{project_number}/locations/{location}/collections/{collection_id}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field. */
-      name?: string;
-    }
-    interface GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreComponent {
-      /** The display name of the data store. */
-      displayName?: string;
-      /** Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. */
-      id?: string;
-      /** The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field. */
-      name?: string;
-    }
-    interface GoogleCloudDiscoveryengineV1alphaWidgetConfigDataStoreUiConfig {
-      /** Facet fields that store the mapping of fields to end user widget appearance. */
-      facetField?: GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField[];
-      /** The key is the UI component. Mock. Currently supported `title`, `thumbnail`, `url`, `custom1`, `custom2`, `custom3`. The value is the name of the field along with its device visibility. The 3 custom fields are optional and can be added or removed. `title`, `thumbnail`, `url` are required UI components that cannot be removed. */
-      fieldsUiComponentsMap?: {
-        [P in string]: GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField;
-      };
-      /** Output only. the identifier of the data store, used for widget service. For now it refers to data_store_id, in the future we will migrate the field to encrypted data store name UUID. */
-      id?: string;
-      /** The name of the data store. It should be data store resource name Format: `projects/{project_number}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. For APIs under WidgetService, such as LookUpWidgetConfig, the project number and location part is erased in this field. */
-      name?: string;
-    }
-    interface GoogleCloudDiscoveryengineV1alphaWidgetConfigFacetField {
-      /** Optional. The field name that end users will see. */
-      displayName?: string;
-      /** Required. Registered field name. The format is `field.abc`. */
-      field?: string;
-    }
-    interface GoogleCloudDiscoveryengineV1alphaWidgetConfigUIComponentField {
-      /** The field visibility on different types of devices. */
-      deviceVisibility?: string[];
-      /** The template to customize how the field is displayed. An example value would be a string that looks like: "Price: {value}". */
-      displayTemplate?: string;
-      /** Required. Registered field name. The format is `field.abc`. */
-      field?: string;
-    }
-    interface GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest {
-      /** Additional params for security and privacy enhancement. */
-      additionalParams?: GoogleCloudDiscoveryengineV1alphaAdditionalParams;
-      /** Required. The UUID of the WidgetConfig. This field is used to identify the widget configuration, set of models used to make the user event collection. */
-      configId?: string;
-      /** The id of the Conversation to get. Use "-" to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
-      conversationId?: string;
-      /** Required. The ConverseConversationRequest request to perform converse a conversation. The ServingConfig id will be `default_search` by default. */
-      converseConversationRequest?: GoogleCloudDiscoveryengineV1alphaConverseConversationRequest;
-    }
-    interface GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse {
-      /** The id of the Conversation returned. */
-      conversationId?: string;
-      /** ConverseConversationResponse returned from ConversationalSearchService.ConverseConversation. */
-      converseConversationResponse?: GoogleCloudDiscoveryengineV1alphaConverseConversationResponse;
-      /** The token in response. */
-      uToken?: string;
-    }
-    interface GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest {
-      /** Additional params for security and privacy enhancement. */
-      additionalParams?: GoogleCloudDiscoveryengineV1alphaAdditionalParams;
-      /** Required. The UUID of the Search WidgetConfig. This field is used to identify the search widget configuration, set of models used to make the search. */
-      configId?: string;
-      /** Required. The search request to perform search. */
-      searchRequest?: GoogleCloudDiscoveryengineV1alphaSearchRequest;
-    }
-    interface GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse {
-      /** The search response after performing search. */
-      searchResponse?: GoogleCloudDiscoveryengineV1alphaSearchResponse;
-      /** The token in response. */
-      uToken?: string;
-    }
     interface GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -2257,6 +2106,19 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
+    interface GoogleCloudDiscoveryengineV1betaCustomTuningModel {
+      /** Timestamp the Model was created at. */
+      createTime?: string;
+      /** The display name of the model. */
+      displayName?: string;
+      /** The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`). */
+      modelState?: string;
+      modelVersion?: string;
+      /** Required. The fully qualified resource name of the model. Format: `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}` model must be an alpha-numerical string with limit of 40 characters. */
+      name?: string;
+      /** Timestamp the model training was initiated. */
+      trainingStartTime?: string;
+    }
     interface GoogleCloudDiscoveryengineV1betaDataStore {
       /** Immutable. The content config of the data store. If this field is unset, the server behavior defaults to ContentConfig.NO_CONTENT. */
       contentConfig?: string;
@@ -2448,6 +2310,10 @@ declare namespace gapi.client {
       /** Count of user events imported, but with Document information not found in the existing Branch. */
       unjoinedEventsCount?: string;
     }
+    interface GoogleCloudDiscoveryengineV1betaListCustomModelsResponse {
+      /** List of custom tuning models. */
+      models?: GoogleCloudDiscoveryengineV1betaCustomTuningModel[];
+    }
     interface GoogleCloudDiscoveryengineV1betaPurgeDocumentsMetadata {
       /** Operation create time. */
       createTime?: string;
@@ -2505,6 +2371,8 @@ declare namespace gapi.client {
       name?: string;
       /** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
       providedUriPattern?: string;
+      /** Output only. Root domain of the provided_uri_pattern. */
+      rootDomainUri?: string;
       /** Output only. Site ownership and validity verification status. */
       siteVerificationInfo?: GoogleCloudDiscoveryengineV1betaSiteVerificationInfo;
       /** The type of the target site, e.g., whether the site is to be included or excluded. */
@@ -2533,6 +2401,8 @@ declare namespace gapi.client {
       errorSamples?: GoogleRpcStatus[];
       /** The metrics of the trained model. */
       metrics?: {[P in string]: number};
+      /** Fully qualified name of the CustomTuningModel. */
+      modelName?: string;
       /** The trained model status. Possible values are: * **bad-data**: The training data quality is bad. * **no-improvement**: Tuning didn't improve performance. Won't deploy. * **in-progress**: Model training job creation is in progress. * **training**: Model is actively training. * **evaluating**: The model is evaluating trained metrics. * **indexing**: The model trained metrics are indexing. * **ready**: The model is ready for serving. */
       modelStatus?: string;
     }
@@ -2825,6 +2695,8 @@ declare namespace gapi.client {
       name?: string;
       /** Required. Input only. The user provided URI pattern from which the `generated_uri_pattern` is generated. */
       providedUriPattern?: string;
+      /** Output only. Root domain of the provided_uri_pattern. */
+      rootDomainUri?: string;
       /** Output only. Site ownership and validity verification status. */
       siteVerificationInfo?: GoogleCloudDiscoveryengineV1SiteVerificationInfo;
       /** The type of the target site, e.g., whether the site is to be included or excluded. */
@@ -2887,240 +2759,6 @@ declare namespace gapi.client {
       /** Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year. */
       year?: number;
     }
-    interface LocationsResource {
-      /** Gets the Widget Config using the uuid. */
-      lookupWidgetConfig(request: {
-        /** V1 error format. */
-        '$.xgafv'?: string;
-        /** OAuth access token. */
-        access_token?: string;
-        /** Data format for response. */
-        alt?: string;
-        /** JSONP */
-        callback?: string;
-        /** Selector specifying which fields to include in a partial response. */
-        fields?: string;
-        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
-        key?: string;
-        /** Required. The location resource where lookup widget will be performed. Format: `locations/{location}` */
-        location: string;
-        /** OAuth 2.0 token for the current user. */
-        oauth_token?: string;
-        /** Returns response with indentations and line breaks. */
-        prettyPrint?: boolean;
-        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
-        quotaUser?: string;
-        /** Upload protocol for media (e.g. "raw", "multipart"). */
-        upload_protocol?: string;
-        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
-        uploadType?: string;
-        /** Request body */
-        resource: GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest;
-      }): Request<GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>;
-      lookupWidgetConfig(
-        request: {
-          /** V1 error format. */
-          '$.xgafv'?: string;
-          /** OAuth access token. */
-          access_token?: string;
-          /** Data format for response. */
-          alt?: string;
-          /** JSONP */
-          callback?: string;
-          /** Selector specifying which fields to include in a partial response. */
-          fields?: string;
-          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
-          key?: string;
-          /** Required. The location resource where lookup widget will be performed. Format: `locations/{location}` */
-          location: string;
-          /** OAuth 2.0 token for the current user. */
-          oauth_token?: string;
-          /** Returns response with indentations and line breaks. */
-          prettyPrint?: boolean;
-          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
-          quotaUser?: string;
-          /** Upload protocol for media (e.g. "raw", "multipart"). */
-          upload_protocol?: string;
-          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
-          uploadType?: string;
-        },
-        body: GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest
-      ): Request<GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse>;
-      /** Performs a user input completion with keyword suggestion. Similar to the CompletionService.CompleteQuery method, but a widget version that allows CompleteQuery without API Key. It supports CompleteQuery with or without JWT token. */
-      widgetCompleteQuery(request: {
-        /** V1 error format. */
-        '$.xgafv'?: string;
-        /** OAuth access token. */
-        access_token?: string;
-        /** Data format for response. */
-        alt?: string;
-        /** JSONP */
-        callback?: string;
-        /** Selector specifying which fields to include in a partial response. */
-        fields?: string;
-        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
-        key?: string;
-        /** Required. The location resource where widget complete query will be performed. Format: `locations/{location}` */
-        location: string;
-        /** OAuth 2.0 token for the current user. */
-        oauth_token?: string;
-        /** Returns response with indentations and line breaks. */
-        prettyPrint?: boolean;
-        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
-        quotaUser?: string;
-        /** Upload protocol for media (e.g. "raw", "multipart"). */
-        upload_protocol?: string;
-        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
-        uploadType?: string;
-        /** Request body */
-        resource: GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest;
-      }): Request<GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>;
-      widgetCompleteQuery(
-        request: {
-          /** V1 error format. */
-          '$.xgafv'?: string;
-          /** OAuth access token. */
-          access_token?: string;
-          /** Data format for response. */
-          alt?: string;
-          /** JSONP */
-          callback?: string;
-          /** Selector specifying which fields to include in a partial response. */
-          fields?: string;
-          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
-          key?: string;
-          /** Required. The location resource where widget complete query will be performed. Format: `locations/{location}` */
-          location: string;
-          /** OAuth 2.0 token for the current user. */
-          oauth_token?: string;
-          /** Returns response with indentations and line breaks. */
-          prettyPrint?: boolean;
-          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
-          quotaUser?: string;
-          /** Upload protocol for media (e.g. "raw", "multipart"). */
-          upload_protocol?: string;
-          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
-          uploadType?: string;
-        },
-        body: GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest
-      ): Request<GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse>;
-      /** Converse a conversation with Widget. */
-      widgetConverseConversation(request: {
-        /** V1 error format. */
-        '$.xgafv'?: string;
-        /** OAuth access token. */
-        access_token?: string;
-        /** Data format for response. */
-        alt?: string;
-        /** JSONP */
-        callback?: string;
-        /** Selector specifying which fields to include in a partial response. */
-        fields?: string;
-        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
-        key?: string;
-        /** Required. The location resource where widget converse conversation will be performed. Format: `locations/{location}` */
-        location: string;
-        /** OAuth 2.0 token for the current user. */
-        oauth_token?: string;
-        /** Returns response with indentations and line breaks. */
-        prettyPrint?: boolean;
-        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
-        quotaUser?: string;
-        /** Upload protocol for media (e.g. "raw", "multipart"). */
-        upload_protocol?: string;
-        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
-        uploadType?: string;
-        /** Request body */
-        resource: GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest;
-      }): Request<GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>;
-      widgetConverseConversation(
-        request: {
-          /** V1 error format. */
-          '$.xgafv'?: string;
-          /** OAuth access token. */
-          access_token?: string;
-          /** Data format for response. */
-          alt?: string;
-          /** JSONP */
-          callback?: string;
-          /** Selector specifying which fields to include in a partial response. */
-          fields?: string;
-          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
-          key?: string;
-          /** Required. The location resource where widget converse conversation will be performed. Format: `locations/{location}` */
-          location: string;
-          /** OAuth 2.0 token for the current user. */
-          oauth_token?: string;
-          /** Returns response with indentations and line breaks. */
-          prettyPrint?: boolean;
-          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
-          quotaUser?: string;
-          /** Upload protocol for media (e.g. "raw", "multipart"). */
-          upload_protocol?: string;
-          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
-          uploadType?: string;
-        },
-        body: GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest
-      ): Request<GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse>;
-      /** Performs a search. Similar to the SearchService.Search method, but a widget version that allows search without API Key. It supports search with or without JWT token. */
-      widgetSearch(request: {
-        /** V1 error format. */
-        '$.xgafv'?: string;
-        /** OAuth access token. */
-        access_token?: string;
-        /** Data format for response. */
-        alt?: string;
-        /** JSONP */
-        callback?: string;
-        /** Selector specifying which fields to include in a partial response. */
-        fields?: string;
-        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
-        key?: string;
-        /** Required. The location resource where widget search will be performed. Format: `locations/{location}` */
-        location: string;
-        /** OAuth 2.0 token for the current user. */
-        oauth_token?: string;
-        /** Returns response with indentations and line breaks. */
-        prettyPrint?: boolean;
-        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
-        quotaUser?: string;
-        /** Upload protocol for media (e.g. "raw", "multipart"). */
-        upload_protocol?: string;
-        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
-        uploadType?: string;
-        /** Request body */
-        resource: GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest;
-      }): Request<GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>;
-      widgetSearch(
-        request: {
-          /** V1 error format. */
-          '$.xgafv'?: string;
-          /** OAuth access token. */
-          access_token?: string;
-          /** Data format for response. */
-          alt?: string;
-          /** JSONP */
-          callback?: string;
-          /** Selector specifying which fields to include in a partial response. */
-          fields?: string;
-          /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
-          key?: string;
-          /** Required. The location resource where widget search will be performed. Format: `locations/{location}` */
-          location: string;
-          /** OAuth 2.0 token for the current user. */
-          oauth_token?: string;
-          /** Returns response with indentations and line breaks. */
-          prettyPrint?: boolean;
-          /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
-          quotaUser?: string;
-          /** Upload protocol for media (e.g. "raw", "multipart"). */
-          upload_protocol?: string;
-          /** Legacy upload protocol for media (e.g. "media", "multipart"). */
-          uploadType?: string;
-        },
-        body: GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest
-      ): Request<GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse>;
-    }
     interface OperationsResource {
       /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
       get(request?: {
@@ -3944,6 +3582,35 @@ declare namespace gapi.client {
         body: GoogleCloudDiscoveryengineV1alphaConversation
       ): Request<GoogleCloudDiscoveryengineV1alphaConversation>;
     }
+    interface CustomModelsResource {
+      /** Gets a list of all the custom models. */
+      list(request?: {
+        /** V1 error format. */
+        '$.xgafv'?: string;
+        /** OAuth access token. */
+        access_token?: string;
+        /** Data format for response. */
+        alt?: string;
+        /** JSONP */
+        callback?: 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. */
+        dataStore: string;
+        /** Selector specifying which fields to include in a partial response. */
+        fields?: string;
+        /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
+        key?: string;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Returns response with indentations and line breaks. */
+        prettyPrint?: boolean;
+        /** Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. */
+        quotaUser?: string;
+        /** Upload protocol for media (e.g. "raw", "multipart"). */
+        upload_protocol?: string;
+        /** Legacy upload protocol for media (e.g. "media", "multipart"). */
+        uploadType?: string;
+      }): Request<GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse>;
+    }
     interface OperationsResource {
       /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
       get(request?: {
@@ -6084,7 +5751,7 @@ declare namespace gapi.client {
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
-        /** Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
+        /** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
         filter?: string;
         /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
         key?: string;
@@ -6289,6 +5956,7 @@ declare namespace gapi.client {
       ): Request<GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfig>;
       branches: BranchesResource;
       conversations: ConversationsResource;
+      customModels: CustomModelsResource;
       models: ModelsResource;
       operations: OperationsResource;
       schemas: SchemasResource;
@@ -10245,7 +9913,7 @@ declare namespace gapi.client {
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
-        /** Filter by solution type. For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
+        /** Filter by solution type . For example: filter = 'solution_type:SOLUTION_TYPE_SEARCH' */
         filter?: string;
         /** API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token. */
         key?: string;
@@ -11070,8 +10738,6 @@ declare namespace gapi.client {
       operations: OperationsResource;
     }
 
-    const locations: LocationsResource;
-
     const projects: ProjectsResource;
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.discoveryengine-v1alpha",
-  "version": "0.0.20240415",
+  "version": "0.0.20240503",
   "description": "TypeScript typings for Discovery Engine API v1alpha",
   "repository": {
     "type": "git",

package/readme.md

@@ -69,34 +69,6 @@ gapi.auth.authorize(
 After that you can use Discovery Engine API resources: <!-- TODO: make this work for multiple namespaces -->
 
 ```typescript
-/*
-Gets the Widget Config using the uuid.
-*/
-await gapi.client.discoveryengine.locations.lookupWidgetConfig({
-  location: 'location',
-});
-
-/*
-Performs a user input completion with keyword suggestion. Similar to the CompletionService.CompleteQuery method, but a widget version that allows CompleteQuery without API Key. It supports CompleteQuery with or without JWT token.
-*/
-await gapi.client.discoveryengine.locations.widgetCompleteQuery({
-  location: 'location',
-});
-
-/*
-Converse a conversation with Widget.
-*/
-await gapi.client.discoveryengine.locations.widgetConverseConversation({
-  location: 'location',
-});
-
-/*
-Performs a search. Similar to the SearchService.Search method, but a widget version that allows search without API Key. It supports search with or without JWT token.
-*/
-await gapi.client.discoveryengine.locations.widgetSearch({
-  location: 'location',
-});
-
 /*
 Gets a Project. Returns NOT_FOUND when the project is not yet created.
 */