@maxim_mazurok/gapi.client.dialogflow-v2beta1 0.10.20250919 → 0.11.20250919

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.
Files changed (2) hide show
  1. package/index.d.ts +1 -335
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -2349,12 +2349,6 @@ declare namespace gapi.client {
2349
2349
  /** The developer-provided description for this environment history entry. */
2350
2350
  description?: string;
2351
2351
  }
2352
- interface GoogleCloudDialogflowV2beta1EvaluationStatus {
2353
- /** Output only. If the value is `false`, it means the evaluation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. */
2354
- done?: boolean;
2355
- /** Output only. The error result of the evaluation in case of failure in evaluation pipeline. */
2356
- pipelineStatus?: GoogleRpcStatus;
2357
- }
2358
2352
  interface GoogleCloudDialogflowV2beta1EventInput {
2359
2353
  /** Required. The language of this query. 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. This field is ignored when used in the context of a WebhookResponse.followup_event_input field, because the language was already defined in the originating detect intent request. */
2360
2354
  languageCode?: string;
@@ -2541,72 +2535,6 @@ declare namespace gapi.client {
2541
2535
  /** Output only. Update time of this generator. */
2542
2536
  updateTime?: string;
2543
2537
  }
2544
- interface GoogleCloudDialogflowV2beta1GeneratorEvaluation {
2545
- /** Output only. Completion time of this generator evaluation. */
2546
- completeTime?: string;
2547
- /** Output only. Creation time of this generator evaluation. */
2548
- createTime?: string;
2549
- /** Optional. The display name of the generator evaluation. At most 64 bytes long. */
2550
- displayName?: string;
2551
- /** Output only. The result status of the evaluation pipeline. Provides the status information including if the evaluation is still in progress, completed or failed with certain error and user actionable message. */
2552
- evaluationStatus?: GoogleCloudDialogflowV2beta1EvaluationStatus;
2553
- /** Required. The configuration of the evaluation task. */
2554
- generatorEvaluationConfig?: GoogleCloudDialogflowV2beta1GeneratorEvaluationConfig;
2555
- /** Required. The initial generator that was used when creating this evaluation. This is a copy of the generator read from storage when creating the evaluation. */
2556
- initialGenerator?: GoogleCloudDialogflowV2beta1Generator;
2557
- /** Output only. Identifier. The resource name of the evaluation. Format: `projects//locations//generators// evaluations/` */
2558
- name?: string;
2559
- /** Output only. Only available when the summarization generator is provided. */
2560
- summarizationMetrics?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics;
2561
- }
2562
- interface GoogleCloudDialogflowV2beta1GeneratorEvaluationConfig {
2563
- /** Required. The config/source of input data. */
2564
- inputDataConfig?: GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigInputDataConfig;
2565
- /** Required. The output Cloud Storage bucket path to store eval files, e.g. per_summary_accuracy_score report. This path is provided by customer and files stored in it are visible to customer, no internal data should be stored in this path. */
2566
- outputGcsBucketPath?: string;
2567
- /** Evaluation configs for summarization generator. */
2568
- summarizationConfig?: GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigSummarizationConfig;
2569
- }
2570
- interface GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigAgentAssistInputDataConfig {
2571
- /** Required. The end of the time range for conversations to be evaluated. Only conversations ended at or before this timestamp will be sampled. */
2572
- endTime?: string;
2573
- /** Required. The start of the time range for conversations to be evaluated. Only conversations created at or after this timestamp will be sampled. */
2574
- startTime?: string;
2575
- }
2576
- interface GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigDatasetInputDataConfig {
2577
- /** Required. The identifier of the dataset to be evaluated. Format: `projects//locations//datasets/`. */
2578
- dataset?: string;
2579
- }
2580
- interface GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigInputDataConfig {
2581
- /** The distinctive configs for Agent Assist conversations as the conversation source. */
2582
- agentAssistInputDataConfig?: GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigAgentAssistInputDataConfig;
2583
- /** The distinctive configs for dataset as the conversation source. */
2584
- datasetInputDataConfig?: GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigDatasetInputDataConfig;
2585
- /** Optional. The end timestamp to fetch conversation data. */
2586
- endTime?: string;
2587
- /** Required. The source type of input data. */
2588
- inputDataSourceType?: string;
2589
- /** Optional. Whether the summary generation is allowed when the pre-existing qualified summaries are insufficient to cover the sample size. */
2590
- isSummaryGenerationAllowed?: boolean;
2591
- /** Optional. Desired number of conversation-summary pairs to be evaluated. */
2592
- sampleSize?: number;
2593
- /** Optional. The start timestamp to fetch conversation data. */
2594
- startTime?: string;
2595
- /** Optional. Option to control whether summaries are generated during evaluation. */
2596
- summaryGenerationOption?: string;
2597
- }
2598
- interface GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigSummarizationConfig {
2599
- /** Optional. Version for summarization accuracy. This will determine the prompt and model used at backend. */
2600
- accuracyEvaluationVersion?: string;
2601
- /** Optional. Version for summarization completeness. This will determine the prompt and model used at backend. */
2602
- completenessEvaluationVersion?: string;
2603
- /** Optional. Enable accuracy evaluation. */
2604
- enableAccuracyEvaluation?: boolean;
2605
- /** Optional. Enable completeness evaluation. */
2606
- enableCompletenessEvaluation?: boolean;
2607
- /** Output only. Version for summarization evaluation. */
2608
- evaluatorVersion?: string;
2609
- }
2610
2538
  interface GoogleCloudDialogflowV2beta1GeneratorSuggestion {
2611
2539
  /** Optional. Free form suggestion. */
2612
2540
  freeFormSuggestion?: GoogleCloudDialogflowV2beta1FreeFormSuggestion;
@@ -3388,12 +3316,6 @@ declare namespace gapi.client {
3388
3316
  /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
3389
3317
  nextPageToken?: string;
3390
3318
  }
3391
- interface GoogleCloudDialogflowV2beta1ListGeneratorEvaluationsResponse {
3392
- /** The list of evaluations to return. */
3393
- generatorEvaluations?: GoogleCloudDialogflowV2beta1GeneratorEvaluation[];
3394
- /** Token to retrieve the next page of results, or empty if there are no more results in the list. */
3395
- nextPageToken?: string;
3396
- }
3397
3319
  interface GoogleCloudDialogflowV2beta1ListGeneratorsResponse {
3398
3320
  /** List of generators retrieved. */
3399
3321
  generators?: GoogleCloudDialogflowV2beta1Generator[];
@@ -4061,116 +3983,6 @@ declare namespace gapi.client {
4061
3983
  /** Optional. Version of the feature. If not set, default to latest version. Current candidates are ["1.0"]. */
4062
3984
  version?: string;
4063
3985
  }
4064
- interface GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics {
4065
- /** Output only. List of conversation details. */
4066
- conversationDetails?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetail[];
4067
- /** Output only. A list of aggregated(average) scores per metric section. */
4068
- overallMetrics?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsOverallScoresByMetric[];
4069
- /** Output only. Overall token per section. This is an aggregated(sum) result of input token of summary acorss all conversations that are selected for summarization evaluation. */
4070
- overallSectionTokens?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken[];
4071
- /** Output only. User bucket uri for merged evaluation score and aggregation score csv. */
4072
- summarizationEvaluationMergedResultsUri?: string;
4073
- /** Output only. A list of evaluation results per conversation(&summary), metric and section. */
4074
- summarizationEvaluationResults?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSummarizationEvaluationResult[];
4075
- }
4076
- interface GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition {
4077
- /** Output only. The accuracy reasoning of the breakdown point. */
4078
- accuracyReasoning?: string;
4079
- /** Output only. Whether the breakdown point is accurate or not. */
4080
- isAccurate?: boolean;
4081
- /** Output only. The breakdown point of the summary. */
4082
- point?: string;
4083
- }
4084
- interface GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceDecomposition {
4085
- /** Output only. The adherence reasoning of the breakdown point. */
4086
- adherenceReasoning?: string;
4087
- /** Output only. Whether the breakdown point is adherent or not. */
4088
- isAdherent?: boolean;
4089
- /** Output only. The breakdown point of the given instructions. */
4090
- point?: string;
4091
- }
4092
- interface GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceRubric {
4093
- /** Output only. A boolean that indicates whether the rubric question is addressed or not. */
4094
- isAddressed?: boolean;
4095
- /** Output only. The question generated from instruction that used to evaluate summary. */
4096
- question?: string;
4097
- /** Output only. The reasoning of the rubric question is addressed or not. */
4098
- reasoning?: string;
4099
- }
4100
- interface GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsCompletenessRubric {
4101
- /** Output only. A boolean that indicates whether the rubric question is addressed or not. */
4102
- isAddressed?: boolean;
4103
- /** Output only. The question generated from instruction that used to evaluate summary. */
4104
- question?: string;
4105
- }
4106
- interface GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetail {
4107
- /** Output only. Conversation transcript that used for summarization evaluation as a reference. */
4108
- messageEntries?: GoogleCloudDialogflowV2beta1MessageEntry[];
4109
- /** Output only. List of metric details. */
4110
- metricDetails?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetail[];
4111
- /** Output only. Conversation level token count per section. This is an aggregated(sum) result of input token of summary acorss all metrics for a single conversation. */
4112
- sectionTokens?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken[];
4113
- /** Output only. Summary sections that used for summarization evaluation as a reference. */
4114
- summarySections?: GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection[];
4115
- }
4116
- interface GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetail {
4117
- /** Output only. Metrics name. e.g. accuracy, adherence, completeness. */
4118
- metric?: string;
4119
- /** Output only. Aggregated(average) score on this metric across all sections. */
4120
- score?: number;
4121
- /** Output only. List of section details. */
4122
- sectionDetails?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail[];
4123
- }
4124
- interface GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail {
4125
- /** Output only. List of evaluation result. The list only contains one kind of the evaluation result. */
4126
- evaluationResults?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult[];
4127
- /** Output only. Aggregated(average) score on this section across all evaluation results. Either decompositions or rubrics. */
4128
- score?: number;
4129
- /** Output only. The name of the summary instruction. */
4130
- section?: string;
4131
- /** Output only. Summary for this section */
4132
- sectionSummary?: string;
4133
- }
4134
- interface GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsDecomposition {
4135
- /** only available for accuracy metric. */
4136
- accuracyDecomposition?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition;
4137
- /** only available for adherence metric. */
4138
- adherenceDecomposition?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceDecomposition;
4139
- }
4140
- interface GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult {
4141
- /** Only available for accuracy metric. */
4142
- accuracyDecomposition?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition;
4143
- /** Only available for adherence metric. */
4144
- adherenceRubric?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceRubric;
4145
- /** Only available for completeness metric. */
4146
- completenessRubric?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsCompletenessRubric;
4147
- }
4148
- interface GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsOverallScoresByMetric {
4149
- /** Output only. Metric name. e.g. accuracy, adherence, completeness. */
4150
- metric?: string;
4151
- }
4152
- interface GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken {
4153
- /** Output only. The name of the summary instruction. */
4154
- section?: string;
4155
- /** Output only. Token count. */
4156
- tokenCount?: string;
4157
- }
4158
- interface GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSummarizationEvaluationResult {
4159
- /** Output only. List of decompostion details */
4160
- decompositions?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsDecomposition[];
4161
- /** Output only. List of evaluation results. */
4162
- evaluationResults?: GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult[];
4163
- /** Output only. metric name, e.g. accuracy, completeness, adherence, etc. */
4164
- metric?: string;
4165
- /** Output only. score calculated from decompositions */
4166
- score?: number;
4167
- /** Output only. section/task name, e.g. action, situation, etc */
4168
- section?: string;
4169
- /** Output only. Summary of this section */
4170
- sectionSummary?: string;
4171
- /** Output only. conversation session id */
4172
- sessionId?: string;
4173
- }
4174
3986
  interface GoogleCloudDialogflowV2beta1SummarizationSection {
4175
3987
  /** Optional. Definition of the section, for example, "what the customer needs help with or has question about." */
4176
3988
  definition?: string;
@@ -14806,151 +14618,6 @@ declare namespace gapi.client {
14806
14618
  body: GoogleCloudDialogflowV2beta1InitializeEncryptionSpecRequest,
14807
14619
  ): Request<GoogleLongrunningOperation>;
14808
14620
  }
14809
- interface EvaluationsResource {
14810
- /** Creates evaluation of a generator. */
14811
- create(request: {
14812
- /** V1 error format. */
14813
- '$.xgafv'?: string;
14814
- /** OAuth access token. */
14815
- access_token?: string;
14816
- /** Data format for response. */
14817
- alt?: string;
14818
- /** JSONP */
14819
- callback?: string;
14820
- /** Selector specifying which fields to include in a partial response. */
14821
- fields?: string;
14822
- /** 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. */
14823
- key?: string;
14824
- /** OAuth 2.0 token for the current user. */
14825
- oauth_token?: string;
14826
- /** Required. The generator resource name. Format: `projects//locations//generators/` */
14827
- parent: string;
14828
- /** Returns response with indentations and line breaks. */
14829
- prettyPrint?: boolean;
14830
- /** 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. */
14831
- quotaUser?: string;
14832
- /** Upload protocol for media (e.g. "raw", "multipart"). */
14833
- upload_protocol?: string;
14834
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
14835
- uploadType?: string;
14836
- /** Request body */
14837
- resource: GoogleCloudDialogflowV2beta1GeneratorEvaluation;
14838
- }): Request<GoogleLongrunningOperation>;
14839
- create(
14840
- request: {
14841
- /** V1 error format. */
14842
- '$.xgafv'?: string;
14843
- /** OAuth access token. */
14844
- access_token?: string;
14845
- /** Data format for response. */
14846
- alt?: string;
14847
- /** JSONP */
14848
- callback?: string;
14849
- /** Selector specifying which fields to include in a partial response. */
14850
- fields?: string;
14851
- /** 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. */
14852
- key?: string;
14853
- /** OAuth 2.0 token for the current user. */
14854
- oauth_token?: string;
14855
- /** Required. The generator resource name. Format: `projects//locations//generators/` */
14856
- parent: string;
14857
- /** Returns response with indentations and line breaks. */
14858
- prettyPrint?: boolean;
14859
- /** 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. */
14860
- quotaUser?: string;
14861
- /** Upload protocol for media (e.g. "raw", "multipart"). */
14862
- upload_protocol?: string;
14863
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
14864
- uploadType?: string;
14865
- },
14866
- body: GoogleCloudDialogflowV2beta1GeneratorEvaluation,
14867
- ): Request<GoogleLongrunningOperation>;
14868
- /** Deletes an evaluation of generator. */
14869
- delete(request?: {
14870
- /** V1 error format. */
14871
- '$.xgafv'?: string;
14872
- /** OAuth access token. */
14873
- access_token?: string;
14874
- /** Data format for response. */
14875
- alt?: string;
14876
- /** JSONP */
14877
- callback?: string;
14878
- /** Selector specifying which fields to include in a partial response. */
14879
- fields?: string;
14880
- /** 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. */
14881
- key?: string;
14882
- /** Required. The generator evaluation resource name. Format: `projects//locations//generators// evaluations/` */
14883
- name: string;
14884
- /** OAuth 2.0 token for the current user. */
14885
- oauth_token?: string;
14886
- /** Returns response with indentations and line breaks. */
14887
- prettyPrint?: boolean;
14888
- /** 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. */
14889
- quotaUser?: string;
14890
- /** Upload protocol for media (e.g. "raw", "multipart"). */
14891
- upload_protocol?: string;
14892
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
14893
- uploadType?: string;
14894
- }): Request<{}>;
14895
- /** Gets an evaluation of generator. */
14896
- get(request?: {
14897
- /** V1 error format. */
14898
- '$.xgafv'?: string;
14899
- /** OAuth access token. */
14900
- access_token?: string;
14901
- /** Data format for response. */
14902
- alt?: string;
14903
- /** JSONP */
14904
- callback?: string;
14905
- /** Selector specifying which fields to include in a partial response. */
14906
- fields?: string;
14907
- /** 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. */
14908
- key?: string;
14909
- /** Required. The generator evaluation resource name. Format: `projects//locations//generators//evaluations/` */
14910
- name: string;
14911
- /** OAuth 2.0 token for the current user. */
14912
- oauth_token?: string;
14913
- /** Returns response with indentations and line breaks. */
14914
- prettyPrint?: boolean;
14915
- /** 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. */
14916
- quotaUser?: string;
14917
- /** Upload protocol for media (e.g. "raw", "multipart"). */
14918
- upload_protocol?: string;
14919
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
14920
- uploadType?: string;
14921
- }): Request<GoogleCloudDialogflowV2beta1GeneratorEvaluation>;
14922
- /** Lists evaluations of generator. */
14923
- list(request?: {
14924
- /** V1 error format. */
14925
- '$.xgafv'?: string;
14926
- /** OAuth access token. */
14927
- access_token?: string;
14928
- /** Data format for response. */
14929
- alt?: string;
14930
- /** JSONP */
14931
- callback?: string;
14932
- /** Selector specifying which fields to include in a partial response. */
14933
- fields?: string;
14934
- /** 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. */
14935
- key?: string;
14936
- /** OAuth 2.0 token for the current user. */
14937
- oauth_token?: string;
14938
- /** Optional. Maximum number of evaluations to return in a single page. By default 100 and at most 1000. */
14939
- pageSize?: number;
14940
- /** Optional. The next_page_token value returned from a previous list request. */
14941
- pageToken?: string;
14942
- /** Required. The generator resource name. Format: `projects//locations//generators/` Wildcard value `-` is supported on generator_id to list evaluations across all generators under same project. */
14943
- parent: string;
14944
- /** Returns response with indentations and line breaks. */
14945
- prettyPrint?: boolean;
14946
- /** 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. */
14947
- quotaUser?: string;
14948
- /** Upload protocol for media (e.g. "raw", "multipart"). */
14949
- upload_protocol?: string;
14950
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
14951
- uploadType?: string;
14952
- }): Request<GoogleCloudDialogflowV2beta1ListGeneratorEvaluationsResponse>;
14953
- }
14954
14621
  interface GeneratorsResource {
14955
14622
  /** Creates a generator. */
14956
14623
  create(request: {
@@ -15161,7 +14828,6 @@ declare namespace gapi.client {
15161
14828
  },
15162
14829
  body: GoogleCloudDialogflowV2beta1Generator,
15163
14830
  ): Request<GoogleCloudDialogflowV2beta1Generator>;
15164
- evaluations: EvaluationsResource;
15165
14831
  }
15166
14832
  interface DocumentsResource {
15167
14833
  /** Creates a new document. This method is a [long-running operation](https://cloud.google.com/dialogflow/cx/docs/how/long-running-operation). The returned `Operation` type has the following method-specific fields: - `metadata`: KnowledgeOperationMetadata - `response`: Document Note: The `projects.agent.knowledgeBases.documents` resource is deprecated; only use `projects.knowledgeBases.documents`. */
@@ -16479,7 +16145,7 @@ declare namespace gapi.client {
16479
16145
  alt?: string;
16480
16146
  /** JSONP */
16481
16147
  callback?: string;
16482
- /** Optional. Unless explicitly documented otherwise, don't use this unsupported field which is primarily intended for internal usage. */
16148
+ /** Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage. */
16483
16149
  extraLocationTypes?: string | string[];
16484
16150
  /** Selector specifying which fields to include in a partial response. */
16485
16151
  fields?: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@maxim_mazurok/gapi.client.dialogflow-v2beta1",
3
- "version": "0.10.20250919",
3
+ "version": "0.11.20250919",
4
4
  "description": "TypeScript typings for Dialogflow API v2beta1",
5
5
  "repository": {
6
6
  "type": "git",