@maxim_mazurok/gapi.client.dialogflow-v2beta1 0.0.20241009 → 0.0.20241019
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 +67 -1
- 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=v2beta1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20241019
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -2410,6 +2410,8 @@ declare namespace gapi.client {
|
|
|
2410
2410
|
confidenceThreshold?: number;
|
|
2411
2411
|
/** Determines how recent conversation context is filtered when generating suggestions. If unspecified, no messages will be dropped. */
|
|
2412
2412
|
contextFilterSettings?: GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigContextFilterSettings;
|
|
2413
|
+
/** Optional. The number of recent messages to include in the context. Supported features: KNOWLEDGE_ASSIST. */
|
|
2414
|
+
contextSize?: number;
|
|
2413
2415
|
/** Query from Dialogflow agent. It is used by DIALOGFLOW_ASSIST, ENTITY_EXTRACTION. */
|
|
2414
2416
|
dialogflowQuerySource?: GoogleCloudDialogflowV2beta1HumanAgentAssistantConfigSuggestionQueryConfigDialogflowQuerySource;
|
|
2415
2417
|
/** Query from knowledge base document. It is used by: SMART_REPLY, SMART_COMPOSE. */
|
|
@@ -2552,6 +2554,8 @@ declare namespace gapi.client {
|
|
|
2552
2554
|
optOutConformerModelMigration?: boolean;
|
|
2553
2555
|
/** A list of strings containing words and phrases that the speech recognizer should recognize with higher likelihood. See [the Cloud Speech documentation](https://cloud.google.com/speech-to-text/docs/basics#phrase-hints) for more details. This field is deprecated. Please use [`speech_contexts`]() instead. If you specify both [`phrase_hints`]() and [`speech_contexts`](), Dialogflow will treat the [`phrase_hints`]() as a single additional [`SpeechContext`](). */
|
|
2554
2556
|
phraseHints?: string[];
|
|
2557
|
+
/** A collection of phrase set resources to use for speech adaptation. */
|
|
2558
|
+
phraseSets?: string[];
|
|
2555
2559
|
/** Required. 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. */
|
|
2556
2560
|
sampleRateHertz?: number;
|
|
2557
2561
|
/** If `false` (default), recognition does not cease until the client closes the stream. If `true`, the recognizer will detect a single spoken utterance in input audio. Recognition ceases when it detects the audio's voice has stopped or paused. In this case, once a detected intent is received, the client should close the stream and start a new request with a new stream as needed. Note: This setting is relevant only for streaming methods. Note: When specified, InputAudioConfig.single_utterance takes precedence over StreamingDetectIntentRequest.single_utterance. */
|
|
@@ -3025,6 +3029,8 @@ declare namespace gapi.client {
|
|
|
3025
3029
|
snippets?: GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet[];
|
|
3026
3030
|
}
|
|
3027
3031
|
interface GoogleCloudDialogflowV2beta1KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet {
|
|
3032
|
+
/** Metadata of the document. */
|
|
3033
|
+
metadata?: {[P in string]: any};
|
|
3028
3034
|
/** Text taken from that URI. */
|
|
3029
3035
|
text?: string;
|
|
3030
3036
|
/** Title of the document. */
|
|
@@ -3362,6 +3368,8 @@ declare namespace gapi.client {
|
|
|
3362
3368
|
answerType?: string;
|
|
3363
3369
|
}
|
|
3364
3370
|
interface GoogleCloudDialogflowV2beta1SearchKnowledgeAnswerAnswerSource {
|
|
3371
|
+
/** Metadata associated with the article. */
|
|
3372
|
+
metadata?: {[P in string]: any};
|
|
3365
3373
|
/** The relevant snippet of the article. */
|
|
3366
3374
|
snippet?: string;
|
|
3367
3375
|
/** The title of the article. */
|
|
@@ -3374,15 +3382,69 @@ declare namespace gapi.client {
|
|
|
3374
3382
|
conversation?: string;
|
|
3375
3383
|
/** Required. The conversation profile used to configure the search. Format: `projects//locations//conversationProfiles/`. */
|
|
3376
3384
|
conversationProfile?: string;
|
|
3385
|
+
/** Optional. Information about the end-user to improve the relevance and accuracy of generative answers. This will be interpreted and used by a language model, so, for good results, the data should be self-descriptive, and in a simple structure. Example: ```json { "subscription plan": "Business Premium Plus", "devices owned": [ {"model": "Google Pixel 7"}, {"model": "Google Pixel Tablet"} ] } ``` */
|
|
3386
|
+
endUserMetadata?: {[P in string]: any};
|
|
3387
|
+
/** Optional. Whether to search the query exactly without query rewrite. */
|
|
3388
|
+
exactSearch?: boolean;
|
|
3377
3389
|
/** Optional. The name of the latest conversation message when the request is triggered. Format: `projects//locations//conversations//messages/`. */
|
|
3378
3390
|
latestMessage?: string;
|
|
3379
3391
|
/** Required. The parent resource contains the conversation profile Format: 'projects/' or `projects//locations/`. */
|
|
3380
3392
|
parent?: string;
|
|
3381
3393
|
/** Required. The natural language text query for knowledge search. */
|
|
3382
3394
|
query?: GoogleCloudDialogflowV2beta1TextInput;
|
|
3395
|
+
/** Optional. The source of the query in the request. */
|
|
3396
|
+
querySource?: string;
|
|
3397
|
+
/** Optional. Configuration specific to search queries with data stores. */
|
|
3398
|
+
searchConfig?: GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfig;
|
|
3383
3399
|
/** Required. 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. */
|
|
3384
3400
|
sessionId?: string;
|
|
3385
3401
|
}
|
|
3402
|
+
interface GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfig {
|
|
3403
|
+
/** Optional. Boost specifications for data stores. */
|
|
3404
|
+
boostSpecs?: GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecs[];
|
|
3405
|
+
/** Optional. Filter specification for data store queries. */
|
|
3406
|
+
filterSpecs?: GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigFilterSpecs[];
|
|
3407
|
+
}
|
|
3408
|
+
interface GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecs {
|
|
3409
|
+
/** Optional. Data Stores where the boosting configuration is applied. The full names of the referenced data stores. Formats: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` `projects/{project}/locations/{location}/dataStores/{data_store} */
|
|
3410
|
+
dataStores?: string[];
|
|
3411
|
+
/** Optional. A list of boosting specifications. */
|
|
3412
|
+
spec?: GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec[];
|
|
3413
|
+
}
|
|
3414
|
+
interface GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpec {
|
|
3415
|
+
/** Optional. Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20. */
|
|
3416
|
+
conditionBoostSpecs?: GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec[];
|
|
3417
|
+
}
|
|
3418
|
+
interface GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpec {
|
|
3419
|
+
/** Optional. Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored. */
|
|
3420
|
+
boost?: number;
|
|
3421
|
+
/** Optional. Complex specification for custom ranking based on customer defined attribute value. */
|
|
3422
|
+
boostControlSpec?: GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpec;
|
|
3423
|
+
/** Optional. An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (id: ANY("doc_1", "doc_2")) AND (color: ANY("Red","Blue")) */
|
|
3424
|
+
condition?: string;
|
|
3425
|
+
}
|
|
3426
|
+
interface GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpec {
|
|
3427
|
+
/** Optional. The attribute type to be used to determine the boost amount. The attribute value can be derived from the field value of the specified field_name. In the case of numerical it is straightforward i.e. attribute_value = numerical_field_value. In the case of freshness however, attribute_value = (time.now() - datetime_field_value). */
|
|
3428
|
+
attributeType?: string;
|
|
3429
|
+
/** Optional. The control points used to define the curve. The monotonic function (defined through the interpolation_type above) passes through the control points listed here. */
|
|
3430
|
+
controlPoints?: GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpecControlPoint[];
|
|
3431
|
+
/** Optional. The name of the field whose value will be used to determine the boost amount. */
|
|
3432
|
+
fieldName?: string;
|
|
3433
|
+
/** Optional. The interpolation type to be applied to connect the control points listed below. */
|
|
3434
|
+
interpolationType?: string;
|
|
3435
|
+
}
|
|
3436
|
+
interface GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigBoostSpecsBoostSpecConditionBoostSpecBoostControlSpecControlPoint {
|
|
3437
|
+
/** Optional. Can be one of: 1. The numerical field value. 2. The duration spec for freshness: The value must be formatted as an XSD `dayTimeDuration` value (a restricted subset of an ISO 8601 duration value). The pattern for this is: `nDnM]`. */
|
|
3438
|
+
attributeValue?: string;
|
|
3439
|
+
/** Optional. The value between -1 to 1 by which to boost the score if the attribute_value evaluates to the value specified above. */
|
|
3440
|
+
boostAmount?: number;
|
|
3441
|
+
}
|
|
3442
|
+
interface GoogleCloudDialogflowV2beta1SearchKnowledgeRequestSearchConfigFilterSpecs {
|
|
3443
|
+
/** Optional. The data store where the filter configuration is applied. Full resource name of data store, such as projects/{project}/locations/{location}/collections/{collectionId}/ dataStores/{dataStoreId}. */
|
|
3444
|
+
dataStores?: string[];
|
|
3445
|
+
/** Optional. The filter expression to be applied. Expression syntax is documented at https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata#filter-expression-syntax */
|
|
3446
|
+
filter?: string;
|
|
3447
|
+
}
|
|
3386
3448
|
interface GoogleCloudDialogflowV2beta1SearchKnowledgeResponse {
|
|
3387
3449
|
/** Most relevant snippets extracted from articles in the given knowledge base, ordered by confidence. */
|
|
3388
3450
|
answers?: GoogleCloudDialogflowV2beta1SearchKnowledgeAnswer[];
|
|
@@ -3450,6 +3512,8 @@ declare namespace gapi.client {
|
|
|
3450
3512
|
languageCode?: string;
|
|
3451
3513
|
/** 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. */
|
|
3452
3514
|
model?: string;
|
|
3515
|
+
/** List of names of Cloud Speech phrase sets that are used for transcription. */
|
|
3516
|
+
phraseSets?: string[];
|
|
3453
3517
|
/** 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. */
|
|
3454
3518
|
sampleRateHertz?: number;
|
|
3455
3519
|
/** 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. */
|
|
@@ -4276,6 +4340,8 @@ declare namespace gapi.client {
|
|
|
4276
4340
|
snippets?: GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet[];
|
|
4277
4341
|
}
|
|
4278
4342
|
interface GoogleCloudDialogflowV2KnowledgeAssistAnswerKnowledgeAnswerGenerativeSourceSnippet {
|
|
4343
|
+
/** Metadata of the document. */
|
|
4344
|
+
metadata?: {[P in string]: any};
|
|
4279
4345
|
/** Text taken from that URI. */
|
|
4280
4346
|
text?: string;
|
|
4281
4347
|
/** Title of the document. */
|