@maxim_mazurok/gapi.client.dialogflow-v2 0.0.20240607 → 0.0.20240614
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +22 -22
- package/package.json +1 -1
package/index.d.ts
CHANGED
|
@@ -9,7 +9,7 @@
|
|
|
9
9
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
10
10
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
11
11
|
// Generated from: https://dialogflow.googleapis.com/$discovery/rest?version=v2
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240614
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -2759,13 +2759,13 @@ declare namespace gapi.client {
|
|
|
2759
2759
|
interface GoogleCloudDialogflowV2Conversation {
|
|
2760
2760
|
/** Required. The Conversation Profile to be used to configure this Conversation. This field cannot be updated. Format: `projects//locations//conversationProfiles/`. */
|
|
2761
2761
|
conversationProfile?: string;
|
|
2762
|
-
/** 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. */
|
|
2762
|
+
/** 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. */
|
|
2763
2763
|
conversationStage?: string;
|
|
2764
2764
|
/** Output only. The time the conversation was finished. */
|
|
2765
2765
|
endTime?: string;
|
|
2766
2766
|
/** Output only. The current state of the Conversation. */
|
|
2767
2767
|
lifecycleState?: string;
|
|
2768
|
-
/** Output only. The unique identifier of this conversation. Format: `projects//locations//conversations/`. */
|
|
2768
|
+
/** Output only. Identifier. The unique identifier of this conversation. Format: `projects//locations//conversations/`. */
|
|
2769
2769
|
name?: string;
|
|
2770
2770
|
/** Output only. It will not be empty if the conversation is to be connected over telephony. */
|
|
2771
2771
|
phoneNumber?: GoogleCloudDialogflowV2ConversationPhoneNumber;
|
|
@@ -3161,9 +3161,9 @@ declare namespace gapi.client {
|
|
|
3161
3161
|
interface GoogleCloudDialogflowV2GenerateStatelessSummaryRequest {
|
|
3162
3162
|
/** Required. A ConversationProfile containing information required for Summary generation. Required fields: {language_code, security_settings} Optional fields: {agent_assistant_config} */
|
|
3163
3163
|
conversationProfile?: GoogleCloudDialogflowV2ConversationProfile;
|
|
3164
|
-
/** 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. */
|
|
3164
|
+
/** 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. */
|
|
3165
3165
|
latestMessage?: string;
|
|
3166
|
-
/** 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. */
|
|
3166
|
+
/** 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. */
|
|
3167
3167
|
maxContextSize?: number;
|
|
3168
3168
|
/** Required. The conversation to suggest a summary for. */
|
|
3169
3169
|
statelessConversation?: GoogleCloudDialogflowV2GenerateStatelessSummaryRequestMinimalConversation;
|
|
@@ -4089,17 +4089,17 @@ declare namespace gapi.client {
|
|
|
4089
4089
|
uri?: string;
|
|
4090
4090
|
}
|
|
4091
4091
|
interface GoogleCloudDialogflowV2SearchKnowledgeRequest {
|
|
4092
|
-
/** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
|
|
4092
|
+
/** Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
|
|
4093
4093
|
conversation?: string;
|
|
4094
4094
|
/** Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`. */
|
|
4095
4095
|
conversationProfile?: string;
|
|
4096
|
-
/** The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. */
|
|
4096
|
+
/** Optional. The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. */
|
|
4097
4097
|
latestMessage?: string;
|
|
4098
|
-
/** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
4098
|
+
/** Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
4099
4099
|
parent?: string;
|
|
4100
4100
|
/** Required. The natural language text query for knowledge search. */
|
|
4101
4101
|
query?: GoogleCloudDialogflowV2TextInput;
|
|
4102
|
-
/** 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. */
|
|
4102
|
+
/** 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. */
|
|
4103
4103
|
sessionId?: string;
|
|
4104
4104
|
}
|
|
4105
4105
|
interface GoogleCloudDialogflowV2SearchKnowledgeResponse {
|
|
@@ -4203,11 +4203,11 @@ declare namespace gapi.client {
|
|
|
4203
4203
|
latestMessage?: string;
|
|
4204
4204
|
}
|
|
4205
4205
|
interface GoogleCloudDialogflowV2SuggestConversationSummaryRequest {
|
|
4206
|
-
/** Parameters for a human assist query. Only used for POC/demo purpose. */
|
|
4206
|
+
/** Optional. Parameters for a human assist query. Only used for POC/demo purpose. */
|
|
4207
4207
|
assistQueryParams?: GoogleCloudDialogflowV2AssistQueryParameters;
|
|
4208
|
-
/** 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. */
|
|
4208
|
+
/** 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. */
|
|
4209
4209
|
contextSize?: number;
|
|
4210
|
-
/** 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/`. */
|
|
4210
|
+
/** 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/`. */
|
|
4211
4211
|
latestMessage?: string;
|
|
4212
4212
|
}
|
|
4213
4213
|
interface GoogleCloudDialogflowV2SuggestConversationSummaryResponse {
|
|
@@ -9136,7 +9136,7 @@ declare namespace gapi.client {
|
|
|
9136
9136
|
alt?: string;
|
|
9137
9137
|
/** JSONP */
|
|
9138
9138
|
callback?: string;
|
|
9139
|
-
/** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
|
|
9139
|
+
/** Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
|
|
9140
9140
|
conversation: string;
|
|
9141
9141
|
/** Selector specifying which fields to include in a partial response. */
|
|
9142
9142
|
fields?: string;
|
|
@@ -9165,7 +9165,7 @@ declare namespace gapi.client {
|
|
|
9165
9165
|
alt?: string;
|
|
9166
9166
|
/** JSONP */
|
|
9167
9167
|
callback?: string;
|
|
9168
|
-
/** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
|
|
9168
|
+
/** Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
|
|
9169
9169
|
conversation: string;
|
|
9170
9170
|
/** Selector specifying which fields to include in a partial response. */
|
|
9171
9171
|
fields?: string;
|
|
@@ -9403,7 +9403,7 @@ declare namespace gapi.client {
|
|
|
9403
9403
|
callback?: string;
|
|
9404
9404
|
/** Selector specifying which fields to include in a partial response. */
|
|
9405
9405
|
fields?: string;
|
|
9406
|
-
/** A filter expression that filters conversations listed in the response.
|
|
9406
|
+
/** 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). */
|
|
9407
9407
|
filter?: string;
|
|
9408
9408
|
/** 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. */
|
|
9409
9409
|
key?: string;
|
|
@@ -14388,7 +14388,7 @@ declare namespace gapi.client {
|
|
|
14388
14388
|
alt?: string;
|
|
14389
14389
|
/** JSONP */
|
|
14390
14390
|
callback?: string;
|
|
14391
|
-
/** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
|
|
14391
|
+
/** Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
|
|
14392
14392
|
conversation: string;
|
|
14393
14393
|
/** Selector specifying which fields to include in a partial response. */
|
|
14394
14394
|
fields?: string;
|
|
@@ -14417,7 +14417,7 @@ declare namespace gapi.client {
|
|
|
14417
14417
|
alt?: string;
|
|
14418
14418
|
/** JSONP */
|
|
14419
14419
|
callback?: string;
|
|
14420
|
-
/** The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
|
|
14420
|
+
/** Optional. The conversation (between human agent and end user) where the search request is triggered. Format: `projects//locations//conversations/`. */
|
|
14421
14421
|
conversation: string;
|
|
14422
14422
|
/** Selector specifying which fields to include in a partial response. */
|
|
14423
14423
|
fields?: string;
|
|
@@ -14655,7 +14655,7 @@ declare namespace gapi.client {
|
|
|
14655
14655
|
callback?: string;
|
|
14656
14656
|
/** Selector specifying which fields to include in a partial response. */
|
|
14657
14657
|
fields?: string;
|
|
14658
|
-
/** A filter expression that filters conversations listed in the response.
|
|
14658
|
+
/** 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). */
|
|
14659
14659
|
filter?: string;
|
|
14660
14660
|
/** 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. */
|
|
14661
14661
|
key?: string;
|
|
@@ -15710,7 +15710,7 @@ declare namespace gapi.client {
|
|
|
15710
15710
|
key?: string;
|
|
15711
15711
|
/** OAuth 2.0 token for the current user. */
|
|
15712
15712
|
oauth_token?: string;
|
|
15713
|
-
/** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
15713
|
+
/** Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
15714
15714
|
parent: string;
|
|
15715
15715
|
/** Returns response with indentations and line breaks. */
|
|
15716
15716
|
prettyPrint?: boolean;
|
|
@@ -15739,7 +15739,7 @@ declare namespace gapi.client {
|
|
|
15739
15739
|
key?: string;
|
|
15740
15740
|
/** OAuth 2.0 token for the current user. */
|
|
15741
15741
|
oauth_token?: string;
|
|
15742
|
-
/** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
15742
|
+
/** Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
15743
15743
|
parent: string;
|
|
15744
15744
|
/** Returns response with indentations and line breaks. */
|
|
15745
15745
|
prettyPrint?: boolean;
|
|
@@ -16106,7 +16106,7 @@ declare namespace gapi.client {
|
|
|
16106
16106
|
key?: string;
|
|
16107
16107
|
/** OAuth 2.0 token for the current user. */
|
|
16108
16108
|
oauth_token?: string;
|
|
16109
|
-
/** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
16109
|
+
/** Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
16110
16110
|
parent: string;
|
|
16111
16111
|
/** Returns response with indentations and line breaks. */
|
|
16112
16112
|
prettyPrint?: boolean;
|
|
@@ -16135,7 +16135,7 @@ declare namespace gapi.client {
|
|
|
16135
16135
|
key?: string;
|
|
16136
16136
|
/** OAuth 2.0 token for the current user. */
|
|
16137
16137
|
oauth_token?: string;
|
|
16138
|
-
/** The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
16138
|
+
/** Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
16139
16139
|
parent: string;
|
|
16140
16140
|
/** Returns response with indentations and line breaks. */
|
|
16141
16141
|
prettyPrint?: boolean;
|