@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20241107 → 0.0.20241115

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: 20241107
+// Revision: 20241115
 
 /// <reference types="gapi.client" />
 
@@ -697,7 +697,7 @@ 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, anti_citation_indices, and score should not be returned. */
+      /** 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 should not be returned. */
       groundingCheckRequired?: boolean;
       /** Position indicating the start of the claim in the answer candidate, measured in bytes. */
       startPos?: number;
@@ -721,8 +721,8 @@ declare namespace gapi.client {
       requirement?: GoogleCloudDiscoveryengineV1alphaRequirement;
       /** The condition for evaluating the requirement result. */
       requirementCondition?: GoogleTypeExpr;
-      /** Requirement result, e.g. pass or fail. */
-      requirementResult?: string;
+      /** The result of the requirement. It should be one of the `severity` fields in the requirement definition. If any error happens during the evaluation, it will be `UNKNOWN`. */
+      result?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaCheckRequirementResponseMetricQueryResult {
       /** Type identifier of the metric corresponding to this query result. */
@@ -751,7 +751,7 @@ declare namespace gapi.client {
       name?: string;
       /** Page span of the chunk. */
       pageSpan?: GoogleCloudDiscoveryengineV1alphaChunkPageSpan;
-      /** Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchService.SearchResponse. */
+      /** Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on SearchResponse. */
       relevanceScore?: number;
     }
     interface GoogleCloudDiscoveryengineV1alphaChunkChunkMetadata {
@@ -1176,6 +1176,8 @@ declare namespace gapi.client {
       indexTime?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaDocumentInfo {
+      /** Optional. The conversion value associated with this Document. Must be set if UserEvent.event_type is "conversion". For example, a value of 1000 signifies that 1000 seconds were spent viewing a Document for the `watch` conversion type. */
+      conversionValue?: number;
       /** The Document resource ID. */
       id?: string;
       /** Output only. Whether the referenced Document can be found in the data store. */
@@ -1404,24 +1406,6 @@ declare namespace gapi.client {
       /** More fine-grained information for the source reference. */
       sourceMetadata?: {[P in string]: string};
     }
-    interface GoogleCloudDiscoveryengineV1alphaFeedback {
-      /** Optional. The additional user comment of the feedback if user gives a thumb down. */
-      comment?: string;
-      /** The related conversation information when user gives feedback. */
-      conversationInfo?: GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo;
-      /** Required. Indicate whether the user gives a positive or negative feedback. If the user gives a negative feedback, there might be more feedback details. */
-      feedbackType?: string;
-      /** The version of the LLM model that was used to generate the response. */
-      llmModelVersion?: string;
-      /** Optional. The reason if user gives a thumb down. */
-      reasons?: string[];
-    }
-    interface GoogleCloudDiscoveryengineV1alphaFeedbackConversationInfo {
-      /** The index of the user input within the conversation messages. */
-      questionIndex?: number;
-      /** Name of the newly generated or continued session. */
-      session?: string;
-    }
     interface GoogleCloudDiscoveryengineV1alphaFetchDomainVerificationStatusResponse {
       /** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
       nextPageToken?: string;
@@ -2021,7 +2005,7 @@ declare namespace gapi.client {
       content?: string;
       /** The unique ID to represent the record. */
       id?: string;
-      /** The score of this record based on the given query and selected model. */
+      /** The score of this record based on the given query and selected model. The score will be rounded to 2 decimal places. If the score is close to 0, it will be rounded to 0.0001 to avoid returning unset. */
       score?: number;
       /** The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. */
       title?: string;
@@ -2157,6 +2141,8 @@ declare namespace gapi.client {
       displayName?: string;
       /** A list of the metric bindings to be used in `condition`. */
       metricBindings?: GoogleCloudDiscoveryengineV1alphaRequirementMetricBinding[];
+      /** The severity of errors if the requirement is not met. It must be ordered from the most strict to the least strict. Examples: * `BLOCKING` * `CRITICAL` * `WARNING` All thresholds in the requirement must have all the severity here. */
+      severity?: string[];
       /** A list of threshold bindings to be used in `condition`. */
       thresholdBindings?: GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding[];
       /** The requirement type, used as an identifier. Must be unique. The type should prefix with service name to avoid possible collision. It's encouraged to use natural hierarchical grouping for similar requirements. Examples: * `library.googleapis.com/books/min_available_books` * `discoveryengine.googleapis.com/media_rec/recommended_for_you/conversion_rate` */
@@ -2177,14 +2163,18 @@ declare namespace gapi.client {
       variableId?: string;
     }
     interface GoogleCloudDiscoveryengineV1alphaRequirementThresholdBinding {
-      /** Threshold to trigger a blocking failure. If not met, the requirement will evaluate as a `FAILURE`. */
-      blockingThreshold?: number;
       /** Human readable description of the corresponding threshold and sub-requirement. */
       description?: string;
+      /** The values of the threshold. The values should be ordered from the most strict to the least strict. */
+      thresholdValues?: GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue[];
       /** The variable id to be referenced in `condition`. Must be unique across all `metric_bindings` and `threshold_bindings`. */
       variableId?: string;
-      /** Threshold to trigger a warning. If not met, the requirement will evaluate as a `WARNING`. */
-      warningThreshold?: number;
+    }
+    interface GoogleCloudDiscoveryengineV1alphaRequirementThresholdBindingThresholdValue {
+      /** The severity of errors if the threshold is not met. It should be one of the `severity` fields in the requirement. */
+      severity?: string;
+      /** The value of the threshold. */
+      value?: number;
     }
     interface GoogleCloudDiscoveryengineV1alphaRequirementViolationSamplesBinding {
       /** Description of this sample binding. Used by the UI to render user friendly descriptions for each requirement condition. Should be less than 128 characters long. */
@@ -2777,6 +2767,8 @@ declare namespace gapi.client {
     interface GoogleCloudDiscoveryengineV1alphaSessionTurn {
       /** The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */
       answer?: string;
+      /** Output only. In ConversationalSearchService.GetSession API, if GetSessionRequest.include_answer_details is set to true, this field will be populated when getting answer query session. */
+      detailedAnswer?: GoogleCloudDiscoveryengineV1alphaAnswer;
       /** The user query. */
       query?: GoogleCloudDiscoveryengineV1alphaQuery;
     }
@@ -2952,6 +2944,8 @@ declare namespace gapi.client {
       attributionToken?: string;
       /** CompletionService.CompleteQuery details related to the event. This field should be set for `search` event when autocomplete function is enabled and the user clicks a suggestion for search. */
       completionInfo?: GoogleCloudDiscoveryengineV1alphaCompletionInfo;
+      /** Optional. Conversion type. Required if UserEvent.event_type is `conversion`. This is a customer-defined conversion name in lowercase letters or numbers separated by "-", such as "watch", "good-visit" etc. Do not set the field if UserEvent.event_type is not `conversion`. This mixes the custom conversion event with predefined events like `search`, `view-item` etc. */
+      conversionType?: string;
       /** The DataStore resource full name, of the form `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`. Optional. Only required for user events whose data store can't by determined by UserEvent.engine or UserEvent.documents. If data store is set in the parent of write/import/collect user event requests, this field can be omitted. */
       dataStore?: string;
       /** Should set to true if the request is made directly from the end user, in which case the UserEvent.user_info.user_agent can be populated from the HTTP request. This flag should be set only if the API request is made directly from the end user such as a mobile app (and not if a gateway or a server is processing and pushing the user events). This should not be set when using the JavaScript tag in UserEventService.CollectUserEvent. */
@@ -2962,10 +2956,8 @@ declare namespace gapi.client {
       engine?: string;
       /** Only required for UserEventService.ImportUserEvents method. Timestamp of when the user event happened. */
       eventTime?: string;
-      /** Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. */
+      /** Required. User event type. Allowed values are: Generic values: * `search`: Search for Documents. * `view-item`: Detailed page view of a Document. * `view-item-list`: View of a panel or ordered list of Documents. * `view-home-page`: View of the home page. * `view-category-page`: View of a category page, e.g. Home > Men > Jeans * `add-feedback`: Add a user feedback. Retail-related values: * `add-to-cart`: Add an item(s) to cart, e.g. in Retail online shopping * `purchase`: Purchase an item(s) Media-related values: * `media-play`: Start/resume watching a video, playing a song, etc. * `media-complete`: Finished or stopped midway through a video, song, etc. Custom conversion value: * `conversion`: Customer defined conversion event. */
       eventType?: string;
-      /** Optional. This field is optional except for the `add-feedback` event types. */
-      feedback?: GoogleCloudDiscoveryengineV1alphaFeedback;
       /** The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. One example is for `search` events, the associated SearchRequest may contain a filter expression in SearchRequest.filter conforming to https://google.aip.dev/160#filtering. Similarly, for `view-item-list` events that are generated from a RecommendRequest, this field may be populated directly from RecommendRequest.filter conforming to https://google.aip.dev/160#filtering. The value must be a UTF-8 encoded string with a length limit of 1,000 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
       filter?: string;
       /** Media-specific info. */
@@ -14716,6 +14708,64 @@ declare namespace gapi.client {
         /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
         userEvent?: string;
       }): Request<GoogleApiHttpBody>;
+      /** Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. */
+      import(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;
+        /** OAuth 2.0 token for the current user. */
+        oauth_token?: string;
+        /** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
+        parent: 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: GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest;
+      }): Request<GoogleLongrunningOperation>;
+      import(
+        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;
+          /** OAuth 2.0 token for the current user. */
+          oauth_token?: string;
+          /** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
+          parent: 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: GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest
+      ): Request<GoogleLongrunningOperation>;
       /** Writes a single user event. */
       write(request: {
         /** V1 error format. */

package/package.json

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