@maxim_mazurok/gapi.client.discoveryengine-v1beta 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=v1beta
-// Revision: 20240415
+// Revision: 20240503
 
 /// <reference types="gapi.client" />
 
@@ -260,6 +260,19 @@ declare namespace gapi.client {
       /** Operation last update time. If the operation is done, this is also the finish time. */
       updateTime?: string;
     }
+    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;
@@ -545,6 +558,10 @@ declare namespace gapi.client {
       /** Count of user events imported, but with Document information not found in the existing Branch. */
       unjoinedEventsCount?: string;
     }
+    interface GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse {
+      /** List of custom tuning models. */
+      models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
+    }
     interface GoogleCloudDiscoveryengineV1alphaProject {
       /** Output only. The timestamp when this project is created. */
       createTime?: string;
@@ -703,6 +720,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. */
@@ -731,6 +750,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;
     }
@@ -1105,12 +1126,14 @@ declare namespace gapi.client {
       tableId?: string;
     }
     interface GoogleCloudDiscoveryengineV1betaCheckGroundingRequest {
-      /** 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?: GoogleCloudDiscoveryengineV1betaGroundingFact[];
       /** Configuration of the grounding check. */
       groundingSpec?: GoogleCloudDiscoveryengineV1betaCheckGroundingSpec;
+      /** 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 GoogleCloudDiscoveryengineV1betaCheckGroundingResponse {
       /** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
@@ -1127,6 +1150,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;
     }
@@ -1258,6 +1283,19 @@ declare namespace gapi.client {
       /** The textual values of this custom attribute. For example, `["yellow", "green"]` when the key is "color". Empty string is not allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. Exactly one of CustomAttribute.text or CustomAttribute.numbers should be set. Otherwise, an `INVALID_ARGUMENT` error is returned. */
       text?: 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;
@@ -1446,6 +1484,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1betaFactChunk {
       /** 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. */
@@ -1615,6 +1655,10 @@ declare namespace gapi.client {
       /** Pagination token, if not returned indicates the last page. */
       nextPageToken?: string;
     }
+    interface GoogleCloudDiscoveryengineV1betaListCustomModelsResponse {
+      /** List of custom tuning models. */
+      models?: GoogleCloudDiscoveryengineV1betaCustomTuningModel[];
+    }
     interface GoogleCloudDiscoveryengineV1betaListDataStoresResponse {
       /** All the customer's DataStores. */
       dataStores?: GoogleCloudDiscoveryengineV1betaDataStore[];
@@ -1847,7 +1891,7 @@ declare namespace gapi.client {
       imageQuery?: GoogleCloudDiscoveryengineV1betaSearchRequestImageQuery;
       /** 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;
@@ -2252,6 +2296,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. */
@@ -2284,6 +2330,8 @@ declare namespace gapi.client {
       errorConfig?: GoogleCloudDiscoveryengineV1betaImportErrorConfig;
       /** Cloud Storage training input. */
       gcsTrainingInput?: GoogleCloudDiscoveryengineV1betaTrainCustomModelRequestGcsTrainingInput;
+      /** 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;
     }
@@ -2304,6 +2352,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;
     }
@@ -2657,6 +2707,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. */
@@ -3450,6 +3502,35 @@ declare namespace gapi.client {
         body: GoogleCloudDiscoveryengineV1betaConversation
       ): Request<GoogleCloudDiscoveryengineV1betaConversation>;
     }
+    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<GoogleCloudDiscoveryengineV1betaListCustomModelsResponse>;
+    }
     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?: {
@@ -5505,7 +5586,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;
@@ -5648,6 +5729,7 @@ declare namespace gapi.client {
       ): Request<GoogleLongrunningOperation>;
       branches: BranchesResource;
       conversations: ConversationsResource;
+      customModels: CustomModelsResource;
       models: ModelsResource;
       operations: OperationsResource;
       schemas: SchemasResource;
@@ -9427,7 +9509,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;

package/package.json

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