@maxim_mazurok/gapi.client.dialogflow-v2 0.0.20240607 → 0.0.20240617

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://dialogflow.googleapis.com/$discovery/rest?version=v2
-// Revision: 20240607
+// Revision: 20240617
 
 /// <reference types="gapi.client" />
 
@@ -709,9 +709,9 @@ declare namespace gapi.client {
       testTime?: string;
     }
     interface GoogleCloudDialogflowCxV3beta1TestConfig {
-      /** Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. */
+      /** Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */
       flow?: string;
-      /** The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. */
+      /** The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */
       page?: string;
       /** Session parameters to be compared when calculating differences. */
       trackingParameters?: string[];
@@ -1499,9 +1499,9 @@ declare namespace gapi.client {
       testTime?: string;
     }
     interface GoogleCloudDialogflowCxV3TestConfig {
-      /** Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. */
+      /** Flow name to start the test case with. Format: `projects//locations//agents//flows/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */
       flow?: string;
-      /** The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If both are set, `page` takes precedence over `flow`. If neither is set, the test case will start with start page on the default start flow. */
+      /** The page to start the test case with. Format: `projects//locations//agents//flows//pages/`. Only one of `flow` and `page` should be set to indicate the starting point of the test case. If neither is set, the test case will start with start page on the default start flow. */
       page?: string;
       /** Session parameters to be compared when calculating differences. */
       trackingParameters?: string[];
@@ -2759,13 +2759,13 @@ declare namespace gapi.client {
     interface GoogleCloudDialogflowV2Conversation {
       /** Required. The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: `projects//locations//conversationProfiles/`. */
       conversationProfile?: string;
-      /** The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE. */
+      /** Optional. The stage of a conversation. It indicates whether the virtual agent or a human agent is handling the conversation. If the conversation is created with the conversation profile that has Dialogflow config set, defaults to ConversationStage.VIRTUAL_AGENT_STAGE; Otherwise, defaults to ConversationStage.HUMAN_ASSIST_STAGE. If the conversation is created with the conversation profile that has Dialogflow config set but explicitly sets conversation_stage to ConversationStage.HUMAN_ASSIST_STAGE, it skips ConversationStage.VIRTUAL_AGENT_STAGE stage and directly goes to ConversationStage.HUMAN_ASSIST_STAGE. */
       conversationStage?: string;
       /** Output only. The time the conversation was finished. */
       endTime?: string;
       /** Output only. The current state of the Conversation. */
       lifecycleState?: string;
-      /** Output only. The unique identifier of this conversation. Format: `projects//locations//conversations/`. */
+      /** Output only. Identifier. The unique identifier of this conversation. Format: `projects//locations//conversations/`. */
       name?: string;
       /** Output only. It will not be empty if the conversation is to be connected over telephony. */
       phoneNumber?: GoogleCloudDialogflowV2ConversationPhoneNumber;
@@ -3161,9 +3161,9 @@ declare namespace gapi.client {
     interface GoogleCloudDialogflowV2GenerateStatelessSummaryRequest {
       /** Required. A ConversationProfile containing information required for Summary generation. Required fields: {language_code, security_settings} Optional fields: {agent_assistant_config} */
       conversationProfile?: GoogleCloudDialogflowV2ConversationProfile;
-      /** The name of the latest conversation message used as context for generating a Summary. If empty, the latest message of the conversation will be used. The format is specific to the user and the names of the messages provided. */
+      /** Optional. The name of the latest conversation message used as context for generating a Summary. If empty, the latest message of the conversation will be used. The format is specific to the user and the names of the messages provided. */
       latestMessage?: string;
-      /** Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 500 and at most 1000. */
+      /** Optional. Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 500 and at most 1000. */
       maxContextSize?: number;
       /** Required. The conversation to suggest a summary for. */
       statelessConversation?: GoogleCloudDialogflowV2GenerateStatelessSummaryRequestMinimalConversation;
@@ -4089,17 +4089,17 @@ declare namespace gapi.client {
       uri?: string;
     }
     interface GoogleCloudDialogflowV2SearchKnowledgeRequest {
-      /** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
+      /** Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
       conversation?: string;
       /** Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`. */
       conversationProfile?: string;
-      /** The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. */
+      /** Optional. The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. */
       latestMessage?: string;
-      /** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
+      /** Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
       parent?: string;
       /** Required. The natural language text query for knowledge search. */
       query?: GoogleCloudDialogflowV2TextInput;
-      /** The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. */
+      /** Optional. The ID of the search session. The session_id can be combined with Dialogflow V3 Agent ID retrieved from conversation profile or on its own to identify a search session. The search history of the same session will impact the search result. It's up to the API caller to choose an appropriate `Session ID`. It can be a random number or some type of session identifiers (preferably hashed). The length must not exceed 36 characters. */
       sessionId?: string;
     }
     interface GoogleCloudDialogflowV2SearchKnowledgeResponse {
@@ -4179,8 +4179,18 @@ declare namespace gapi.client {
       phrases?: string[];
     }
     interface GoogleCloudDialogflowV2SpeechToTextConfig {
+      /** Defines the list of other language codes in addition to the one provided by the conversation profile that may be detected as the language code for the utterances over the conversation. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. */
+      alternativeLanguageCodes?: string[];
+      /** Audio encoding of the audio content to process. */
+      audioEncoding?: string;
+      /** If `true`, Dialogflow returns SpeechWordInfo in StreamingRecognitionResult with information about the recognized speech words, e.g. start and end time offsets. If false or unspecified, Speech doesn't return any word-level information. */
+      enableWordInfo?: boolean;
+      /** The language of the supplied audio. Dialogflow does not do translations. See [Language Support](https://cloud.google.com/dialogflow/docs/reference/language) for a list of the currently supported language codes. Note that queries in the same session do not necessarily need to specify the same language. */
+      languageCode?: string;
       /** Which Speech model to select. Select the model best suited to your domain to get best results. If a model is not explicitly specified, then Dialogflow auto-selects a model based on other parameters in the SpeechToTextConfig and Agent settings. If enhanced speech model is enabled for the agent and an enhanced version of the specified model for the language does not exist, then the speech is recognized using the standard version of the specified model. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics#select-model) for more details. If you specify a model, the following models typically have the best performance: - phone_call (best for Agent Assist and telephony) - latest_short (best for Dialogflow non-telephony) - command_and_search Leave this field unspecified to use [Agent Speech settings](https://cloud.google.com/dialogflow/cx/docs/concept/agent#settings-speech) for model selection. */
       model?: string;
+      /** Sample rate (in Hertz) of the audio content sent in the query. Refer to [Cloud Speech API documentation](https://cloud.google.com/speech-to-text/docs/basics) for more details. */
+      sampleRateHertz?: number;
       /** The speech model used in speech to text. `SPEECH_MODEL_VARIANT_UNSPECIFIED`, `USE_BEST_AVAILABLE` will be treated as `USE_ENHANCED`. It can be overridden in AnalyzeContentRequest and StreamingAnalyzeContentRequest request. If enhanced model variant is specified and an enhanced version of the specified model for the language does not exist, then it would emit an error. */
       speechModelVariant?: string;
       /** Use timeout based endpointing, interpreting endpointer sensitivy as seconds of timeout value. */
@@ -4203,11 +4213,11 @@ declare namespace gapi.client {
       latestMessage?: string;
     }
     interface GoogleCloudDialogflowV2SuggestConversationSummaryRequest {
-      /** Parameters for a human assist query. Only used for POC/demo purpose. */
+      /** Optional. Parameters for a human assist query. Only used for POC/demo purpose. */
       assistQueryParams?: GoogleCloudDialogflowV2AssistQueryParameters;
-      /** Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 500 and at most 1000. */
+      /** Optional. Max number of messages prior to and including [latest_message] to use as context when compiling the suggestion. By default 500 and at most 1000. */
       contextSize?: number;
-      /** The name of the latest conversation message used as context for compiling suggestion. If empty, the latest message of the conversation will be used. Format: `projects//locations//conversations//messages/`. */
+      /** Optional. The name of the latest conversation message used as context for compiling suggestion. If empty, the latest message of the conversation will be used. Format: `projects//locations//conversations//messages/`. */
       latestMessage?: string;
     }
     interface GoogleCloudDialogflowV2SuggestConversationSummaryResponse {
@@ -9136,7 +9146,7 @@ declare namespace gapi.client {
         alt?: string;
         /** JSONP */
         callback?: string;
-        /** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
+        /** Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
         conversation: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
@@ -9165,7 +9175,7 @@ declare namespace gapi.client {
           alt?: string;
           /** JSONP */
           callback?: string;
-          /** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
+          /** Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
           conversation: string;
           /** Selector specifying which fields to include in a partial response. */
           fields?: string;
@@ -9403,7 +9413,7 @@ declare namespace gapi.client {
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
-        /** A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering: - The value must be a string, a number, or a boolean. - The comparison operator must be either `=`,`!=`, `>`, or `<`. - To filter on multiple expressions, separate the expressions with `AND` or `OR` (omitting both implies `AND`). - For clarity, expressions can be enclosed in parentheses. Only `lifecycle_state` can be filtered on in this way. For example, the following expression only returns `COMPLETED` conversations: `lifecycle_state = "COMPLETED"` For more information about filtering, see [API Filtering](https://aip.dev/160). */
+        /** Optional. A filter expression that filters conversations listed in the response. Only `lifecycle_state` can be filtered on in this way. For example, the following expression only returns `COMPLETED` conversations: `lifecycle_state = "COMPLETED"` For more information about filtering, see [API Filtering](https://aip.dev/160). */
         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;
@@ -14388,7 +14398,7 @@ declare namespace gapi.client {
         alt?: string;
         /** JSONP */
         callback?: string;
-        /** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
+        /** Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
         conversation: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
@@ -14417,7 +14427,7 @@ declare namespace gapi.client {
           alt?: string;
           /** JSONP */
           callback?: string;
-          /** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
+          /** Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
           conversation: string;
           /** Selector specifying which fields to include in a partial response. */
           fields?: string;
@@ -14655,7 +14665,7 @@ declare namespace gapi.client {
         callback?: string;
         /** Selector specifying which fields to include in a partial response. */
         fields?: string;
-        /** A filter expression that filters conversations listed in the response. In general, the expression must specify the field name, a comparison operator, and the value to use for filtering: - The value must be a string, a number, or a boolean. - The comparison operator must be either `=`,`!=`, `>`, or `<`. - To filter on multiple expressions, separate the expressions with `AND` or `OR` (omitting both implies `AND`). - For clarity, expressions can be enclosed in parentheses. Only `lifecycle_state` can be filtered on in this way. For example, the following expression only returns `COMPLETED` conversations: `lifecycle_state = "COMPLETED"` For more information about filtering, see [API Filtering](https://aip.dev/160). */
+        /** Optional. A filter expression that filters conversations listed in the response. Only `lifecycle_state` can be filtered on in this way. For example, the following expression only returns `COMPLETED` conversations: `lifecycle_state = "COMPLETED"` For more information about filtering, see [API Filtering](https://aip.dev/160). */
         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;
@@ -15710,7 +15720,7 @@ declare namespace gapi.client {
         key?: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
-        /** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
+        /** Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;
@@ -15739,7 +15749,7 @@ declare namespace gapi.client {
           key?: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
-          /** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
+          /** Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
           parent: string;
           /** Returns response with indentations and line breaks. */
           prettyPrint?: boolean;
@@ -16106,7 +16116,7 @@ declare namespace gapi.client {
         key?: string;
         /** OAuth 2.0 token for the current user. */
         oauth_token?: string;
-        /** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
+        /** Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
         parent: string;
         /** Returns response with indentations and line breaks. */
         prettyPrint?: boolean;
@@ -16135,7 +16145,7 @@ declare namespace gapi.client {
           key?: string;
           /** OAuth 2.0 token for the current user. */
           oauth_token?: string;
-          /** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
+          /** Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
           parent: string;
           /** Returns response with indentations and line breaks. */
           prettyPrint?: boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@maxim_mazurok/gapi.client.dialogflow-v2",
-  "version": "0.0.20240607",
+  "version": "0.0.20240617",
   "description": "TypeScript typings for Dialogflow API v2",
   "repository": {
     "type": "git",