@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20240715 → 0.0.20240801
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 +187 -35
- 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://discoveryengine.googleapis.com/$discovery/rest?version=v1
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20240801
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -151,6 +151,8 @@ declare namespace gapi.client {
|
|
|
151
151
|
interface GoogleCloudDiscoveryengineV1alphaAnswerReference {
|
|
152
152
|
/** Chunk information. */
|
|
153
153
|
chunkInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfo;
|
|
154
|
+
/** Structured document information. */
|
|
155
|
+
structuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo;
|
|
154
156
|
/** Unstructured document information. */
|
|
155
157
|
unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo;
|
|
156
158
|
}
|
|
@@ -161,7 +163,7 @@ declare namespace gapi.client {
|
|
|
161
163
|
content?: string;
|
|
162
164
|
/** Document metadata. */
|
|
163
165
|
documentMetadata?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata;
|
|
164
|
-
/**
|
|
166
|
+
/** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
|
|
165
167
|
relevanceScore?: number;
|
|
166
168
|
}
|
|
167
169
|
interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceChunkInfoDocumentMetadata {
|
|
@@ -176,6 +178,12 @@ declare namespace gapi.client {
|
|
|
176
178
|
/** URI for the document. */
|
|
177
179
|
uri?: string;
|
|
178
180
|
}
|
|
181
|
+
interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceStructuredDocumentInfo {
|
|
182
|
+
/** Document resource name. */
|
|
183
|
+
document?: string;
|
|
184
|
+
/** Structured search data. */
|
|
185
|
+
structData?: {[P in string]: any};
|
|
186
|
+
}
|
|
179
187
|
interface GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfo {
|
|
180
188
|
/** List of cited chunk contents derived from document content. */
|
|
181
189
|
chunkContents?: GoogleCloudDiscoveryengineV1alphaAnswerReferenceUnstructuredDocumentInfoChunkContent[];
|
|
@@ -193,6 +201,8 @@ declare namespace gapi.client {
|
|
|
193
201
|
content?: string;
|
|
194
202
|
/** Page identifier. */
|
|
195
203
|
pageIdentifier?: string;
|
|
204
|
+
/** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
|
|
205
|
+
relevanceScore?: number;
|
|
196
206
|
}
|
|
197
207
|
interface GoogleCloudDiscoveryengineV1alphaAnswerStep {
|
|
198
208
|
/** Actions. */
|
|
@@ -233,7 +243,7 @@ declare namespace gapi.client {
|
|
|
233
243
|
chunk?: string;
|
|
234
244
|
/** Chunk textual content. */
|
|
235
245
|
content?: string;
|
|
236
|
-
/**
|
|
246
|
+
/** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
|
|
237
247
|
relevanceScore?: number;
|
|
238
248
|
}
|
|
239
249
|
interface GoogleCloudDiscoveryengineV1alphaAnswerStepActionObservationSearchResultSnippetInfo {
|
|
@@ -427,7 +437,7 @@ declare namespace gapi.client {
|
|
|
427
437
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
428
438
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
429
439
|
name?: string;
|
|
430
|
-
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. */
|
|
440
|
+
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
|
|
431
441
|
parsingConfigOverrides?: {
|
|
432
442
|
[P in string]: GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfig;
|
|
433
443
|
};
|
|
@@ -573,7 +583,7 @@ declare namespace gapi.client {
|
|
|
573
583
|
errorSamples?: GoogleRpcStatus[];
|
|
574
584
|
/** Required. The specification of the evaluation. */
|
|
575
585
|
evaluationSpec?: GoogleCloudDiscoveryengineV1alphaEvaluationEvaluationSpec;
|
|
576
|
-
/**
|
|
586
|
+
/** Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
577
587
|
name?: string;
|
|
578
588
|
/** Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. */
|
|
579
589
|
qualityMetrics?: GoogleCloudDiscoveryengineV1alphaQualityMetrics;
|
|
@@ -590,18 +600,6 @@ declare namespace gapi.client {
|
|
|
590
600
|
/** Required. The full resource name of the SampleQuerySet used for the evaluation, in the format of `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`. */
|
|
591
601
|
sampleQuerySet?: string;
|
|
592
602
|
}
|
|
593
|
-
interface GoogleCloudDiscoveryengineV1alphaExportUserEventsMetadata {
|
|
594
|
-
/** Operation create time. */
|
|
595
|
-
createTime?: string;
|
|
596
|
-
/** Operation last update time. If the operation is done, this is also the finish time. */
|
|
597
|
-
updateTime?: string;
|
|
598
|
-
}
|
|
599
|
-
interface GoogleCloudDiscoveryengineV1alphaExportUserEventsResponse {
|
|
600
|
-
/** Output result indicating where the data were exported to. */
|
|
601
|
-
outputResult?: GoogleCloudDiscoveryengineV1alphaOutputResult;
|
|
602
|
-
/** The status of the export operation. */
|
|
603
|
-
status?: GoogleRpcStatus;
|
|
604
|
-
}
|
|
605
603
|
interface GoogleCloudDiscoveryengineV1alphaFieldConfig {
|
|
606
604
|
/** If this field is set, only the corresponding source will be indexed for this field. Otherwise, the values from different sources are merged. Assuming a page with `` in meta tag, and `` in page map: if this enum is set to METATAGS, we will only index ``; if this enum is not set, we will merge them and index ``. */
|
|
607
605
|
advancedSiteSearchDataSources?: string[];
|
|
@@ -754,16 +752,6 @@ declare namespace gapi.client {
|
|
|
754
752
|
/** List of custom tuning models. */
|
|
755
753
|
models?: GoogleCloudDiscoveryengineV1alphaCustomTuningModel[];
|
|
756
754
|
}
|
|
757
|
-
interface GoogleCloudDiscoveryengineV1alphaOutputResult {
|
|
758
|
-
/** The BigQuery location where the result is stored. */
|
|
759
|
-
bigqueryResult?: GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult;
|
|
760
|
-
}
|
|
761
|
-
interface GoogleCloudDiscoveryengineV1alphaOutputResultBigQueryOutputResult {
|
|
762
|
-
/** The ID of a BigQuery Dataset. */
|
|
763
|
-
datasetId?: string;
|
|
764
|
-
/** The ID of a BigQuery Table. */
|
|
765
|
-
tableId?: string;
|
|
766
|
-
}
|
|
767
755
|
interface GoogleCloudDiscoveryengineV1alphaProject {
|
|
768
756
|
/** Output only. The timestamp when this project is created. */
|
|
769
757
|
createTime?: string;
|
|
@@ -944,7 +932,7 @@ declare namespace gapi.client {
|
|
|
944
932
|
naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
945
933
|
/** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
946
934
|
offset?: number;
|
|
947
|
-
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering
|
|
935
|
+
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
948
936
|
orderBy?: string;
|
|
949
937
|
/** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
950
938
|
pageSize?: number;
|
|
@@ -1050,6 +1038,8 @@ declare namespace gapi.client {
|
|
|
1050
1038
|
interface GoogleCloudDiscoveryengineV1alphaSearchRequestContentSearchSpecSummarySpec {
|
|
1051
1039
|
/** Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */
|
|
1052
1040
|
ignoreAdversarialQuery?: boolean;
|
|
1041
|
+
/** Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */
|
|
1042
|
+
ignoreLowRelevantContent?: boolean;
|
|
1053
1043
|
/** Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */
|
|
1054
1044
|
ignoreNonSummarySeekingQuery?: boolean;
|
|
1055
1045
|
/** Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. */
|
|
@@ -1442,6 +1432,8 @@ declare namespace gapi.client {
|
|
|
1442
1432
|
interface GoogleCloudDiscoveryengineV1AnswerReference {
|
|
1443
1433
|
/** Chunk information. */
|
|
1444
1434
|
chunkInfo?: GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo;
|
|
1435
|
+
/** Structured document information. */
|
|
1436
|
+
structuredDocumentInfo?: GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo;
|
|
1445
1437
|
/** Unstructured document information. */
|
|
1446
1438
|
unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo;
|
|
1447
1439
|
}
|
|
@@ -1452,7 +1444,7 @@ declare namespace gapi.client {
|
|
|
1452
1444
|
content?: string;
|
|
1453
1445
|
/** Document metadata. */
|
|
1454
1446
|
documentMetadata?: GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata;
|
|
1455
|
-
/**
|
|
1447
|
+
/** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
|
|
1456
1448
|
relevanceScore?: number;
|
|
1457
1449
|
}
|
|
1458
1450
|
interface GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata {
|
|
@@ -1467,6 +1459,12 @@ declare namespace gapi.client {
|
|
|
1467
1459
|
/** URI for the document. */
|
|
1468
1460
|
uri?: string;
|
|
1469
1461
|
}
|
|
1462
|
+
interface GoogleCloudDiscoveryengineV1AnswerReferenceStructuredDocumentInfo {
|
|
1463
|
+
/** Document resource name. */
|
|
1464
|
+
document?: string;
|
|
1465
|
+
/** Structured search data. */
|
|
1466
|
+
structData?: {[P in string]: any};
|
|
1467
|
+
}
|
|
1470
1468
|
interface GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo {
|
|
1471
1469
|
/** List of cited chunk contents derived from document content. */
|
|
1472
1470
|
chunkContents?: GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent[];
|
|
@@ -1484,6 +1482,8 @@ declare namespace gapi.client {
|
|
|
1484
1482
|
content?: string;
|
|
1485
1483
|
/** Page identifier. */
|
|
1486
1484
|
pageIdentifier?: string;
|
|
1485
|
+
/** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
|
|
1486
|
+
relevanceScore?: number;
|
|
1487
1487
|
}
|
|
1488
1488
|
interface GoogleCloudDiscoveryengineV1AnswerStep {
|
|
1489
1489
|
/** Actions. */
|
|
@@ -1524,7 +1524,7 @@ declare namespace gapi.client {
|
|
|
1524
1524
|
chunk?: string;
|
|
1525
1525
|
/** Chunk textual content. */
|
|
1526
1526
|
content?: string;
|
|
1527
|
-
/**
|
|
1527
|
+
/** The relevance of the chunk for a given query. Values range from 0.0 (completely irrelevant) to 1.0 (completely relevant). This value is for informational purpose only. It may change for the same query and chunk at any time due to a model retraining or change in implementation. */
|
|
1528
1528
|
relevanceScore?: number;
|
|
1529
1529
|
}
|
|
1530
1530
|
interface GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo {
|
|
@@ -1725,7 +1725,7 @@ declare namespace gapi.client {
|
|
|
1725
1725
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1726
1726
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
1727
1727
|
name?: string;
|
|
1728
|
-
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. */
|
|
1728
|
+
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
|
|
1729
1729
|
parsingConfigOverrides?: {
|
|
1730
1730
|
[P in string]: GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfig;
|
|
1731
1731
|
};
|
|
@@ -1828,7 +1828,7 @@ declare namespace gapi.client {
|
|
|
1828
1828
|
errorSamples?: GoogleRpcStatus[];
|
|
1829
1829
|
/** Required. The specification of the evaluation. */
|
|
1830
1830
|
evaluationSpec?: GoogleCloudDiscoveryengineV1betaEvaluationEvaluationSpec;
|
|
1831
|
-
/**
|
|
1831
|
+
/** Identifier. The full resource name of the Evaluation, in the format of `projects/{project}/locations/{location}/evaluations/{evaluation}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
|
|
1832
1832
|
name?: string;
|
|
1833
1833
|
/** Output only. The metrics produced by the evaluation, averaged across all SampleQuerys in the SampleQuerySet. Only populated when the evaluation's state is SUCCEEDED. */
|
|
1834
1834
|
qualityMetrics?: GoogleCloudDiscoveryengineV1betaQualityMetrics;
|
|
@@ -2069,7 +2069,7 @@ declare namespace gapi.client {
|
|
|
2069
2069
|
naturalLanguageQueryUnderstandingSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestNaturalLanguageQueryUnderstandingSpec;
|
|
2070
2070
|
/** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
2071
2071
|
offset?: number;
|
|
2072
|
-
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering
|
|
2072
|
+
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
2073
2073
|
orderBy?: string;
|
|
2074
2074
|
/** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
2075
2075
|
pageSize?: number;
|
|
@@ -2173,6 +2173,8 @@ declare namespace gapi.client {
|
|
|
2173
2173
|
interface GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecSummarySpec {
|
|
2174
2174
|
/** Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */
|
|
2175
2175
|
ignoreAdversarialQuery?: boolean;
|
|
2176
|
+
/** Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */
|
|
2177
|
+
ignoreLowRelevantContent?: boolean;
|
|
2176
2178
|
/** Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */
|
|
2177
2179
|
ignoreNonSummarySeekingQuery?: boolean;
|
|
2178
2180
|
/** Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. */
|
|
@@ -2750,6 +2752,8 @@ declare namespace gapi.client {
|
|
|
2750
2752
|
interface GoogleCloudDiscoveryengineV1DocumentInfo {
|
|
2751
2753
|
/** The Document resource ID. */
|
|
2752
2754
|
id?: string;
|
|
2755
|
+
/** Output only. Whether the referenced Document can be found in the data store. */
|
|
2756
|
+
joined?: boolean;
|
|
2753
2757
|
/** The Document resource full name, of the form: `projects/{project_id}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}/branches/{branch_id}/documents/{document_id}` */
|
|
2754
2758
|
name?: string;
|
|
2755
2759
|
/** The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. */
|
|
@@ -2766,7 +2770,7 @@ declare namespace gapi.client {
|
|
|
2766
2770
|
defaultParsingConfig?: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
2767
2771
|
/** The full resource name of the Document Processing Config. Format: `projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig`. */
|
|
2768
2772
|
name?: string;
|
|
2769
|
-
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. */
|
|
2773
|
+
/** Map from file type to override the default parsing configuration based on the file type. Supported keys: * `pdf`: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * `html`: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * `docx`: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * `pptx`: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * `xlsx`: Override parsing config for XLSX files, only digital parsing and layout parsing are supported. */
|
|
2770
2774
|
parsingConfigOverrides?: {
|
|
2771
2775
|
[P in string]: GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfig;
|
|
2772
2776
|
};
|
|
@@ -2882,6 +2886,8 @@ declare namespace gapi.client {
|
|
|
2882
2886
|
fhirStore?: string;
|
|
2883
2887
|
/** Intermediate Cloud Storage directory used for the import with a length limit of 2,000 characters. Can be specified if one wants to have the FhirStore export to a specific Cloud Storage directory. */
|
|
2884
2888
|
gcsStagingDir?: string;
|
|
2889
|
+
/** The FHIR resource types to import. The resource types should be a subset of all [supported FHIR resource types](https://cloud.google.com/generative-ai-app-builder/docs/fhir-schema-reference#resource-level-specification). Default to all supported FHIR resource types if empty. */
|
|
2890
|
+
resourceTypes?: string[];
|
|
2885
2891
|
}
|
|
2886
2892
|
interface GoogleCloudDiscoveryengineV1FirestoreSource {
|
|
2887
2893
|
/** Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters. */
|
|
@@ -3192,10 +3198,20 @@ declare namespace gapi.client {
|
|
|
3192
3198
|
updateTime?: string;
|
|
3193
3199
|
}
|
|
3194
3200
|
interface GoogleCloudDiscoveryengineV1PurgeDocumentsRequest {
|
|
3201
|
+
/** The desired location of errors incurred during the purge. */
|
|
3202
|
+
errorConfig?: GoogleCloudDiscoveryengineV1PurgeErrorConfig;
|
|
3195
3203
|
/** Required. Filter matching documents to purge. Only currently supported value is `*` (all items). */
|
|
3196
3204
|
filter?: string;
|
|
3197
3205
|
/** Actually performs the purge. If `force` is set to false, return the expected purge count without deleting any documents. */
|
|
3198
3206
|
force?: boolean;
|
|
3207
|
+
/** Cloud Storage location for the input content. Supported `data_schema`: * `document_id`: One valid Document.id per line. */
|
|
3208
|
+
gcsSource?: GoogleCloudDiscoveryengineV1GcsSource;
|
|
3209
|
+
/** Inline source for the input content for purge. */
|
|
3210
|
+
inlineSource?: GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource;
|
|
3211
|
+
}
|
|
3212
|
+
interface GoogleCloudDiscoveryengineV1PurgeDocumentsRequestInlineSource {
|
|
3213
|
+
/** Required. A list of full resource name of documents to purge. In the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`. Recommended max of 100 items. */
|
|
3214
|
+
documents?: string[];
|
|
3199
3215
|
}
|
|
3200
3216
|
interface GoogleCloudDiscoveryengineV1PurgeDocumentsResponse {
|
|
3201
3217
|
/** The total count of documents purged as a result of the operation. */
|
|
@@ -3203,6 +3219,10 @@ declare namespace gapi.client {
|
|
|
3203
3219
|
/** A sample of document names that will be deleted. Only populated if `force` is set to false. A max of 100 names will be returned and the names are chosen at random. */
|
|
3204
3220
|
purgeSample?: string[];
|
|
3205
3221
|
}
|
|
3222
|
+
interface GoogleCloudDiscoveryengineV1PurgeErrorConfig {
|
|
3223
|
+
/** Cloud Storage prefix for purge errors. This must be an empty, existing Cloud Storage directory. Purge errors are written to sharded files in this directory, one per line, as a JSON-encoded `google.rpc.Status` message. */
|
|
3224
|
+
gcsPrefix?: string;
|
|
3225
|
+
}
|
|
3206
3226
|
interface GoogleCloudDiscoveryengineV1PurgeSuggestionDenyListEntriesMetadata {
|
|
3207
3227
|
/** Operation create time. */
|
|
3208
3228
|
createTime?: string;
|
|
@@ -3216,6 +3236,12 @@ declare namespace gapi.client {
|
|
|
3216
3236
|
/** Number of suggestion deny list entries purged. */
|
|
3217
3237
|
purgeCount?: string;
|
|
3218
3238
|
}
|
|
3239
|
+
interface GoogleCloudDiscoveryengineV1PurgeUserEventsRequest {
|
|
3240
|
+
/** Required. The filter string to specify the events to be deleted with a length limit of 5,000 characters. The eligible fields for filtering are: * `eventType`: Double quoted UserEvent.event_type string. * `eventTime`: in ISO 8601 "zulu" format. * `userPseudoId`: Double quoted string. Specifying this will delete all events associated with a visitor. * `userId`: Double quoted string. Specifying this will delete all events associated with a user. Examples: * Deleting all events in a time range: `eventTime > "2012-04-23T18:25:43.511Z" eventTime < "2012-04-23T18:30:43.511Z"` * Deleting specific eventType: `eventType = "search"` * Deleting all events for a specific visitor: `userPseudoId = "visitor1024"` * Deleting all events inside a DataStore: `*` The filtering fields are assumed to have an implicit AND. */
|
|
3241
|
+
filter?: string;
|
|
3242
|
+
/** The `force` field is currently not supported. Purge user event requests will permanently delete all purgeable events. Once the development is complete: If `force` is set to false, the method will return the expected purge count without deleting any user events. This field will default to false if not included in the request. */
|
|
3243
|
+
force?: boolean;
|
|
3244
|
+
}
|
|
3219
3245
|
interface GoogleCloudDiscoveryengineV1Query {
|
|
3220
3246
|
/** Unique Id for the query. */
|
|
3221
3247
|
queryId?: string;
|
|
@@ -3327,7 +3353,7 @@ declare namespace gapi.client {
|
|
|
3327
3353
|
languageCode?: string;
|
|
3328
3354
|
/** A 0-indexed integer that specifies the current offset (that is, starting result location, amongst the Documents deemed by the API as relevant) in search results. This field is only considered if page_token is unset. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
3329
3355
|
offset?: number;
|
|
3330
|
-
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering
|
|
3356
|
+
/** The order in which documents are returned. Documents can be ordered by a field in an Document object. Leave it unset if ordered by relevance. `order_by` expression is case-sensitive. For more information on ordering the website search results, see [Order web search results](https://cloud.google.com/generative-ai-app-builder/docs/order-web-search-results). For more information on ordering the healthcare search results, see [Order healthcare search results](https://cloud.google.com/generative-ai-app-builder/docs/order-hc-results). If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
|
|
3331
3357
|
orderBy?: string;
|
|
3332
3358
|
/** Maximum number of Documents to return. The maximum allowed value depends on the data type. Values above the maximum value are coerced to the maximum value. * Websites with basic indexing: Default `10`, Maximum `25`. * Websites with advanced indexing: Default `25`, Maximum `50`. * Other: Default `50`, Maximum `100`. If this field is negative, an `INVALID_ARGUMENT` is returned. */
|
|
3333
3359
|
pageSize?: number;
|
|
@@ -3407,6 +3433,8 @@ declare namespace gapi.client {
|
|
|
3407
3433
|
interface GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpecSummarySpec {
|
|
3408
3434
|
/** Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead. */
|
|
3409
3435
|
ignoreAdversarialQuery?: boolean;
|
|
3436
|
+
/** Specifies whether to filter out queries that have low relevance. The default value is `false`. If this field is set to `false`, all search results are used regardless of relevance to generate answers. If set to `true`, only queries with high relevance search results will generate answers. */
|
|
3437
|
+
ignoreLowRelevantContent?: boolean;
|
|
3410
3438
|
/** Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead. */
|
|
3411
3439
|
ignoreNonSummarySeekingQuery?: boolean;
|
|
3412
3440
|
/** Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results. */
|
|
@@ -6593,6 +6621,64 @@ declare namespace gapi.client {
|
|
|
6593
6621
|
},
|
|
6594
6622
|
body: GoogleCloudDiscoveryengineV1ImportUserEventsRequest
|
|
6595
6623
|
): Request<GoogleLongrunningOperation>;
|
|
6624
|
+
/** Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. */
|
|
6625
|
+
purge(request: {
|
|
6626
|
+
/** V1 error format. */
|
|
6627
|
+
'$.xgafv'?: string;
|
|
6628
|
+
/** OAuth access token. */
|
|
6629
|
+
access_token?: string;
|
|
6630
|
+
/** Data format for response. */
|
|
6631
|
+
alt?: string;
|
|
6632
|
+
/** JSONP */
|
|
6633
|
+
callback?: string;
|
|
6634
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6635
|
+
fields?: string;
|
|
6636
|
+
/** 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. */
|
|
6637
|
+
key?: string;
|
|
6638
|
+
/** OAuth 2.0 token for the current user. */
|
|
6639
|
+
oauth_token?: string;
|
|
6640
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
|
|
6641
|
+
parent: string;
|
|
6642
|
+
/** Returns response with indentations and line breaks. */
|
|
6643
|
+
prettyPrint?: boolean;
|
|
6644
|
+
/** 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. */
|
|
6645
|
+
quotaUser?: string;
|
|
6646
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6647
|
+
upload_protocol?: string;
|
|
6648
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6649
|
+
uploadType?: string;
|
|
6650
|
+
/** Request body */
|
|
6651
|
+
resource: GoogleCloudDiscoveryengineV1PurgeUserEventsRequest;
|
|
6652
|
+
}): Request<GoogleLongrunningOperation>;
|
|
6653
|
+
purge(
|
|
6654
|
+
request: {
|
|
6655
|
+
/** V1 error format. */
|
|
6656
|
+
'$.xgafv'?: string;
|
|
6657
|
+
/** OAuth access token. */
|
|
6658
|
+
access_token?: string;
|
|
6659
|
+
/** Data format for response. */
|
|
6660
|
+
alt?: string;
|
|
6661
|
+
/** JSONP */
|
|
6662
|
+
callback?: string;
|
|
6663
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
6664
|
+
fields?: string;
|
|
6665
|
+
/** 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. */
|
|
6666
|
+
key?: string;
|
|
6667
|
+
/** OAuth 2.0 token for the current user. */
|
|
6668
|
+
oauth_token?: string;
|
|
6669
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
|
|
6670
|
+
parent: string;
|
|
6671
|
+
/** Returns response with indentations and line breaks. */
|
|
6672
|
+
prettyPrint?: boolean;
|
|
6673
|
+
/** 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. */
|
|
6674
|
+
quotaUser?: string;
|
|
6675
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6676
|
+
upload_protocol?: string;
|
|
6677
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
6678
|
+
uploadType?: string;
|
|
6679
|
+
},
|
|
6680
|
+
body: GoogleCloudDiscoveryengineV1PurgeUserEventsRequest
|
|
6681
|
+
): Request<GoogleLongrunningOperation>;
|
|
6596
6682
|
/** Writes a single user event. */
|
|
6597
6683
|
write(request: {
|
|
6598
6684
|
/** V1 error format. */
|
|
@@ -6718,6 +6804,8 @@ declare namespace gapi.client {
|
|
|
6718
6804
|
prettyPrint?: boolean;
|
|
6719
6805
|
/** 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. */
|
|
6720
6806
|
quotaUser?: string;
|
|
6807
|
+
/** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
|
|
6808
|
+
skipDefaultSchemaCreation?: boolean;
|
|
6721
6809
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6722
6810
|
upload_protocol?: string;
|
|
6723
6811
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -6751,6 +6839,8 @@ declare namespace gapi.client {
|
|
|
6751
6839
|
prettyPrint?: boolean;
|
|
6752
6840
|
/** 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. */
|
|
6753
6841
|
quotaUser?: string;
|
|
6842
|
+
/** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
|
|
6843
|
+
skipDefaultSchemaCreation?: boolean;
|
|
6754
6844
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
6755
6845
|
upload_protocol?: string;
|
|
6756
6846
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -10652,6 +10742,64 @@ declare namespace gapi.client {
|
|
|
10652
10742
|
},
|
|
10653
10743
|
body: GoogleCloudDiscoveryengineV1ImportUserEventsRequest
|
|
10654
10744
|
): Request<GoogleLongrunningOperation>;
|
|
10745
|
+
/** Deletes permanently all user events specified by the filter provided. Depending on the number of events specified by the filter, this operation could take hours or days to complete. To test a filter, use the list command first. */
|
|
10746
|
+
purge(request: {
|
|
10747
|
+
/** V1 error format. */
|
|
10748
|
+
'$.xgafv'?: string;
|
|
10749
|
+
/** OAuth access token. */
|
|
10750
|
+
access_token?: string;
|
|
10751
|
+
/** Data format for response. */
|
|
10752
|
+
alt?: string;
|
|
10753
|
+
/** JSONP */
|
|
10754
|
+
callback?: string;
|
|
10755
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10756
|
+
fields?: string;
|
|
10757
|
+
/** 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. */
|
|
10758
|
+
key?: string;
|
|
10759
|
+
/** OAuth 2.0 token for the current user. */
|
|
10760
|
+
oauth_token?: string;
|
|
10761
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
|
|
10762
|
+
parent: string;
|
|
10763
|
+
/** Returns response with indentations and line breaks. */
|
|
10764
|
+
prettyPrint?: boolean;
|
|
10765
|
+
/** 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. */
|
|
10766
|
+
quotaUser?: string;
|
|
10767
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10768
|
+
upload_protocol?: string;
|
|
10769
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10770
|
+
uploadType?: string;
|
|
10771
|
+
/** Request body */
|
|
10772
|
+
resource: GoogleCloudDiscoveryengineV1PurgeUserEventsRequest;
|
|
10773
|
+
}): Request<GoogleLongrunningOperation>;
|
|
10774
|
+
purge(
|
|
10775
|
+
request: {
|
|
10776
|
+
/** V1 error format. */
|
|
10777
|
+
'$.xgafv'?: string;
|
|
10778
|
+
/** OAuth access token. */
|
|
10779
|
+
access_token?: string;
|
|
10780
|
+
/** Data format for response. */
|
|
10781
|
+
alt?: string;
|
|
10782
|
+
/** JSONP */
|
|
10783
|
+
callback?: string;
|
|
10784
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10785
|
+
fields?: string;
|
|
10786
|
+
/** 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. */
|
|
10787
|
+
key?: string;
|
|
10788
|
+
/** OAuth 2.0 token for the current user. */
|
|
10789
|
+
oauth_token?: string;
|
|
10790
|
+
/** Required. The resource name of the catalog under which the events are created. The format is `projects/${projectId}/locations/global/collections/{$collectionId}/dataStores/${dataStoreId}` */
|
|
10791
|
+
parent: string;
|
|
10792
|
+
/** Returns response with indentations and line breaks. */
|
|
10793
|
+
prettyPrint?: boolean;
|
|
10794
|
+
/** 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. */
|
|
10795
|
+
quotaUser?: string;
|
|
10796
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10797
|
+
upload_protocol?: string;
|
|
10798
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10799
|
+
uploadType?: string;
|
|
10800
|
+
},
|
|
10801
|
+
body: GoogleCloudDiscoveryengineV1PurgeUserEventsRequest
|
|
10802
|
+
): Request<GoogleLongrunningOperation>;
|
|
10655
10803
|
/** Writes a single user event. */
|
|
10656
10804
|
write(request: {
|
|
10657
10805
|
/** V1 error format. */
|
|
@@ -10777,6 +10925,8 @@ declare namespace gapi.client {
|
|
|
10777
10925
|
prettyPrint?: boolean;
|
|
10778
10926
|
/** 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. */
|
|
10779
10927
|
quotaUser?: string;
|
|
10928
|
+
/** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
|
|
10929
|
+
skipDefaultSchemaCreation?: boolean;
|
|
10780
10930
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10781
10931
|
upload_protocol?: string;
|
|
10782
10932
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
@@ -10810,6 +10960,8 @@ declare namespace gapi.client {
|
|
|
10810
10960
|
prettyPrint?: boolean;
|
|
10811
10961
|
/** 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. */
|
|
10812
10962
|
quotaUser?: string;
|
|
10963
|
+
/** A boolean flag indicating whether to skip the default schema creation for the data store. Only enable this flag if you are certain that the default schema is incompatible with your use case. If set to true, you must manually create a schema for the data store before any documents can be ingested. This flag cannot be specified if `data_store.starting_schema` is specified. */
|
|
10964
|
+
skipDefaultSchemaCreation?: boolean;
|
|
10813
10965
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10814
10966
|
upload_protocol?: string;
|
|
10815
10967
|
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|