@maxim_mazurok/gapi.client.discoveryengine-v1beta 0.0.20250708 → 0.0.20250716
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 +226 -7
- package/package.json +1 -1
- package/readme.md +3 -0
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=v1beta
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20250716
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -940,6 +940,8 @@ declare namespace gapi.client {
|
|
|
940
940
|
}
|
|
941
941
|
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
942
942
|
interface GoogleCloudDiscoveryengineV1alphaDocumentProcessingConfigParsingConfigLayoutParsingConfig {
|
|
943
|
+
/** Optional. If true, the processed document will be made available for the GetProcessedDocument API. */
|
|
944
|
+
enableGetProcessedDocument?: boolean;
|
|
943
945
|
/** Optional. If true, the LLM based annotation is added to the image during parsing. */
|
|
944
946
|
enableImageAnnotation?: boolean;
|
|
945
947
|
/** Optional. If true, the LLM based annotation is added to the table during parsing. */
|
|
@@ -981,7 +983,7 @@ declare namespace gapi.client {
|
|
|
981
983
|
disableAnalytics?: boolean;
|
|
982
984
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
983
985
|
displayName?: string;
|
|
984
|
-
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` */
|
|
986
|
+
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. */
|
|
985
987
|
features?: {[P in string]: string};
|
|
986
988
|
/** Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */
|
|
987
989
|
industryVertical?: string;
|
|
@@ -1597,7 +1599,7 @@ declare namespace gapi.client {
|
|
|
1597
1599
|
searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSearchAsYouTypeSpec;
|
|
1598
1600
|
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
1599
1601
|
servingConfig?: string;
|
|
1600
|
-
/** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls):
|
|
1602
|
+
/** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */
|
|
1601
1603
|
session?: string;
|
|
1602
1604
|
/** Session specification. Can be used only when `session` is set. */
|
|
1603
1605
|
sessionSpec?: GoogleCloudDiscoveryengineV1alphaSearchRequestSessionSpec;
|
|
@@ -2583,6 +2585,104 @@ declare namespace gapi.client {
|
|
|
2583
2585
|
/** The query to search. */
|
|
2584
2586
|
query?: string;
|
|
2585
2587
|
}
|
|
2588
|
+
interface GoogleCloudDiscoveryengineV1betaAssistAnswer {
|
|
2589
|
+
/** Reasons for not answering the assist call. */
|
|
2590
|
+
assistSkippedReasons?: string[];
|
|
2591
|
+
/** Replies of the assistant. */
|
|
2592
|
+
replies?: GoogleCloudDiscoveryengineV1betaAssistAnswerReply[];
|
|
2593
|
+
/** State of the answer generation. */
|
|
2594
|
+
state?: string;
|
|
2595
|
+
}
|
|
2596
|
+
interface GoogleCloudDiscoveryengineV1betaAssistAnswerReply {
|
|
2597
|
+
/** Possibly grounded response text or media from the assistant. */
|
|
2598
|
+
groundedContent?: GoogleCloudDiscoveryengineV1betaAssistantGroundedContent;
|
|
2599
|
+
}
|
|
2600
|
+
interface GoogleCloudDiscoveryengineV1betaAssistantContent {
|
|
2601
|
+
/** Result of executing an ExecutableCode. */
|
|
2602
|
+
codeExecutionResult?: GoogleCloudDiscoveryengineV1betaAssistantContentCodeExecutionResult;
|
|
2603
|
+
/** Code generated by the model that is meant to be executed. */
|
|
2604
|
+
executableCode?: GoogleCloudDiscoveryengineV1betaAssistantContentExecutableCode;
|
|
2605
|
+
/** A file, e.g., an audio summary. */
|
|
2606
|
+
file?: GoogleCloudDiscoveryengineV1betaAssistantContentFile;
|
|
2607
|
+
/** Inline binary data. */
|
|
2608
|
+
inlineData?: GoogleCloudDiscoveryengineV1betaAssistantContentBlob;
|
|
2609
|
+
/** The producer of the content. Can be "model" or "user". */
|
|
2610
|
+
role?: string;
|
|
2611
|
+
/** Inline text. */
|
|
2612
|
+
text?: string;
|
|
2613
|
+
/** Optional. Indicates if the part is thought from the model. */
|
|
2614
|
+
thought?: boolean;
|
|
2615
|
+
}
|
|
2616
|
+
interface GoogleCloudDiscoveryengineV1betaAssistantContentBlob {
|
|
2617
|
+
/** Required. Raw bytes. */
|
|
2618
|
+
data?: string;
|
|
2619
|
+
/** Required. The media type (MIME type) of the generated data. */
|
|
2620
|
+
mimeType?: string;
|
|
2621
|
+
}
|
|
2622
|
+
interface GoogleCloudDiscoveryengineV1betaAssistantContentCodeExecutionResult {
|
|
2623
|
+
/** Required. Outcome of the code execution. */
|
|
2624
|
+
outcome?: string;
|
|
2625
|
+
/** Optional. Contains stdout when code execution is successful, stderr or other description otherwise. */
|
|
2626
|
+
output?: string;
|
|
2627
|
+
}
|
|
2628
|
+
interface GoogleCloudDiscoveryengineV1betaAssistantContentExecutableCode {
|
|
2629
|
+
/** Required. The code content. Currently only supports Python. */
|
|
2630
|
+
code?: string;
|
|
2631
|
+
}
|
|
2632
|
+
interface GoogleCloudDiscoveryengineV1betaAssistantContentFile {
|
|
2633
|
+
/** Required. The file ID. */
|
|
2634
|
+
fileId?: string;
|
|
2635
|
+
/** Required. The media type (MIME type) of the file. */
|
|
2636
|
+
mimeType?: string;
|
|
2637
|
+
}
|
|
2638
|
+
interface GoogleCloudDiscoveryengineV1betaAssistantGroundedContent {
|
|
2639
|
+
/** The content. */
|
|
2640
|
+
content?: GoogleCloudDiscoveryengineV1betaAssistantContent;
|
|
2641
|
+
/** Metadata for grounding based on text sources. */
|
|
2642
|
+
textGroundingMetadata?: GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadata;
|
|
2643
|
+
}
|
|
2644
|
+
interface GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadata {
|
|
2645
|
+
/** References for the grounded text. */
|
|
2646
|
+
references?: GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReference[];
|
|
2647
|
+
/** Grounding information for parts of the text. */
|
|
2648
|
+
segments?: GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataSegment[];
|
|
2649
|
+
}
|
|
2650
|
+
interface GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReference {
|
|
2651
|
+
/** Referenced text content. */
|
|
2652
|
+
content?: string;
|
|
2653
|
+
/** Document metadata. */
|
|
2654
|
+
documentMetadata?: GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata;
|
|
2655
|
+
}
|
|
2656
|
+
interface GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataReferenceDocumentMetadata {
|
|
2657
|
+
/** Document resource name. */
|
|
2658
|
+
document?: string;
|
|
2659
|
+
/** Domain name from the document URI. Note that the `uri` field may contain a URL that redirects to the actual website, in which case this will contain the domain name of the target site. */
|
|
2660
|
+
domain?: string;
|
|
2661
|
+
/** Page identifier. */
|
|
2662
|
+
pageIdentifier?: string;
|
|
2663
|
+
/** Title. */
|
|
2664
|
+
title?: string;
|
|
2665
|
+
/** URI for the document. It may contain a URL that redirects to the actual website. */
|
|
2666
|
+
uri?: string;
|
|
2667
|
+
}
|
|
2668
|
+
interface GoogleCloudDiscoveryengineV1betaAssistantGroundedContentTextGroundingMetadataSegment {
|
|
2669
|
+
/** End of the segment, exclusive. */
|
|
2670
|
+
endIndex?: string;
|
|
2671
|
+
/** Score for the segment. */
|
|
2672
|
+
groundingScore?: number;
|
|
2673
|
+
/** References for the segment. */
|
|
2674
|
+
referenceIndices?: number[];
|
|
2675
|
+
/** Zero-based index indicating the start of the segment, measured in bytes of a UTF-8 string (i.e. characters encoded on multiple bytes have a length of more than one). */
|
|
2676
|
+
startIndex?: string;
|
|
2677
|
+
/** The text segment itself. */
|
|
2678
|
+
text?: string;
|
|
2679
|
+
}
|
|
2680
|
+
interface GoogleCloudDiscoveryengineV1betaAssistUserMetadata {
|
|
2681
|
+
/** Optional. Preferred language to be used for answering if language detection fails. Also used as the language of error messages created by actions, regardless of language detection results. */
|
|
2682
|
+
preferredLanguageCode?: string;
|
|
2683
|
+
/** Optional. IANA time zone, e.g. Europe/Budapest. */
|
|
2684
|
+
timeZone?: string;
|
|
2685
|
+
}
|
|
2586
2686
|
interface GoogleCloudDiscoveryengineV1betaBatchCreateTargetSiteMetadata {
|
|
2587
2687
|
/** Operation create time. */
|
|
2588
2688
|
createTime?: string;
|
|
@@ -3291,6 +3391,8 @@ declare namespace gapi.client {
|
|
|
3291
3391
|
}
|
|
3292
3392
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
3293
3393
|
interface GoogleCloudDiscoveryengineV1betaDocumentProcessingConfigParsingConfigLayoutParsingConfig {
|
|
3394
|
+
/** Optional. If true, the processed document will be made available for the GetProcessedDocument API. */
|
|
3395
|
+
enableGetProcessedDocument?: boolean;
|
|
3294
3396
|
/** Optional. If true, the LLM based annotation is added to the image during parsing. */
|
|
3295
3397
|
enableImageAnnotation?: boolean;
|
|
3296
3398
|
/** Optional. If true, the LLM based annotation is added to the table during parsing. */
|
|
@@ -3341,7 +3443,7 @@ declare namespace gapi.client {
|
|
|
3341
3443
|
disableAnalytics?: boolean;
|
|
3342
3444
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
3343
3445
|
displayName?: string;
|
|
3344
|
-
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` */
|
|
3446
|
+
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. */
|
|
3345
3447
|
features?: {[P in string]: string};
|
|
3346
3448
|
/** Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */
|
|
3347
3449
|
industryVertical?: string;
|
|
@@ -3605,7 +3707,7 @@ declare namespace gapi.client {
|
|
|
3605
3707
|
forceRefreshContent?: boolean;
|
|
3606
3708
|
/** Cloud Storage location for the input content. */
|
|
3607
3709
|
gcsSource?: GoogleCloudDiscoveryengineV1betaGcsSource;
|
|
3608
|
-
/** The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. *
|
|
3710
|
+
/** The field indicates the ID field or column to be used as unique IDs of the documents. For GcsSource it is the key of the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`. For others, it may be the column name of the table where the unique ids are stored. The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters. Otherwise, documents without valid IDs fail to be imported. Only set this field when auto_generate_ids is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value `_id` is used when importing from the allowed data sources. Supported data sources: * GcsSource. GcsSource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * BigQuerySource. BigQuerySource.data_schema must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown. * SpannerSource. * CloudSqlSource. * BigtableSource. */
|
|
3609
3711
|
idField?: string;
|
|
3610
3712
|
/** The Inline source for the input content for documents. */
|
|
3611
3713
|
inlineSource?: GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource;
|
|
@@ -4303,7 +4405,7 @@ declare namespace gapi.client {
|
|
|
4303
4405
|
searchAsYouTypeSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSearchAsYouTypeSpec;
|
|
4304
4406
|
/** Required. The resource name of the Search serving config, such as `projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config`, or `projects/*/locations/global/collections/default_collection/dataStores/default_data_store/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
|
|
4305
4407
|
servingConfig?: string;
|
|
4306
|
-
/** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls):
|
|
4408
|
+
/** The session resource name. Optional. Session allows users to do multi-turn /search API calls or coordination between /search API calls and /answer API calls. Example #1 (multi-turn /search API calls): Call /search API with the session ID generated in the first call. Here, the previous search query gets considered in query standing. I.e., if the first query is "How did Alphabet do in 2022?" and the current query is "How about 2023?", the current query will be interpreted as "How did Alphabet do in 2023?". Example #2 (coordination between /search API calls and /answer API calls): Call /answer API with the session ID generated in the first call. Here, the answer generation happens in the context of the search results from the first search call. Multi-turn Search feature is currently at private GA stage. Please use v1alpha or v1beta version instead before we launch this feature to public GA. Or ask for allowlisting through Google Support team. */
|
|
4307
4409
|
session?: string;
|
|
4308
4410
|
/** Session specification. Can be used only when `session` is set. */
|
|
4309
4411
|
sessionSpec?: GoogleCloudDiscoveryengineV1betaSearchRequestSessionSpec;
|
|
@@ -4885,6 +4987,60 @@ declare namespace gapi.client {
|
|
|
4885
4987
|
/** Required. The table name of the Spanner database that needs to be imported. */
|
|
4886
4988
|
tableId?: string;
|
|
4887
4989
|
}
|
|
4990
|
+
interface GoogleCloudDiscoveryengineV1betaStreamAssistRequest {
|
|
4991
|
+
/** Optional. Specification of the generation configuration for the request. */
|
|
4992
|
+
generationSpec?: GoogleCloudDiscoveryengineV1betaStreamAssistRequestGenerationSpec;
|
|
4993
|
+
/** Optional. Current user query. Empty query is only supported if `file_ids` are provided. In this case, the answer will be generated based on those context files. */
|
|
4994
|
+
query?: GoogleCloudDiscoveryengineV1betaQuery;
|
|
4995
|
+
/** Optional. The session to use for the request. If specified, the assistant has access to the session history, and the query and the answer are stored there. If `-` is specified as the session ID, or it is left empty, then a new session is created with an automatically generated ID. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}` */
|
|
4996
|
+
session?: string;
|
|
4997
|
+
/** Optional. Specification of tools that are used to serve the request. */
|
|
4998
|
+
toolsSpec?: GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpec;
|
|
4999
|
+
/** Optional. Information about the user initiating the query. */
|
|
5000
|
+
userMetadata?: GoogleCloudDiscoveryengineV1betaAssistUserMetadata;
|
|
5001
|
+
}
|
|
5002
|
+
interface GoogleCloudDiscoveryengineV1betaStreamAssistRequestGenerationSpec {
|
|
5003
|
+
/** Optional. The Vertex AI model_id used for the generative model. If not set, the default Assistant model will be used. */
|
|
5004
|
+
modelId?: string;
|
|
5005
|
+
}
|
|
5006
|
+
interface GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpec {
|
|
5007
|
+
/** Optional. Specification of the image generation tool. */
|
|
5008
|
+
imageGenerationSpec?: any;
|
|
5009
|
+
/** Optional. The name of the tool registry to use. Format: `projects/{project}/locations/{location}/toolRegistries/{tool_registry}` */
|
|
5010
|
+
toolRegistry?: string;
|
|
5011
|
+
/** Optional. Specification of the Vertex AI Search tool. */
|
|
5012
|
+
vertexAiSearchSpec?: GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVertexAiSearchSpec;
|
|
5013
|
+
/** Optional. Specification of the video generation tool. */
|
|
5014
|
+
videoGenerationSpec?: any;
|
|
5015
|
+
/** Optional. Specification of the web grounding tool. If field is present, enables grounding with web search. Works only if Assistant.web_grounding_type is WEB_GROUNDING_TYPE_GOOGLE_SEARCH or WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH. */
|
|
5016
|
+
webGroundingSpec?: GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecWebGroundingSpec;
|
|
5017
|
+
}
|
|
5018
|
+
interface GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecImageGenerationSpec {}
|
|
5019
|
+
interface GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVertexAiSearchSpec {
|
|
5020
|
+
/** Optional. Specs defining DataStores to filter on in a search call and configurations for those data stores. This is only considered for Engines with multiple data stores. */
|
|
5021
|
+
dataStoreSpecs?: GoogleCloudDiscoveryengineV1betaSearchRequestDataStoreSpec[];
|
|
5022
|
+
/** Optional. Deprecated. Please refrain from using this field. Whether the Vertex AI Search tool is disabled. Default value is false, the tool is enabled by default. */
|
|
5023
|
+
disabled?: boolean;
|
|
5024
|
+
/** Optional. The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata) */
|
|
5025
|
+
filter?: string;
|
|
5026
|
+
}
|
|
5027
|
+
interface GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecVideoGenerationSpec {}
|
|
5028
|
+
interface GoogleCloudDiscoveryengineV1betaStreamAssistRequestToolsSpecWebGroundingSpec {
|
|
5029
|
+
/** Optional. Deprecated. Please refrain from using this field. Whether the web grounding tool is enabled. */
|
|
5030
|
+
enabled?: boolean;
|
|
5031
|
+
}
|
|
5032
|
+
interface GoogleCloudDiscoveryengineV1betaStreamAssistResponse {
|
|
5033
|
+
/** Assist answer resource object containing parts of the assistant's final answer for the user's query. Not present if the current response doesn't add anything to previously sent AssistAnswer.replies. Observe AssistAnswer.state to see if more parts are to be expected. While the state is `IN_PROGRESS`, the AssistAnswer.replies field in each response will contain replies (reply fragments) to be appended to the ones received in previous responses. AssistAnswer.name won't be filled. If the state is `SUCCEEDED`, `FAILED` or `SKIPPED`, the response is the last response and AssistAnswer.name will have a value. */
|
|
5034
|
+
answer?: GoogleCloudDiscoveryengineV1betaAssistAnswer;
|
|
5035
|
+
/** A global unique ID that identifies the current pair of request and stream of responses. Used for feedback and support. */
|
|
5036
|
+
assistToken?: string;
|
|
5037
|
+
/** Session information. */
|
|
5038
|
+
sessionInfo?: GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo;
|
|
5039
|
+
}
|
|
5040
|
+
interface GoogleCloudDiscoveryengineV1betaStreamAssistResponseSessionInfo {
|
|
5041
|
+
/** Name of the newly generated or continued session. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}`. */
|
|
5042
|
+
session?: string;
|
|
5043
|
+
}
|
|
4888
5044
|
interface GoogleCloudDiscoveryengineV1betaSuggestionDenyListEntry {
|
|
4889
5045
|
/** Required. Phrase to block from suggestions served. Can be maximum 125 characters. */
|
|
4890
5046
|
blockPhrase?: string;
|
|
@@ -5358,6 +5514,8 @@ declare namespace gapi.client {
|
|
|
5358
5514
|
}
|
|
5359
5515
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigDigitalParsingConfig {}
|
|
5360
5516
|
interface GoogleCloudDiscoveryengineV1DocumentProcessingConfigParsingConfigLayoutParsingConfig {
|
|
5517
|
+
/** Optional. If true, the processed document will be made available for the GetProcessedDocument API. */
|
|
5518
|
+
enableGetProcessedDocument?: boolean;
|
|
5361
5519
|
/** Optional. If true, the LLM based annotation is added to the image during parsing. */
|
|
5362
5520
|
enableImageAnnotation?: boolean;
|
|
5363
5521
|
/** Optional. If true, the LLM based annotation is added to the table during parsing. */
|
|
@@ -5399,7 +5557,7 @@ declare namespace gapi.client {
|
|
|
5399
5557
|
disableAnalytics?: boolean;
|
|
5400
5558
|
/** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
|
|
5401
5559
|
displayName?: string;
|
|
5402
|
-
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` */
|
|
5560
|
+
/** Optional. Feature config for the engine to opt in or opt out of features. Supported keys: * `*`: all features, if it's present, all other feature state settings are ignored. * `agent-gallery` * `no-code-agent-builder` * `prompt-gallery` * `model-selector` * `notebook-lm` * `people-search` * `people-search-org-chart` * `bi-directional-audio` * `feedback` * `session-sharing` * `personalization-memory` - Enables personalization based on user preferences. */
|
|
5403
5561
|
features?: {[P in string]: string};
|
|
5404
5562
|
/** Optional. The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: Vertical on Engine has to match vertical of the DataStore linked to the engine. */
|
|
5405
5563
|
industryVertical?: string;
|
|
@@ -9902,6 +10060,66 @@ declare namespace gapi.client {
|
|
|
9902
10060
|
suggestionDenyListEntries: SuggestionDenyListEntriesResource;
|
|
9903
10061
|
userEvents: UserEventsResource;
|
|
9904
10062
|
}
|
|
10063
|
+
interface AssistantsResource {
|
|
10064
|
+
/** Assists the user with a query in a streaming fashion. */
|
|
10065
|
+
streamAssist(request: {
|
|
10066
|
+
/** V1 error format. */
|
|
10067
|
+
'$.xgafv'?: string;
|
|
10068
|
+
/** OAuth access token. */
|
|
10069
|
+
access_token?: string;
|
|
10070
|
+
/** Data format for response. */
|
|
10071
|
+
alt?: string;
|
|
10072
|
+
/** JSONP */
|
|
10073
|
+
callback?: string;
|
|
10074
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10075
|
+
fields?: string;
|
|
10076
|
+
/** 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. */
|
|
10077
|
+
key?: string;
|
|
10078
|
+
/** Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` */
|
|
10079
|
+
name: string;
|
|
10080
|
+
/** OAuth 2.0 token for the current user. */
|
|
10081
|
+
oauth_token?: string;
|
|
10082
|
+
/** Returns response with indentations and line breaks. */
|
|
10083
|
+
prettyPrint?: boolean;
|
|
10084
|
+
/** 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. */
|
|
10085
|
+
quotaUser?: string;
|
|
10086
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10087
|
+
upload_protocol?: string;
|
|
10088
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10089
|
+
uploadType?: string;
|
|
10090
|
+
/** Request body */
|
|
10091
|
+
resource: GoogleCloudDiscoveryengineV1betaStreamAssistRequest;
|
|
10092
|
+
}): Request<GoogleCloudDiscoveryengineV1betaStreamAssistResponse>;
|
|
10093
|
+
streamAssist(
|
|
10094
|
+
request: {
|
|
10095
|
+
/** V1 error format. */
|
|
10096
|
+
'$.xgafv'?: string;
|
|
10097
|
+
/** OAuth access token. */
|
|
10098
|
+
access_token?: string;
|
|
10099
|
+
/** Data format for response. */
|
|
10100
|
+
alt?: string;
|
|
10101
|
+
/** JSONP */
|
|
10102
|
+
callback?: string;
|
|
10103
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
10104
|
+
fields?: string;
|
|
10105
|
+
/** 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. */
|
|
10106
|
+
key?: string;
|
|
10107
|
+
/** Required. The resource name of the Assistant. Format: `projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}` */
|
|
10108
|
+
name: string;
|
|
10109
|
+
/** OAuth 2.0 token for the current user. */
|
|
10110
|
+
oauth_token?: string;
|
|
10111
|
+
/** Returns response with indentations and line breaks. */
|
|
10112
|
+
prettyPrint?: boolean;
|
|
10113
|
+
/** 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. */
|
|
10114
|
+
quotaUser?: string;
|
|
10115
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
10116
|
+
upload_protocol?: string;
|
|
10117
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
10118
|
+
uploadType?: string;
|
|
10119
|
+
},
|
|
10120
|
+
body: GoogleCloudDiscoveryengineV1betaStreamAssistRequest,
|
|
10121
|
+
): Request<GoogleCloudDiscoveryengineV1betaStreamAssistResponse>;
|
|
10122
|
+
}
|
|
9905
10123
|
interface CompletionConfigResource {
|
|
9906
10124
|
/** Completes the user input with advanced keyword suggestions. */
|
|
9907
10125
|
completeQuery(request: {
|
|
@@ -11605,6 +11823,7 @@ declare namespace gapi.client {
|
|
|
11605
11823
|
},
|
|
11606
11824
|
body: GoogleCloudDiscoveryengineV1betaTuneEngineRequest,
|
|
11607
11825
|
): Request<GoogleLongrunningOperation>;
|
|
11826
|
+
assistants: AssistantsResource;
|
|
11608
11827
|
completionConfig: CompletionConfigResource;
|
|
11609
11828
|
controls: ControlsResource;
|
|
11610
11829
|
conversations: ConversationsResource;
|
package/package.json
CHANGED
package/readme.md
CHANGED
|
@@ -48,6 +48,9 @@ Don't forget to authenticate your client before sending any request to resources
|
|
|
48
48
|
// declare client_id registered in Google Developers Console
|
|
49
49
|
var client_id = '',
|
|
50
50
|
scope = [
|
|
51
|
+
// Search your organization's data in the Cloud Search index
|
|
52
|
+
'https://www.googleapis.com/auth/cloud_search.query',
|
|
53
|
+
|
|
51
54
|
// See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account.
|
|
52
55
|
'https://www.googleapis.com/auth/cloud-platform',
|
|
53
56
|
],
|