@maxim_mazurok/gapi.client.discoveryengine-v1 0.0.20240510 → 0.0.20240517

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 +2175 -596
  2. 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: 20240510
12
+ // Revision: 20240517
13
13
 
14
14
  /// <reference types="gapi.client" />
15
15
 
@@ -386,7 +386,7 @@ declare namespace gapi.client {
386
386
  dataStoreIds?: string[];
387
387
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
388
388
  displayName?: string;
389
- /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine. */
389
+ /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. */
390
390
  industryVertical?: string;
391
391
  /** Configurations for the Media Engine. Only applicable on the data stores with solution_type SOLUTION_TYPE_RECOMMENDATION and IndustryVertical.MEDIA vertical. */
392
392
  mediaRecommendationEngineConfig?: GoogleCloudDiscoveryengineV1alphaEngineMediaRecommendationEngineConfig;
@@ -696,7 +696,7 @@ declare namespace gapi.client {
696
696
  userPseudoId?: string;
697
697
  }
698
698
  interface GoogleCloudDiscoveryengineV1alphaSessionTurn {
699
- /** The resource name of the answer to the user query. */
699
+ /** The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */
700
700
  answer?: string;
701
701
  /** The user query. */
702
702
  query?: GoogleCloudDiscoveryengineV1alphaQuery;
@@ -772,6 +772,280 @@ declare namespace gapi.client {
772
772
  /** Operation last update time. If the operation is done, this is also the finish time. */
773
773
  updateTime?: string;
774
774
  }
775
+ interface GoogleCloudDiscoveryengineV1Answer {
776
+ /** Additional answer-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set. */
777
+ answerSkippedReasons?: string[];
778
+ /** The textual answer. */
779
+ answerText?: string;
780
+ /** Citations. */
781
+ citations?: GoogleCloudDiscoveryengineV1AnswerCitation[];
782
+ /** Output only. Answer completed timestamp. */
783
+ completeTime?: string;
784
+ /** Output only. Answer creation timestamp. */
785
+ createTime?: string;
786
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*‍/answers/*` */
787
+ name?: string;
788
+ /** Query understanding information. */
789
+ queryUnderstandingInfo?: GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo;
790
+ /** References. */
791
+ references?: GoogleCloudDiscoveryengineV1AnswerReference[];
792
+ /** Suggested related questions. */
793
+ relatedQuestions?: string[];
794
+ /** The state of the answer generation. */
795
+ state?: string;
796
+ /** Answer generation steps. */
797
+ steps?: GoogleCloudDiscoveryengineV1AnswerStep[];
798
+ }
799
+ interface GoogleCloudDiscoveryengineV1AnswerCitation {
800
+ /** End of the attributed segment, exclusive. */
801
+ endIndex?: string;
802
+ /** Citation sources for the attributed segment. */
803
+ sources?: GoogleCloudDiscoveryengineV1AnswerCitationSource[];
804
+ /** Index indicates the start of the segment, measured in bytes (UTF-8 unicode). */
805
+ startIndex?: string;
806
+ }
807
+ interface GoogleCloudDiscoveryengineV1AnswerCitationSource {
808
+ /** ID of the citation source. */
809
+ referenceId?: string;
810
+ }
811
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequest {
812
+ /** Answer generation specification. */
813
+ answerGenerationSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec;
814
+ /** Asynchronous mode control. If enabled, the response will be returned with answer/session resource name without final answer. The API users need to do the polling to get the latest status of answer/session by calling ConversationalSearchService.GetAnswer or ConversationalSearchService.GetSession method. */
815
+ asynchronousMode?: boolean;
816
+ /** Required. Current user query. */
817
+ query?: GoogleCloudDiscoveryengineV1Query;
818
+ /** Query understanding specification. */
819
+ queryUnderstandingSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec;
820
+ /** Related questions specification. */
821
+ relatedQuestionsSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec;
822
+ /** Model specification. */
823
+ safetySpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec;
824
+ /** Search specification. */
825
+ searchSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec;
826
+ /** The session resource name. Not required. When session field is not set, the API is in sessionless mode. We support auto session mode: users can use the wildcard symbol `-` as session ID. A new ID will be automatically generated and assigned. */
827
+ session?: string;
828
+ /** A unique identifier for tracking visitors. For example, this could be implemented with an HTTP cookie, which should be able to uniquely identify a visitor on a single device. This unique identifier should not change if the visitor logs in or out of the website. This field should NOT have a fixed value such as `unknown_visitor`. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
829
+ userPseudoId?: string;
830
+ }
831
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpec {
832
+ /** Language code for Answer. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature. */
833
+ answerLanguageCode?: string;
834
+ /** Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No answer 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 answers for adversarial queries and return fallback messages instead. */
835
+ ignoreAdversarialQuery?: boolean;
836
+ /** Specifies whether to filter out queries that are not answer-seeking. The default value is `false`. Google employs search-query classification to detect answer-seeking queries. No answer is returned if the search query is classified as a non-answer seeking query. If this field is set to `true`, we skip generating answers for non-answer seeking queries and return fallback messages instead. */
837
+ ignoreNonAnswerSeekingQuery?: boolean;
838
+ /** Specifies whether to include citation metadata in the answer. The default value is `false`. */
839
+ includeCitations?: boolean;
840
+ /** Answer generation model specification. */
841
+ modelSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec;
842
+ /** Answer generation prompt specification. */
843
+ promptSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec;
844
+ }
845
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecModelSpec {
846
+ /** Model version. If not set, it will use the default stable model. Allowed values are: stable, preview. */
847
+ modelVersion?: string;
848
+ }
849
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestAnswerGenerationSpecPromptSpec {
850
+ /** Customized preamble. */
851
+ preamble?: string;
852
+ }
853
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpec {
854
+ /** Query classification specification. */
855
+ queryClassificationSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec;
856
+ /** Query rephraser specification. */
857
+ queryRephraserSpec?: GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec;
858
+ }
859
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryClassificationSpec {
860
+ /** Enabled query classification types. */
861
+ types?: string[];
862
+ }
863
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestQueryUnderstandingSpecQueryRephraserSpec {
864
+ /** Disable query rephraser. */
865
+ disable?: boolean;
866
+ }
867
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestRelatedQuestionsSpec {
868
+ /** Enable related questions feature if true. */
869
+ enable?: boolean;
870
+ }
871
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSafetySpec {
872
+ /** Enable the safety filtering on the answer response. It is false by default. */
873
+ enable?: boolean;
874
+ }
875
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpec {
876
+ /** Search parameters. */
877
+ searchParams?: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams;
878
+ /** Search result list. */
879
+ searchResultList?: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList;
880
+ }
881
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchParams {
882
+ /** Boost specification to boost certain documents in search results which may affect the answer query response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */
883
+ boostSpec?: GoogleCloudDiscoveryengineV1SearchRequestBoostSpec;
884
+ /** 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. This will be used to filter search results which may affect the Answer response. 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 customers 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) */
885
+ filter?: string;
886
+ /** Number of search results to return. The default value is 10. */
887
+ maxReturnResults?: number;
888
+ /** 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, see [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order) If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. */
889
+ orderBy?: string;
890
+ }
891
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultList {
892
+ /** Search results. */
893
+ searchResults?: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult[];
894
+ }
895
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResult {
896
+ /** Chunk information. */
897
+ chunkInfo?: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo;
898
+ /** Unstructured document information. */
899
+ unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo;
900
+ }
901
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultChunkInfo {
902
+ /** Chunk resource name. */
903
+ chunk?: string;
904
+ /** Chunk textual content. */
905
+ content?: string;
906
+ }
907
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfo {
908
+ /** Document resource name. */
909
+ document?: string;
910
+ /** List of document contexts. */
911
+ documentContexts?: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext[];
912
+ /** List of extractive answers. */
913
+ extractiveAnswers?: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer[];
914
+ /** List of extractive segments. */
915
+ extractiveSegments?: GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment[];
916
+ /** Title. */
917
+ title?: string;
918
+ /** URI for the document. */
919
+ uri?: string;
920
+ }
921
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoDocumentContext {
922
+ /** Document content. */
923
+ content?: string;
924
+ /** Page identifier. */
925
+ pageIdentifier?: string;
926
+ }
927
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveAnswer {
928
+ /** Extractive answer content. */
929
+ content?: string;
930
+ /** Page identifier. */
931
+ pageIdentifier?: string;
932
+ }
933
+ interface GoogleCloudDiscoveryengineV1AnswerQueryRequestSearchSpecSearchResultListSearchResultUnstructuredDocumentInfoExtractiveSegment {
934
+ /** Extractive segment content. */
935
+ content?: string;
936
+ /** Page identifier. */
937
+ pageIdentifier?: string;
938
+ }
939
+ interface GoogleCloudDiscoveryengineV1AnswerQueryResponse {
940
+ /** Answer resource object. If AnswerQueryRequest.StepSpec.max_step_count is greater than 1, use Answer.name to fetch answer information using ConversationalSearchService.GetAnswer API. */
941
+ answer?: GoogleCloudDiscoveryengineV1Answer;
942
+ /** A global unique ID used for logging. */
943
+ answerQueryToken?: string;
944
+ /** Session resource object. It will be only available when session field is set and valid in the AnswerQueryRequest request. */
945
+ session?: GoogleCloudDiscoveryengineV1Session;
946
+ }
947
+ interface GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfo {
948
+ /** Query classification information. */
949
+ queryClassificationInfo?: GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo[];
950
+ }
951
+ interface GoogleCloudDiscoveryengineV1AnswerQueryUnderstandingInfoQueryClassificationInfo {
952
+ /** Classification output. */
953
+ positive?: boolean;
954
+ /** Query classification type. */
955
+ type?: string;
956
+ }
957
+ interface GoogleCloudDiscoveryengineV1AnswerReference {
958
+ /** Chunk information. */
959
+ chunkInfo?: GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo;
960
+ /** Unstructured document information. */
961
+ unstructuredDocumentInfo?: GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo;
962
+ }
963
+ interface GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfo {
964
+ /** Chunk resource name. */
965
+ chunk?: string;
966
+ /** Chunk textual content. */
967
+ content?: string;
968
+ /** Document metadata. */
969
+ documentMetadata?: GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata;
970
+ /** Relevance score. */
971
+ relevanceScore?: number;
972
+ }
973
+ interface GoogleCloudDiscoveryengineV1AnswerReferenceChunkInfoDocumentMetadata {
974
+ /** Document resource name. */
975
+ document?: string;
976
+ /** Page identifier. */
977
+ pageIdentifier?: string;
978
+ /** Title. */
979
+ title?: string;
980
+ /** URI for the document. */
981
+ uri?: string;
982
+ }
983
+ interface GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfo {
984
+ /** List of cited chunk contents derived from document content. */
985
+ chunkContents?: GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent[];
986
+ /** Document resource name. */
987
+ document?: string;
988
+ /** Title. */
989
+ title?: string;
990
+ /** URI for the document. */
991
+ uri?: string;
992
+ }
993
+ interface GoogleCloudDiscoveryengineV1AnswerReferenceUnstructuredDocumentInfoChunkContent {
994
+ /** Chunk textual content. */
995
+ content?: string;
996
+ /** Page identifier. */
997
+ pageIdentifier?: string;
998
+ }
999
+ interface GoogleCloudDiscoveryengineV1AnswerStep {
1000
+ /** Actions. */
1001
+ actions?: GoogleCloudDiscoveryengineV1AnswerStepAction[];
1002
+ /** The description of the step. */
1003
+ description?: string;
1004
+ /** The state of the step. */
1005
+ state?: string;
1006
+ /** The thought of the step. */
1007
+ thought?: string;
1008
+ }
1009
+ interface GoogleCloudDiscoveryengineV1AnswerStepAction {
1010
+ /** Observation. */
1011
+ observation?: GoogleCloudDiscoveryengineV1AnswerStepActionObservation;
1012
+ /** Search action. */
1013
+ searchAction?: GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction;
1014
+ }
1015
+ interface GoogleCloudDiscoveryengineV1AnswerStepActionObservation {
1016
+ /** Search results observed by the search action, it can be snippets info or chunk info, depending on the citation type set by the user. */
1017
+ searchResults?: GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult[];
1018
+ }
1019
+ interface GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResult {
1020
+ /** If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info. */
1021
+ chunkInfo?: GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo[];
1022
+ /** Document resource name. */
1023
+ document?: string;
1024
+ /** If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets. */
1025
+ snippetInfo?: GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo[];
1026
+ /** Title. */
1027
+ title?: string;
1028
+ /** URI for the document. */
1029
+ uri?: string;
1030
+ }
1031
+ interface GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultChunkInfo {
1032
+ /** Chunk resource name. */
1033
+ chunk?: string;
1034
+ /** Chunk textual content. */
1035
+ content?: string;
1036
+ /** Relevance score. */
1037
+ relevanceScore?: number;
1038
+ }
1039
+ interface GoogleCloudDiscoveryengineV1AnswerStepActionObservationSearchResultSnippetInfo {
1040
+ /** Snippet content. */
1041
+ snippet?: string;
1042
+ /** Status of the snippet defined by the search team. */
1043
+ snippetStatus?: string;
1044
+ }
1045
+ interface GoogleCloudDiscoveryengineV1AnswerStepActionSearchAction {
1046
+ /** The query to search. */
1047
+ query?: string;
1048
+ }
775
1049
  interface GoogleCloudDiscoveryengineV1BatchCreateTargetSiteMetadata {
776
1050
  /** Operation create time. */
777
1051
  createTime?: string;
@@ -928,7 +1202,7 @@ declare namespace gapi.client {
928
1202
  dataStoreIds?: string[];
929
1203
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
930
1204
  displayName?: string;
931
- /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine. */
1205
+ /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. */
932
1206
  industryVertical?: string;
933
1207
  /** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an INVALID_ARGUMENT error is returned. */
934
1208
  name?: string;
@@ -1190,6 +1464,40 @@ declare namespace gapi.client {
1190
1464
  /** Required. The table ID of the Cloud Bigtable that needs to be imported. */
1191
1465
  tableId?: string;
1192
1466
  }
1467
+ interface GoogleCloudDiscoveryengineV1CheckGroundingRequest {
1468
+ /** Answer candidate to check. Can have a maximum length of 1024 characters. */
1469
+ answerCandidate?: string;
1470
+ /** List of facts for the grounding check. We support up to 200 facts. */
1471
+ facts?: GoogleCloudDiscoveryengineV1GroundingFact[];
1472
+ /** Configuration of the grounding check. */
1473
+ groundingSpec?: GoogleCloudDiscoveryengineV1CheckGroundingSpec;
1474
+ /** The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */
1475
+ userLabels?: {[P in string]: string};
1476
+ }
1477
+ interface GoogleCloudDiscoveryengineV1CheckGroundingResponse {
1478
+ /** List of facts cited across all claims in the answer candidate. These are derived from the facts supplied in the request. */
1479
+ citedChunks?: GoogleCloudDiscoveryengineV1FactChunk[];
1480
+ /** Claim texts and citation info across all claims in the answer candidate. */
1481
+ claims?: GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim[];
1482
+ /** The support score for the input answer candidate. Higher the score, higher is the fraction of claims that are supported by the provided facts. This is always set when a response is returned. */
1483
+ supportScore?: number;
1484
+ }
1485
+ interface GoogleCloudDiscoveryengineV1CheckGroundingResponseClaim {
1486
+ /** A list of indices (into 'cited_chunks') specifying the citations associated with the claim. For instance [1,3,4] means that cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited supporting for the claim. A citation to a fact indicates that the claim is supported by the fact. */
1487
+ citationIndices?: number[];
1488
+ /** Text for the claim in the answer candidate. Always provided regardless of whether citations or anti-citations are found. */
1489
+ claimText?: string;
1490
+ /** Position indicating the end of the claim in the answer candidate, exclusive. */
1491
+ endPos?: number;
1492
+ /** Indicates that this claim required grounding check. When the system decided this claim doesn't require attribution/grounding check, this field will be set to false. In that case, no grounding check was done for the claim and therefore citation_indices, and anti_citation_indices should not be returned. */
1493
+ groundingCheckRequired?: boolean;
1494
+ /** Position indicating the start of the claim in the answer candidate, measured in bytes. */
1495
+ startPos?: number;
1496
+ }
1497
+ interface GoogleCloudDiscoveryengineV1CheckGroundingSpec {
1498
+ /** The threshold (in [0,1]) used for determining whether a fact must be cited for a claim in the answer candidate. Choosing a higher threshold will lead to fewer but very strong citations, while choosing a lower threshold may lead to more but somewhat weaker citations. If unset, the threshold will default to 0.6. */
1499
+ citationThreshold?: number;
1500
+ }
1193
1501
  interface GoogleCloudDiscoveryengineV1CloudSqlSource {
1194
1502
  /** Required. The Cloud SQL database to copy the data from with a length limit of 256 characters. */
1195
1503
  databaseId?: string;
@@ -1399,7 +1707,7 @@ declare namespace gapi.client {
1399
1707
  name?: string;
1400
1708
  /** The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. */
1401
1709
  promotionIds?: string[];
1402
- /** Quantity of the Document associated with the user event. Defaults to 1. For example, this field will be 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase` */
1710
+ /** Quantity of the Document associated with the user event. Defaults to 1. For example, this field is 2 if two quantities of the same Document are involved in a `add-to-cart` event. Required for events of the following event types: * `add-to-cart` * `purchase` */
1403
1711
  quantity?: number;
1404
1712
  /** The Document URI - only allowed for website data stores. */
1405
1713
  uri?: string;
@@ -1448,7 +1756,7 @@ declare namespace gapi.client {
1448
1756
  dataStoreIds?: string[];
1449
1757
  /** Required. The display name of the engine. Should be human readable. UTF-8 encoded string with limit of 1024 characters. */
1450
1758
  displayName?: string;
1451
- /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore liniked to the engine. */
1759
+ /** The industry vertical that the engine registers. The restriction of the Engine industry vertical is based on DataStore: If unspecified, default to `GENERIC`. Vertical on Engine has to match vertical of the DataStore linked to the engine. */
1452
1760
  industryVertical?: string;
1453
1761
  /** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an INVALID_ARGUMENT error is returned. */
1454
1762
  name?: string;
@@ -1489,6 +1797,16 @@ declare namespace gapi.client {
1489
1797
  /** The search feature tier of this engine. Different tiers might have different pricing. To learn more, check the pricing documentation. Defaults to SearchTier.SEARCH_TIER_STANDARD if not specified. */
1490
1798
  searchTier?: string;
1491
1799
  }
1800
+ interface GoogleCloudDiscoveryengineV1FactChunk {
1801
+ /** Text content of the fact chunk. Can be at most 10K characters long. */
1802
+ chunkText?: string;
1803
+ /** The index of this chunk. Currently, only used for the streaming mode. */
1804
+ index?: number;
1805
+ /** Source from which this fact chunk was retrieved. If it was retrieved from the GroundingFacts provided in the request then this field will contain the index of the specific fact from which this chunk was retrieved. */
1806
+ source?: string;
1807
+ /** More fine-grained information for the source reference. */
1808
+ sourceMetadata?: {[P in string]: string};
1809
+ }
1492
1810
  interface GoogleCloudDiscoveryengineV1FetchDomainVerificationStatusResponse {
1493
1811
  /** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
1494
1812
  nextPageToken?: string;
@@ -1504,7 +1822,7 @@ declare namespace gapi.client {
1504
1822
  gcsStagingDir?: string;
1505
1823
  }
1506
1824
  interface GoogleCloudDiscoveryengineV1FirestoreSource {
1507
- /** Required. The Firestore collection to copy the data from with a length limit of 1,500 characters. */
1825
+ /** Required. The Firestore collection (or entity) to copy the data from with a length limit of 1,500 characters. */
1508
1826
  collectionId?: string;
1509
1827
  /** Required. The Firestore database to copy the data from with a length limit of 256 characters. */
1510
1828
  databaseId?: string;
@@ -1514,11 +1832,17 @@ declare namespace gapi.client {
1514
1832
  projectId?: string;
1515
1833
  }
1516
1834
  interface GoogleCloudDiscoveryengineV1GcsSource {
1517
- /** The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user even imports: * `user_event` (default): One JSON UserEvent per line. */
1835
+ /** The schema to use when parsing the data from the source. Supported values for document imports: * `document` (default): One JSON Document per line. Each document must have a valid Document.id. * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by `input_uris` becomes a document, with the ID set to the first 128 bits of SHA256(URI) encoded as a hex string. * `custom`: One custom data JSON per row in arbitrary format that conforms to the defined Schema of the data store. This can only be used by the GENERIC Data Store vertical. * `csv`: A CSV file with header conforming to the defined Schema of the data store. Each entry after the header is imported as a Document. This can only be used by the GENERIC Data Store vertical. Supported values for user event imports: * `user_event` (default): One JSON UserEvent per line. */
1518
1836
  dataSchema?: string;
1519
- /** Required. Cloud Storage URIs to input files. URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). */
1837
+ /** Required. Cloud Storage URIs to input files. Each URI can be up to 2000 characters long. URIs can match the full object path (for example, `gs://bucket/directory/object.json`) or a pattern matching one or more files, such as `gs://bucket/directory/*.json`. A request can contain at most 100 files (or 100,000 files if `data_schema` is `content`). Each file can be up to 2 GB (or 100 MB if `data_schema` is `content`). */
1520
1838
  inputUris?: string[];
1521
1839
  }
1840
+ interface GoogleCloudDiscoveryengineV1GroundingFact {
1841
+ /** Attributes associated with the fact. Common attributes include `source` (indicating where the fact was sourced from), `author` (indicating the author of the fact), and so on. */
1842
+ attributes?: {[P in string]: string};
1843
+ /** Text content of the fact. Can be at most 10K characters long. */
1844
+ factText?: string;
1845
+ }
1522
1846
  interface GoogleCloudDiscoveryengineV1ImportDocumentsMetadata {
1523
1847
  /** Operation create time. */
1524
1848
  createTime?: string;
@@ -1671,6 +1995,12 @@ declare namespace gapi.client {
1671
1995
  /** The Schemas. */
1672
1996
  schemas?: GoogleCloudDiscoveryengineV1Schema[];
1673
1997
  }
1998
+ interface GoogleCloudDiscoveryengineV1ListSessionsResponse {
1999
+ /** Pagination token, if not returned indicates the last page. */
2000
+ nextPageToken?: string;
2001
+ /** All the Sessions for a given data store. */
2002
+ sessions?: GoogleCloudDiscoveryengineV1Session[];
2003
+ }
1674
2004
  interface GoogleCloudDiscoveryengineV1ListTargetSitesResponse {
1675
2005
  /** A token that can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages. */
1676
2006
  nextPageToken?: string;
@@ -1742,18 +2072,50 @@ declare namespace gapi.client {
1742
2072
  /** Number of suggestion deny list entries purged. */
1743
2073
  purgeCount?: string;
1744
2074
  }
2075
+ interface GoogleCloudDiscoveryengineV1Query {
2076
+ /** Unique Id for the query. */
2077
+ queryId?: string;
2078
+ /** Plain text. */
2079
+ text?: string;
2080
+ }
2081
+ interface GoogleCloudDiscoveryengineV1RankingRecord {
2082
+ /** The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. */
2083
+ content?: string;
2084
+ /** The unique ID to represent the record. */
2085
+ id?: string;
2086
+ /** The score of this record based on the given query and selected model. */
2087
+ score?: number;
2088
+ /** The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown. */
2089
+ title?: string;
2090
+ }
2091
+ interface GoogleCloudDiscoveryengineV1RankRequest {
2092
+ /** If true, the response will contain only record ID and score. By default, it is false, the response will contain record details. */
2093
+ ignoreRecordDetailsInResponse?: boolean;
2094
+ /** The identifier of the model to use. It is one of: * `semantic-ranker-512@latest`: Semantic ranking model with maxiumn input token size 512. It is set to `semantic-ranker-512@latest` by default if unspecified. */
2095
+ model?: string;
2096
+ /** The query to use. */
2097
+ query?: string;
2098
+ /** Required. A list of records to rank. At most 200 records to rank. */
2099
+ records?: GoogleCloudDiscoveryengineV1RankingRecord[];
2100
+ /** The number of results to return. If this is unset or no bigger than zero, returns all results. */
2101
+ topN?: number;
2102
+ }
2103
+ interface GoogleCloudDiscoveryengineV1RankResponse {
2104
+ /** A list of records sorted by descending score. */
2105
+ records?: GoogleCloudDiscoveryengineV1RankingRecord[];
2106
+ }
1745
2107
  interface GoogleCloudDiscoveryengineV1RecommendRequest {
1746
- /** Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API will return generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to True in RecommendRequest.params to receive empty results instead. Note that the API will never return Documents with `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices. */
2108
+ /** Filter for restricting recommendation results with a length limit of 5,000 characters. Currently, only filter expressions on the `filter_tags` attribute is supported. Examples: * `(filter_tags: ANY("Red", "Blue") OR filter_tags: ANY("Hot", "Cold"))` * `(filter_tags: ANY("Red", "Blue")) AND NOT (filter_tags: ANY("Green"))` If `attributeFilteringSyntax` is set to true under the `params` field, then attribute-based expressions are expected instead of the above described tag-based syntax. Examples: * (launguage: ANY("en", "es")) AND NOT (categories: ANY("Movie")) * (available: true) AND (launguage: ANY("en", "es")) OR (categories: ANY("Movie")) If your filter blocks all results, the API returns generic (unfiltered) popular Documents. If you only want results strictly matching the filters, set `strictFiltering` to `true` in RecommendRequest.params to receive empty results instead. Note that the API never returns Documents with `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices. */
1747
2109
  filter?: string;
1748
- /** Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service will choose a reasonable default. The maximum allowed value is 100. Values above 100 will be coerced to 100. */
2110
+ /** Maximum number of results to return. Set this property to the number of recommendation results needed. If zero, the service chooses a reasonable default. The maximum allowed value is 100. Values above 100 are set to 100. */
1749
2111
  pageSize?: number;
1750
- /** Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to true, the associated Document object will be returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation 'score' corresponding to each returned Document will be set in RecommendResponse.RecommendationResult.metadata. The given 'score' indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to false, the service will return generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax. */
2112
+ /** Additional domain specific parameters for the recommendations. Allowed values: * `returnDocument`: Boolean. If set to `true`, the associated Document object is returned in RecommendResponse.RecommendationResult.document. * `returnScore`: Boolean. If set to true, the recommendation score corresponding to each returned Document is set in RecommendResponse.RecommendationResult.metadata. The given score indicates the probability of a Document conversion given the user's context and history. * `strictFiltering`: Boolean. True by default. If set to `false`, the service returns generic (unfiltered) popular Documents instead of empty if your filter blocks all recommendation results. * `diversityLevel`: String. Default empty. If set to be non-empty, then it needs to be one of: * `no-diversity` * `low-diversity` * `medium-diversity` * `high-diversity` * `auto-diversity` This gives request-level control and adjusts recommendation results based on Document category. * `attributeFilteringSyntax`: Boolean. False by default. If set to true, the `filter` field is interpreted according to the new, attribute-based syntax. */
1751
2113
  params?: {[P in string]: any};
1752
2114
  /** Required. Context about the user, what they are looking at and what action they took to trigger the Recommend request. Note that this user event detail won't be ingested to userEvent logs. Thus, a separate userEvent write request is required for event logging. Don't set UserEvent.user_pseudo_id or UserEvent.user_info.user_id to the same fixed ID for different users. If you are trying to receive non-personalized recommendations (not recommended; this can negatively impact model performance), instead set UserEvent.user_pseudo_id to a random unique ID and leave UserEvent.user_info.user_id unset. */
1753
2115
  userEvent?: GoogleCloudDiscoveryengineV1UserEvent;
1754
2116
  /** The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Requirements for labels](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details. */
1755
2117
  userLabels?: {[P in string]: string};
1756
- /** Use validate only mode for this recommendation query. If set to true, a fake model will be used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready. */
2118
+ /** Use validate only mode for this recommendation query. If set to `true`, a fake model is used that returns arbitrary Document IDs. Note that the validate only mode should only be used for testing the API, or if the model is not ready. */
1757
2119
  validateOnly?: boolean;
1758
2120
  }
1759
2121
  interface GoogleCloudDiscoveryengineV1RecommendResponse {
@@ -1771,7 +2133,7 @@ declare namespace gapi.client {
1771
2133
  document?: GoogleCloudDiscoveryengineV1Document;
1772
2134
  /** Resource ID of the recommended Document. */
1773
2135
  id?: string;
1774
- /** Additional Document metadata / annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params. */
2136
+ /** Additional Document metadata or annotations. Possible values: * `score`: Recommendation score in double value. Is set if `returnScore` is set to true in RecommendRequest.params. */
1775
2137
  metadata?: {[P in string]: any};
1776
2138
  }
1777
2139
  interface GoogleCloudDiscoveryengineV1RecrawlUrisRequest {
@@ -1799,7 +2161,7 @@ declare namespace gapi.client {
1799
2161
  searchQuery?: string;
1800
2162
  }
1801
2163
  interface GoogleCloudDiscoveryengineV1SearchRequest {
1802
- /** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost) */
2164
+ /** Boost specification to boost certain documents. For more information on boosting, see [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results) */
1803
2165
  boostSpec?: GoogleCloudDiscoveryengineV1SearchRequestBoostSpec;
1804
2166
  /** The branch resource name, such as `projects/*‍/locations/global/collections/default_collection/dataStores/default_data_store/branches/0`. Use `default_branch` as the branch ID or leave this field empty, to search documents under the default branch. */
1805
2167
  branch?: string;
@@ -1807,7 +2169,7 @@ declare namespace gapi.client {
1807
2169
  canonicalFilter?: string;
1808
2170
  /** A specification for configuring the behavior of content search. */
1809
2171
  contentSearchSpec?: GoogleCloudDiscoveryengineV1SearchRequestContentSearchSpec;
1810
- /** A list of data store specs to apply on a search call. */
2172
+ /** Specs defining dataStores to filter on in a search call and configurations for those dataStores. This is only considered for engines with multiple dataStores use case. For single dataStore within an engine, they should use the specs at the top level. */
1811
2173
  dataStoreSpecs?: GoogleCloudDiscoveryengineV1SearchRequestDataStoreSpec[];
1812
2174
  /** Facet specifications for faceted search. If empty, no facets are returned. A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT` error is returned. */
1813
2175
  facetSpecs?: GoogleCloudDiscoveryengineV1SearchRequestFacetSpec[];
@@ -1823,7 +2185,7 @@ declare namespace gapi.client {
1823
2185
  pageSize?: number;
1824
2186
  /** A page token received from a previous SearchService.Search call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SearchService.Search must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
1825
2187
  pageToken?: string;
1826
- /** Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. Example: user_country_code: "au" For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. Example: search_type: 1 */
2188
+ /** Additional search parameters. For public website search only, supported values are: * `user_country_code`: string. Default empty. If set to non-empty, results are restricted or boosted based on the location provided. For example, `user_country_code: "au"` For available codes see [Country Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes) * `search_type`: double. Default empty. Enables non-webpage searching depending on the value. The only valid non-default value is 1, which enables image searching. For example, `search_type: 1` */
1827
2189
  params?: {[P in string]: any};
1828
2190
  /** Raw search query. */
1829
2191
  query?: string;
@@ -1915,13 +2277,13 @@ declare namespace gapi.client {
1915
2277
  excludedFilterKeys?: string[];
1916
2278
  /** Required. The facet key specification. */
1917
2279
  facetKey?: GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey;
1918
- /** Maximum of facet values that should be returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned. */
2280
+ /** Maximum facet values that are returned for this facet. If unspecified, defaults to 20. The maximum allowed value is 300. Values above 300 are coerced to 300. If this field is negative, an `INVALID_ARGUMENT` is returned. */
1919
2281
  limit?: number;
1920
2282
  }
1921
2283
  interface GoogleCloudDiscoveryengineV1SearchRequestFacetSpecFacetKey {
1922
2284
  /** True to make facet keys case insensitive when getting faceting values with prefixes or contains; false otherwise. */
1923
2285
  caseInsensitive?: boolean;
1924
- /** Only get facet values that contains the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10. */
2286
+ /** Only get facet values that contain the given strings. For example, suppose "category" has three values "Action > 2022", "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the "category" facet only contains "Action > 2022" and "Sci-Fi > 2022". Only supported on textual fields. Maximum is 10. */
1925
2287
  contains?: string[];
1926
2288
  /** Set only if values should be bucketed into intervals. Must be set for facets with numerical values. Must not be set for facet with text values. Maximum number of intervals is 30. */
1927
2289
  intervals?: GoogleCloudDiscoveryengineV1Interval[];
@@ -1945,7 +2307,7 @@ declare namespace gapi.client {
1945
2307
  pinUnexpandedResults?: boolean;
1946
2308
  }
1947
2309
  interface GoogleCloudDiscoveryengineV1SearchRequestSpellCorrectionSpec {
1948
- /** The mode under which spell correction should take effect to replace the original search query. Default to Mode.AUTO. */
2310
+ /** The mode under which spell correction replaces the original search query. Defaults to Mode.AUTO. */
1949
2311
  mode?: string;
1950
2312
  }
1951
2313
  interface GoogleCloudDiscoveryengineV1SearchResponse {
@@ -1971,7 +2333,7 @@ declare namespace gapi.client {
1971
2333
  interface GoogleCloudDiscoveryengineV1SearchResponseFacet {
1972
2334
  /** Whether the facet is dynamically generated. */
1973
2335
  dynamicFacet?: boolean;
1974
- /** The key for this facet. E.g., "colors" or "price". It matches SearchRequest.FacetSpec.FacetKey.key. */
2336
+ /** The key for this facet. For example, `"colors"` or `"price"`. It matches SearchRequest.FacetSpec.FacetKey.key. */
1975
2337
  key?: string;
1976
2338
  /** The facet values for this field. */
1977
2339
  values?: GoogleCloudDiscoveryengineV1SearchResponseFacetFacetValue[];
@@ -1991,7 +2353,7 @@ declare namespace gapi.client {
1991
2353
  pinnedResultCount?: string;
1992
2354
  }
1993
2355
  interface GoogleCloudDiscoveryengineV1SearchResponseSearchResult {
1994
- /** The document data snippet in the search response. Only fields that are marked as retrievable are populated. */
2356
+ /** The document data snippet in the search response. Only fields that are marked as `retrievable` are populated. */
1995
2357
  document?: GoogleCloudDiscoveryengineV1Document;
1996
2358
  /** Document.id of the searched Document. */
1997
2359
  id?: string;
@@ -2052,6 +2414,26 @@ declare namespace gapi.client {
2052
2414
  /** Summary text with no citation information. */
2053
2415
  summary?: string;
2054
2416
  }
2417
+ interface GoogleCloudDiscoveryengineV1Session {
2418
+ /** Output only. The time the session finished. */
2419
+ endTime?: string;
2420
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
2421
+ name?: string;
2422
+ /** Output only. The time the session started. */
2423
+ startTime?: string;
2424
+ /** The state of the session. */
2425
+ state?: string;
2426
+ /** Turns. */
2427
+ turns?: GoogleCloudDiscoveryengineV1SessionTurn[];
2428
+ /** A unique identifier for tracking users. */
2429
+ userPseudoId?: string;
2430
+ }
2431
+ interface GoogleCloudDiscoveryengineV1SessionTurn {
2432
+ /** The resource name of the answer to the user query. Only set if the answer generation (/answer API call) happened in this turn. */
2433
+ answer?: string;
2434
+ /** The user query. */
2435
+ query?: GoogleCloudDiscoveryengineV1Query;
2436
+ }
2055
2437
  interface GoogleCloudDiscoveryengineV1SiteSearchEngine {
2056
2438
  /** The fully qualified resource name of the site search engine. Format: `projects/*‍/locations/*‍/dataStores/*‍/siteSearchEngine` */
2057
2439
  name?: string;
@@ -2171,7 +2553,7 @@ declare namespace gapi.client {
2171
2553
  searchInfo?: GoogleCloudDiscoveryengineV1SearchInfo;
2172
2554
  /** A unique identifier for tracking a visitor session with a length limit of 128 bytes. A session is an aggregation of an end user behavior in a time span. A general guideline to populate the session_id: 1. If user has no activity for 30 min, a new session_id should be assigned. 2. The session_id should be unique across users, suggest use uuid or add UserEvent.user_pseudo_id as prefix. */
2173
2555
  sessionId?: string;
2174
- /** A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups on the customer end. */
2556
+ /** A list of identifiers for the independent experiment groups this user event belongs to. This is used to distinguish between user events associated with different experiment setups. */
2175
2557
  tagIds?: string[];
2176
2558
  /** The transaction metadata (if any) associated with this user event. */
2177
2559
  transactionInfo?: GoogleCloudDiscoveryengineV1TransactionInfo;
@@ -2186,6 +2568,7 @@ declare namespace gapi.client {
2186
2568
  /** Highly recommended for logged-in users. Unique identifier for logged-in user, such as a user name. Don't set for anonymous users. Always use a hashed value for this ID. Don't set the field to the same fixed ID for different users. This mixes the event history of those users together, which results in degraded model quality. The field must be a UTF-8 encoded string with a length limit of 128 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2187
2569
  userId?: string;
2188
2570
  }
2571
+ interface GoogleLongrunningCancelOperationRequest {}
2189
2572
  interface GoogleLongrunningListOperationsResponse {
2190
2573
  /** The standard List next-page token. */
2191
2574
  nextPageToken?: string;
@@ -2297,7 +2680,7 @@ declare namespace gapi.client {
2297
2680
  alt?: string;
2298
2681
  /** JSONP */
2299
2682
  callback?: string;
2300
- /** Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2683
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2301
2684
  documentId?: string;
2302
2685
  /** Selector specifying which fields to include in a partial response. */
2303
2686
  fields?: string;
@@ -2328,7 +2711,7 @@ declare namespace gapi.client {
2328
2711
  alt?: string;
2329
2712
  /** JSONP */
2330
2713
  callback?: string;
2331
- /** Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2714
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2332
2715
  documentId?: string;
2333
2716
  /** Selector specifying which fields to include in a partial response. */
2334
2717
  fields?: string;
@@ -2403,7 +2786,7 @@ declare namespace gapi.client {
2403
2786
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
2404
2787
  uploadType?: string;
2405
2788
  }): Request<GoogleCloudDiscoveryengineV1Document>;
2406
- /** Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated. */
2789
+ /** Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. */
2407
2790
  import(request: {
2408
2791
  /** V1 error format. */
2409
2792
  '$.xgafv'?: string;
@@ -2477,7 +2860,7 @@ declare namespace gapi.client {
2477
2860
  key?: string;
2478
2861
  /** OAuth 2.0 token for the current user. */
2479
2862
  oauth_token?: string;
2480
- /** Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
2863
+ /** Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
2481
2864
  pageSize?: number;
2482
2865
  /** A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
2483
2866
  pageToken?: string;
@@ -2498,7 +2881,7 @@ declare namespace gapi.client {
2498
2881
  '$.xgafv'?: string;
2499
2882
  /** OAuth access token. */
2500
2883
  access_token?: string;
2501
- /** If set to true, and the Document is not found, a new Document will be created. */
2884
+ /** If set to `true` and the Document is not found, a new Document is be created. */
2502
2885
  allowMissing?: boolean;
2503
2886
  /** Data format for response. */
2504
2887
  alt?: string;
@@ -2516,7 +2899,7 @@ declare namespace gapi.client {
2516
2899
  prettyPrint?: boolean;
2517
2900
  /** 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. */
2518
2901
  quotaUser?: string;
2519
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
2902
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
2520
2903
  updateMask?: string;
2521
2904
  /** Upload protocol for media (e.g. "raw", "multipart"). */
2522
2905
  upload_protocol?: string;
@@ -2531,7 +2914,7 @@ declare namespace gapi.client {
2531
2914
  '$.xgafv'?: string;
2532
2915
  /** OAuth access token. */
2533
2916
  access_token?: string;
2534
- /** If set to true, and the Document is not found, a new Document will be created. */
2917
+ /** If set to `true` and the Document is not found, a new Document is be created. */
2535
2918
  allowMissing?: boolean;
2536
2919
  /** Data format for response. */
2537
2920
  alt?: string;
@@ -2549,7 +2932,7 @@ declare namespace gapi.client {
2549
2932
  prettyPrint?: boolean;
2550
2933
  /** 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. */
2551
2934
  quotaUser?: string;
2552
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
2935
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
2553
2936
  updateMask?: string;
2554
2937
  /** Upload protocol for media (e.g. "raw", "multipart"). */
2555
2938
  upload_protocol?: string;
@@ -2618,6 +3001,64 @@ declare namespace gapi.client {
2618
3001
  ): Request<GoogleLongrunningOperation>;
2619
3002
  }
2620
3003
  interface OperationsResource {
3004
+ /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */
3005
+ cancel(request: {
3006
+ /** V1 error format. */
3007
+ '$.xgafv'?: string;
3008
+ /** OAuth access token. */
3009
+ access_token?: string;
3010
+ /** Data format for response. */
3011
+ alt?: string;
3012
+ /** JSONP */
3013
+ callback?: string;
3014
+ /** Selector specifying which fields to include in a partial response. */
3015
+ fields?: string;
3016
+ /** 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. */
3017
+ key?: string;
3018
+ /** The name of the operation resource to be cancelled. */
3019
+ name: string;
3020
+ /** OAuth 2.0 token for the current user. */
3021
+ oauth_token?: string;
3022
+ /** Returns response with indentations and line breaks. */
3023
+ prettyPrint?: boolean;
3024
+ /** 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. */
3025
+ quotaUser?: string;
3026
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3027
+ upload_protocol?: string;
3028
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3029
+ uploadType?: string;
3030
+ /** Request body */
3031
+ resource: GoogleLongrunningCancelOperationRequest;
3032
+ }): Request<{}>;
3033
+ cancel(
3034
+ request: {
3035
+ /** V1 error format. */
3036
+ '$.xgafv'?: string;
3037
+ /** OAuth access token. */
3038
+ access_token?: string;
3039
+ /** Data format for response. */
3040
+ alt?: string;
3041
+ /** JSONP */
3042
+ callback?: string;
3043
+ /** Selector specifying which fields to include in a partial response. */
3044
+ fields?: string;
3045
+ /** 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. */
3046
+ key?: string;
3047
+ /** The name of the operation resource to be cancelled. */
3048
+ name: string;
3049
+ /** OAuth 2.0 token for the current user. */
3050
+ oauth_token?: string;
3051
+ /** Returns response with indentations and line breaks. */
3052
+ prettyPrint?: boolean;
3053
+ /** 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. */
3054
+ quotaUser?: string;
3055
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3056
+ upload_protocol?: string;
3057
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3058
+ uploadType?: string;
3059
+ },
3060
+ body: GoogleLongrunningCancelOperationRequest
3061
+ ): Request<{}>;
2621
3062
  /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
2622
3063
  get(request?: {
2623
3064
  /** V1 error format. */
@@ -3164,7 +3605,7 @@ declare namespace gapi.client {
3164
3605
  prettyPrint?: boolean;
3165
3606
  /** 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. */
3166
3607
  quotaUser?: string;
3167
- /** Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
3608
+ /** Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
3168
3609
  schemaId?: string;
3169
3610
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3170
3611
  upload_protocol?: string;
@@ -3195,7 +3636,7 @@ declare namespace gapi.client {
3195
3636
  prettyPrint?: boolean;
3196
3637
  /** 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. */
3197
3638
  quotaUser?: string;
3198
- /** Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
3639
+ /** Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
3199
3640
  schemaId?: string;
3200
3641
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3201
3642
  upload_protocol?: string;
@@ -3274,7 +3715,7 @@ declare namespace gapi.client {
3274
3715
  key?: string;
3275
3716
  /** OAuth 2.0 token for the current user. */
3276
3717
  oauth_token?: string;
3277
- /** The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */
3718
+ /** The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. */
3278
3719
  pageSize?: number;
3279
3720
  /** A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. */
3280
3721
  pageToken?: string;
@@ -3295,7 +3736,7 @@ declare namespace gapi.client {
3295
3736
  '$.xgafv'?: string;
3296
3737
  /** OAuth access token. */
3297
3738
  access_token?: string;
3298
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
3739
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
3299
3740
  allowMissing?: boolean;
3300
3741
  /** Data format for response. */
3301
3742
  alt?: string;
@@ -3326,7 +3767,7 @@ declare namespace gapi.client {
3326
3767
  '$.xgafv'?: string;
3327
3768
  /** OAuth access token. */
3328
3769
  access_token?: string;
3329
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
3770
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
3330
3771
  allowMissing?: boolean;
3331
3772
  /** Data format for response. */
3332
3773
  alt?: string;
@@ -3354,8 +3795,8 @@ declare namespace gapi.client {
3354
3795
  operations: OperationsResource;
3355
3796
  }
3356
3797
  interface ServingConfigsResource {
3357
- /** Makes a recommendation, which requires a contextual user event. */
3358
- recommend(request: {
3798
+ /** Answer query method. */
3799
+ answer(request: {
3359
3800
  /** V1 error format. */
3360
3801
  '$.xgafv'?: string;
3361
3802
  /** OAuth access token. */
@@ -3374,16 +3815,16 @@ declare namespace gapi.client {
3374
3815
  prettyPrint?: boolean;
3375
3816
  /** 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. */
3376
3817
  quotaUser?: string;
3377
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
3818
+ /** 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/*‍/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
3378
3819
  servingConfig: string;
3379
3820
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3380
3821
  upload_protocol?: string;
3381
3822
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3382
3823
  uploadType?: string;
3383
3824
  /** Request body */
3384
- resource: GoogleCloudDiscoveryengineV1RecommendRequest;
3385
- }): Request<GoogleCloudDiscoveryengineV1RecommendResponse>;
3386
- recommend(
3825
+ resource: GoogleCloudDiscoveryengineV1AnswerQueryRequest;
3826
+ }): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
3827
+ answer(
3387
3828
  request: {
3388
3829
  /** V1 error format. */
3389
3830
  '$.xgafv'?: string;
@@ -3403,17 +3844,17 @@ declare namespace gapi.client {
3403
3844
  prettyPrint?: boolean;
3404
3845
  /** 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. */
3405
3846
  quotaUser?: string;
3406
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
3847
+ /** 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/*‍/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
3407
3848
  servingConfig: string;
3408
3849
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3409
3850
  upload_protocol?: string;
3410
3851
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3411
3852
  uploadType?: string;
3412
3853
  },
3413
- body: GoogleCloudDiscoveryengineV1RecommendRequest
3414
- ): Request<GoogleCloudDiscoveryengineV1RecommendResponse>;
3415
- /** Performs a search. */
3416
- search(request: {
3854
+ body: GoogleCloudDiscoveryengineV1AnswerQueryRequest
3855
+ ): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
3856
+ /** Makes a recommendation, which requires a contextual user event. */
3857
+ recommend(request: {
3417
3858
  /** V1 error format. */
3418
3859
  '$.xgafv'?: string;
3419
3860
  /** OAuth access token. */
@@ -3432,18 +3873,76 @@ declare namespace gapi.client {
3432
3873
  prettyPrint?: boolean;
3433
3874
  /** 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. */
3434
3875
  quotaUser?: string;
3435
- /** 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. */
3876
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
3436
3877
  servingConfig: string;
3437
3878
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3438
3879
  upload_protocol?: string;
3439
3880
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3440
3881
  uploadType?: string;
3441
3882
  /** Request body */
3442
- resource: GoogleCloudDiscoveryengineV1SearchRequest;
3443
- }): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
3444
- search(
3445
- request: {
3446
- /** V1 error format. */
3883
+ resource: GoogleCloudDiscoveryengineV1RecommendRequest;
3884
+ }): Request<GoogleCloudDiscoveryengineV1RecommendResponse>;
3885
+ recommend(
3886
+ request: {
3887
+ /** V1 error format. */
3888
+ '$.xgafv'?: string;
3889
+ /** OAuth access token. */
3890
+ access_token?: string;
3891
+ /** Data format for response. */
3892
+ alt?: string;
3893
+ /** JSONP */
3894
+ callback?: string;
3895
+ /** Selector specifying which fields to include in a partial response. */
3896
+ fields?: string;
3897
+ /** 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. */
3898
+ key?: string;
3899
+ /** OAuth 2.0 token for the current user. */
3900
+ oauth_token?: string;
3901
+ /** Returns response with indentations and line breaks. */
3902
+ prettyPrint?: boolean;
3903
+ /** 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. */
3904
+ quotaUser?: string;
3905
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
3906
+ servingConfig: string;
3907
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3908
+ upload_protocol?: string;
3909
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3910
+ uploadType?: string;
3911
+ },
3912
+ body: GoogleCloudDiscoveryengineV1RecommendRequest
3913
+ ): Request<GoogleCloudDiscoveryengineV1RecommendResponse>;
3914
+ /** Performs a search. */
3915
+ search(request: {
3916
+ /** V1 error format. */
3917
+ '$.xgafv'?: string;
3918
+ /** OAuth access token. */
3919
+ access_token?: string;
3920
+ /** Data format for response. */
3921
+ alt?: string;
3922
+ /** JSONP */
3923
+ callback?: string;
3924
+ /** Selector specifying which fields to include in a partial response. */
3925
+ fields?: string;
3926
+ /** 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. */
3927
+ key?: string;
3928
+ /** OAuth 2.0 token for the current user. */
3929
+ oauth_token?: string;
3930
+ /** Returns response with indentations and line breaks. */
3931
+ prettyPrint?: boolean;
3932
+ /** 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. */
3933
+ quotaUser?: string;
3934
+ /** 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. */
3935
+ servingConfig: string;
3936
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
3937
+ upload_protocol?: string;
3938
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3939
+ uploadType?: string;
3940
+ /** Request body */
3941
+ resource: GoogleCloudDiscoveryengineV1SearchRequest;
3942
+ }): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
3943
+ search(
3944
+ request: {
3945
+ /** V1 error format. */
3447
3946
  '$.xgafv'?: string;
3448
3947
  /** OAuth access token. */
3449
3948
  access_token?: string;
@@ -3471,8 +3970,8 @@ declare namespace gapi.client {
3471
3970
  body: GoogleCloudDiscoveryengineV1SearchRequest
3472
3971
  ): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
3473
3972
  }
3474
- interface OperationsResource {
3475
- /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
3973
+ interface AnswersResource {
3974
+ /** Gets a Answer. */
3476
3975
  get(request?: {
3477
3976
  /** V1 error format. */
3478
3977
  '$.xgafv'?: string;
@@ -3486,7 +3985,7 @@ declare namespace gapi.client {
3486
3985
  fields?: string;
3487
3986
  /** 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. */
3488
3987
  key?: string;
3489
- /** The name of the operation resource. */
3988
+ /** Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` */
3490
3989
  name: string;
3491
3990
  /** OAuth 2.0 token for the current user. */
3492
3991
  oauth_token?: string;
@@ -3498,9 +3997,11 @@ declare namespace gapi.client {
3498
3997
  upload_protocol?: string;
3499
3998
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3500
3999
  uploadType?: string;
3501
- }): Request<GoogleLongrunningOperation>;
3502
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
3503
- list(request?: {
4000
+ }): Request<GoogleCloudDiscoveryengineV1Answer>;
4001
+ }
4002
+ interface SessionsResource {
4003
+ /** Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. */
4004
+ create(request: {
3504
4005
  /** V1 error format. */
3505
4006
  '$.xgafv'?: string;
3506
4007
  /** OAuth access token. */
@@ -3511,18 +4012,70 @@ declare namespace gapi.client {
3511
4012
  callback?: string;
3512
4013
  /** Selector specifying which fields to include in a partial response. */
3513
4014
  fields?: string;
3514
- /** The standard list filter. */
3515
- filter?: string;
3516
4015
  /** 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. */
3517
4016
  key?: string;
3518
- /** The name of the operation's parent resource. */
4017
+ /** OAuth 2.0 token for the current user. */
4018
+ oauth_token?: string;
4019
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
4020
+ parent: string;
4021
+ /** Returns response with indentations and line breaks. */
4022
+ prettyPrint?: boolean;
4023
+ /** 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. */
4024
+ quotaUser?: string;
4025
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4026
+ upload_protocol?: string;
4027
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4028
+ uploadType?: string;
4029
+ /** Request body */
4030
+ resource: GoogleCloudDiscoveryengineV1Session;
4031
+ }): Request<GoogleCloudDiscoveryengineV1Session>;
4032
+ create(
4033
+ request: {
4034
+ /** V1 error format. */
4035
+ '$.xgafv'?: string;
4036
+ /** OAuth access token. */
4037
+ access_token?: string;
4038
+ /** Data format for response. */
4039
+ alt?: string;
4040
+ /** JSONP */
4041
+ callback?: string;
4042
+ /** Selector specifying which fields to include in a partial response. */
4043
+ fields?: string;
4044
+ /** 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. */
4045
+ key?: string;
4046
+ /** OAuth 2.0 token for the current user. */
4047
+ oauth_token?: string;
4048
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
4049
+ parent: string;
4050
+ /** Returns response with indentations and line breaks. */
4051
+ prettyPrint?: boolean;
4052
+ /** 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. */
4053
+ quotaUser?: string;
4054
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4055
+ upload_protocol?: string;
4056
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4057
+ uploadType?: string;
4058
+ },
4059
+ body: GoogleCloudDiscoveryengineV1Session
4060
+ ): Request<GoogleCloudDiscoveryengineV1Session>;
4061
+ /** Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. */
4062
+ delete(request?: {
4063
+ /** V1 error format. */
4064
+ '$.xgafv'?: string;
4065
+ /** OAuth access token. */
4066
+ access_token?: string;
4067
+ /** Data format for response. */
4068
+ alt?: string;
4069
+ /** JSONP */
4070
+ callback?: string;
4071
+ /** Selector specifying which fields to include in a partial response. */
4072
+ fields?: string;
4073
+ /** 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. */
4074
+ key?: string;
4075
+ /** Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
3519
4076
  name: string;
3520
4077
  /** OAuth 2.0 token for the current user. */
3521
4078
  oauth_token?: string;
3522
- /** The standard list page size. */
3523
- pageSize?: number;
3524
- /** The standard list page token. */
3525
- pageToken?: string;
3526
4079
  /** Returns response with indentations and line breaks. */
3527
4080
  prettyPrint?: boolean;
3528
4081
  /** 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. */
@@ -3531,10 +4084,8 @@ declare namespace gapi.client {
3531
4084
  upload_protocol?: string;
3532
4085
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3533
4086
  uploadType?: string;
3534
- }): Request<GoogleLongrunningListOperationsResponse>;
3535
- }
3536
- interface OperationsResource {
3537
- /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
4087
+ }): Request<{}>;
4088
+ /** Gets a Session. */
3538
4089
  get(request?: {
3539
4090
  /** V1 error format. */
3540
4091
  '$.xgafv'?: string;
@@ -3548,7 +4099,7 @@ declare namespace gapi.client {
3548
4099
  fields?: string;
3549
4100
  /** 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. */
3550
4101
  key?: string;
3551
- /** The name of the operation resource. */
4102
+ /** Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
3552
4103
  name: string;
3553
4104
  /** OAuth 2.0 token for the current user. */
3554
4105
  oauth_token?: string;
@@ -3560,8 +4111,8 @@ declare namespace gapi.client {
3560
4111
  upload_protocol?: string;
3561
4112
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3562
4113
  uploadType?: string;
3563
- }): Request<GoogleLongrunningOperation>;
3564
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
4114
+ }): Request<GoogleCloudDiscoveryengineV1Session>;
4115
+ /** Lists all Sessions by their parent DataStore. */
3565
4116
  list(request?: {
3566
4117
  /** V1 error format. */
3567
4118
  '$.xgafv'?: string;
@@ -3573,18 +4124,20 @@ declare namespace gapi.client {
3573
4124
  callback?: string;
3574
4125
  /** Selector specifying which fields to include in a partial response. */
3575
4126
  fields?: string;
3576
- /** The standard list filter. */
4127
+ /** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
3577
4128
  filter?: string;
3578
4129
  /** 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. */
3579
4130
  key?: string;
3580
- /** The name of the operation's parent resource. */
3581
- name: string;
3582
4131
  /** OAuth 2.0 token for the current user. */
3583
4132
  oauth_token?: string;
3584
- /** The standard list page size. */
4133
+ /** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" */
4134
+ orderBy?: string;
4135
+ /** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
3585
4136
  pageSize?: number;
3586
- /** The standard list page token. */
4137
+ /** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
3587
4138
  pageToken?: string;
4139
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
4140
+ parent: string;
3588
4141
  /** Returns response with indentations and line breaks. */
3589
4142
  prettyPrint?: boolean;
3590
4143
  /** 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. */
@@ -3593,11 +4146,9 @@ declare namespace gapi.client {
3593
4146
  upload_protocol?: string;
3594
4147
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3595
4148
  uploadType?: string;
3596
- }): Request<GoogleLongrunningListOperationsResponse>;
3597
- }
3598
- interface TargetSitesResource {
3599
- /** Creates TargetSite in a batch. */
3600
- batchCreate(request: {
4149
+ }): Request<GoogleCloudDiscoveryengineV1ListSessionsResponse>;
4150
+ /** Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. */
4151
+ patch(request: {
3601
4152
  /** V1 error format. */
3602
4153
  '$.xgafv'?: string;
3603
4154
  /** OAuth access token. */
@@ -3610,22 +4161,24 @@ declare namespace gapi.client {
3610
4161
  fields?: string;
3611
4162
  /** 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. */
3612
4163
  key?: string;
4164
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
4165
+ name: string;
3613
4166
  /** OAuth 2.0 token for the current user. */
3614
4167
  oauth_token?: string;
3615
- /** Required. The parent resource shared by all TargetSites being created. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. */
3616
- parent: string;
3617
4168
  /** Returns response with indentations and line breaks. */
3618
4169
  prettyPrint?: boolean;
3619
4170
  /** 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. */
3620
4171
  quotaUser?: string;
4172
+ /** Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. */
4173
+ updateMask?: string;
3621
4174
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3622
4175
  upload_protocol?: string;
3623
4176
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3624
4177
  uploadType?: string;
3625
4178
  /** Request body */
3626
- resource: GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest;
3627
- }): Request<GoogleLongrunningOperation>;
3628
- batchCreate(
4179
+ resource: GoogleCloudDiscoveryengineV1Session;
4180
+ }): Request<GoogleCloudDiscoveryengineV1Session>;
4181
+ patch(
3629
4182
  request: {
3630
4183
  /** V1 error format. */
3631
4184
  '$.xgafv'?: string;
@@ -3639,23 +4192,28 @@ declare namespace gapi.client {
3639
4192
  fields?: string;
3640
4193
  /** 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. */
3641
4194
  key?: string;
4195
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
4196
+ name: string;
3642
4197
  /** OAuth 2.0 token for the current user. */
3643
4198
  oauth_token?: string;
3644
- /** Required. The parent resource shared by all TargetSites being created. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. */
3645
- parent: string;
3646
4199
  /** Returns response with indentations and line breaks. */
3647
4200
  prettyPrint?: boolean;
3648
4201
  /** 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. */
3649
4202
  quotaUser?: string;
4203
+ /** Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. */
4204
+ updateMask?: string;
3650
4205
  /** Upload protocol for media (e.g. "raw", "multipart"). */
3651
4206
  upload_protocol?: string;
3652
4207
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3653
4208
  uploadType?: string;
3654
4209
  },
3655
- body: GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest
3656
- ): Request<GoogleLongrunningOperation>;
3657
- /** Creates a TargetSite. */
3658
- create(request: {
4210
+ body: GoogleCloudDiscoveryengineV1Session
4211
+ ): Request<GoogleCloudDiscoveryengineV1Session>;
4212
+ answers: AnswersResource;
4213
+ }
4214
+ interface OperationsResource {
4215
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
4216
+ get(request?: {
3659
4217
  /** V1 error format. */
3660
4218
  '$.xgafv'?: string;
3661
4219
  /** OAuth access token. */
@@ -3668,10 +4226,10 @@ declare namespace gapi.client {
3668
4226
  fields?: string;
3669
4227
  /** 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. */
3670
4228
  key?: string;
4229
+ /** The name of the operation resource. */
4230
+ name: string;
3671
4231
  /** OAuth 2.0 token for the current user. */
3672
4232
  oauth_token?: string;
3673
- /** Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. */
3674
- parent: string;
3675
4233
  /** Returns response with indentations and line breaks. */
3676
4234
  prettyPrint?: boolean;
3677
4235
  /** 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. */
@@ -3680,40 +4238,9 @@ declare namespace gapi.client {
3680
4238
  upload_protocol?: string;
3681
4239
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3682
4240
  uploadType?: string;
3683
- /** Request body */
3684
- resource: GoogleCloudDiscoveryengineV1TargetSite;
3685
4241
  }): Request<GoogleLongrunningOperation>;
3686
- create(
3687
- request: {
3688
- /** V1 error format. */
3689
- '$.xgafv'?: string;
3690
- /** OAuth access token. */
3691
- access_token?: string;
3692
- /** Data format for response. */
3693
- alt?: string;
3694
- /** JSONP */
3695
- callback?: string;
3696
- /** Selector specifying which fields to include in a partial response. */
3697
- fields?: string;
3698
- /** 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. */
3699
- key?: string;
3700
- /** OAuth 2.0 token for the current user. */
3701
- oauth_token?: string;
3702
- /** Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. */
3703
- parent: string;
3704
- /** Returns response with indentations and line breaks. */
3705
- prettyPrint?: boolean;
3706
- /** 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. */
3707
- quotaUser?: string;
3708
- /** Upload protocol for media (e.g. "raw", "multipart"). */
3709
- upload_protocol?: string;
3710
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3711
- uploadType?: string;
3712
- },
3713
- body: GoogleCloudDiscoveryengineV1TargetSite
3714
- ): Request<GoogleLongrunningOperation>;
3715
- /** Deletes a TargetSite. */
3716
- delete(request?: {
4242
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
4243
+ list(request?: {
3717
4244
  /** V1 error format. */
3718
4245
  '$.xgafv'?: string;
3719
4246
  /** OAuth access token. */
@@ -3724,12 +4251,18 @@ declare namespace gapi.client {
3724
4251
  callback?: string;
3725
4252
  /** Selector specifying which fields to include in a partial response. */
3726
4253
  fields?: string;
4254
+ /** The standard list filter. */
4255
+ filter?: string;
3727
4256
  /** 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. */
3728
4257
  key?: string;
3729
- /** Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. */
4258
+ /** The name of the operation's parent resource. */
3730
4259
  name: string;
3731
4260
  /** OAuth 2.0 token for the current user. */
3732
4261
  oauth_token?: string;
4262
+ /** The standard list page size. */
4263
+ pageSize?: number;
4264
+ /** The standard list page token. */
4265
+ pageToken?: string;
3733
4266
  /** Returns response with indentations and line breaks. */
3734
4267
  prettyPrint?: boolean;
3735
4268
  /** 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. */
@@ -3738,8 +4271,10 @@ declare namespace gapi.client {
3738
4271
  upload_protocol?: string;
3739
4272
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3740
4273
  uploadType?: string;
3741
- }): Request<GoogleLongrunningOperation>;
3742
- /** Gets a TargetSite. */
4274
+ }): Request<GoogleLongrunningListOperationsResponse>;
4275
+ }
4276
+ interface OperationsResource {
4277
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
3743
4278
  get(request?: {
3744
4279
  /** V1 error format. */
3745
4280
  '$.xgafv'?: string;
@@ -3753,7 +4288,7 @@ declare namespace gapi.client {
3753
4288
  fields?: string;
3754
4289
  /** 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. */
3755
4290
  key?: string;
3756
- /** Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. */
4291
+ /** The name of the operation resource. */
3757
4292
  name: string;
3758
4293
  /** OAuth 2.0 token for the current user. */
3759
4294
  oauth_token?: string;
@@ -3765,8 +4300,8 @@ declare namespace gapi.client {
3765
4300
  upload_protocol?: string;
3766
4301
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3767
4302
  uploadType?: string;
3768
- }): Request<GoogleCloudDiscoveryengineV1TargetSite>;
3769
- /** Gets a list of TargetSites. */
4303
+ }): Request<GoogleLongrunningOperation>;
4304
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
3770
4305
  list(request?: {
3771
4306
  /** V1 error format. */
3772
4307
  '$.xgafv'?: string;
@@ -3778,16 +4313,18 @@ declare namespace gapi.client {
3778
4313
  callback?: string;
3779
4314
  /** Selector specifying which fields to include in a partial response. */
3780
4315
  fields?: string;
4316
+ /** The standard list filter. */
4317
+ filter?: string;
3781
4318
  /** 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. */
3782
4319
  key?: string;
4320
+ /** The name of the operation's parent resource. */
4321
+ name: string;
3783
4322
  /** OAuth 2.0 token for the current user. */
3784
4323
  oauth_token?: string;
3785
- /** Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. */
4324
+ /** The standard list page size. */
3786
4325
  pageSize?: number;
3787
- /** A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. */
4326
+ /** The standard list page token. */
3788
4327
  pageToken?: string;
3789
- /** Required. The parent site search engine resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. */
3790
- parent: string;
3791
4328
  /** Returns response with indentations and line breaks. */
3792
4329
  prettyPrint?: boolean;
3793
4330
  /** 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. */
@@ -3796,9 +4333,11 @@ declare namespace gapi.client {
3796
4333
  upload_protocol?: string;
3797
4334
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3798
4335
  uploadType?: string;
3799
- }): Request<GoogleCloudDiscoveryengineV1ListTargetSitesResponse>;
3800
- /** Updates a TargetSite. */
3801
- patch(request: {
4336
+ }): Request<GoogleLongrunningListOperationsResponse>;
4337
+ }
4338
+ interface TargetSitesResource {
4339
+ /** Creates TargetSite in a batch. */
4340
+ batchCreate(request: {
3802
4341
  /** V1 error format. */
3803
4342
  '$.xgafv'?: string;
3804
4343
  /** OAuth access token. */
@@ -3811,10 +4350,10 @@ declare namespace gapi.client {
3811
4350
  fields?: string;
3812
4351
  /** 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. */
3813
4352
  key?: string;
3814
- /** Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated. */
3815
- name: string;
3816
4353
  /** OAuth 2.0 token for the current user. */
3817
4354
  oauth_token?: string;
4355
+ /** Required. The parent resource shared by all TargetSites being created. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. */
4356
+ parent: string;
3818
4357
  /** Returns response with indentations and line breaks. */
3819
4358
  prettyPrint?: boolean;
3820
4359
  /** 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. */
@@ -3824,7 +4363,208 @@ declare namespace gapi.client {
3824
4363
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
3825
4364
  uploadType?: string;
3826
4365
  /** Request body */
3827
- resource: GoogleCloudDiscoveryengineV1TargetSite;
4366
+ resource: GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest;
4367
+ }): Request<GoogleLongrunningOperation>;
4368
+ batchCreate(
4369
+ request: {
4370
+ /** V1 error format. */
4371
+ '$.xgafv'?: string;
4372
+ /** OAuth access token. */
4373
+ access_token?: string;
4374
+ /** Data format for response. */
4375
+ alt?: string;
4376
+ /** JSONP */
4377
+ callback?: string;
4378
+ /** Selector specifying which fields to include in a partial response. */
4379
+ fields?: string;
4380
+ /** 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. */
4381
+ key?: string;
4382
+ /** OAuth 2.0 token for the current user. */
4383
+ oauth_token?: string;
4384
+ /** Required. The parent resource shared by all TargetSites being created. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. The parent field in the CreateBookRequest messages must either be empty or match this field. */
4385
+ parent: string;
4386
+ /** Returns response with indentations and line breaks. */
4387
+ prettyPrint?: boolean;
4388
+ /** 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. */
4389
+ quotaUser?: string;
4390
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4391
+ upload_protocol?: string;
4392
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4393
+ uploadType?: string;
4394
+ },
4395
+ body: GoogleCloudDiscoveryengineV1BatchCreateTargetSitesRequest
4396
+ ): Request<GoogleLongrunningOperation>;
4397
+ /** Creates a TargetSite. */
4398
+ create(request: {
4399
+ /** V1 error format. */
4400
+ '$.xgafv'?: string;
4401
+ /** OAuth access token. */
4402
+ access_token?: string;
4403
+ /** Data format for response. */
4404
+ alt?: string;
4405
+ /** JSONP */
4406
+ callback?: string;
4407
+ /** Selector specifying which fields to include in a partial response. */
4408
+ fields?: string;
4409
+ /** 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. */
4410
+ key?: string;
4411
+ /** OAuth 2.0 token for the current user. */
4412
+ oauth_token?: string;
4413
+ /** Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. */
4414
+ parent: string;
4415
+ /** Returns response with indentations and line breaks. */
4416
+ prettyPrint?: boolean;
4417
+ /** 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. */
4418
+ quotaUser?: string;
4419
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4420
+ upload_protocol?: string;
4421
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4422
+ uploadType?: string;
4423
+ /** Request body */
4424
+ resource: GoogleCloudDiscoveryengineV1TargetSite;
4425
+ }): Request<GoogleLongrunningOperation>;
4426
+ create(
4427
+ request: {
4428
+ /** V1 error format. */
4429
+ '$.xgafv'?: string;
4430
+ /** OAuth access token. */
4431
+ access_token?: string;
4432
+ /** Data format for response. */
4433
+ alt?: string;
4434
+ /** JSONP */
4435
+ callback?: string;
4436
+ /** Selector specifying which fields to include in a partial response. */
4437
+ fields?: string;
4438
+ /** 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. */
4439
+ key?: string;
4440
+ /** OAuth 2.0 token for the current user. */
4441
+ oauth_token?: string;
4442
+ /** Required. Parent resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. */
4443
+ parent: string;
4444
+ /** Returns response with indentations and line breaks. */
4445
+ prettyPrint?: boolean;
4446
+ /** 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. */
4447
+ quotaUser?: string;
4448
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4449
+ upload_protocol?: string;
4450
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4451
+ uploadType?: string;
4452
+ },
4453
+ body: GoogleCloudDiscoveryengineV1TargetSite
4454
+ ): Request<GoogleLongrunningOperation>;
4455
+ /** Deletes a TargetSite. */
4456
+ delete(request?: {
4457
+ /** V1 error format. */
4458
+ '$.xgafv'?: string;
4459
+ /** OAuth access token. */
4460
+ access_token?: string;
4461
+ /** Data format for response. */
4462
+ alt?: string;
4463
+ /** JSONP */
4464
+ callback?: string;
4465
+ /** Selector specifying which fields to include in a partial response. */
4466
+ fields?: string;
4467
+ /** 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. */
4468
+ key?: string;
4469
+ /** Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. */
4470
+ name: string;
4471
+ /** OAuth 2.0 token for the current user. */
4472
+ oauth_token?: string;
4473
+ /** Returns response with indentations and line breaks. */
4474
+ prettyPrint?: boolean;
4475
+ /** 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. */
4476
+ quotaUser?: string;
4477
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4478
+ upload_protocol?: string;
4479
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4480
+ uploadType?: string;
4481
+ }): Request<GoogleLongrunningOperation>;
4482
+ /** Gets a TargetSite. */
4483
+ get(request?: {
4484
+ /** V1 error format. */
4485
+ '$.xgafv'?: string;
4486
+ /** OAuth access token. */
4487
+ access_token?: string;
4488
+ /** Data format for response. */
4489
+ alt?: string;
4490
+ /** JSONP */
4491
+ callback?: string;
4492
+ /** Selector specifying which fields to include in a partial response. */
4493
+ fields?: string;
4494
+ /** 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. */
4495
+ key?: string;
4496
+ /** Required. Full resource name of TargetSite, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}`. If the caller does not have permission to access the TargetSite, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested TargetSite does not exist, a NOT_FOUND error is returned. */
4497
+ name: string;
4498
+ /** OAuth 2.0 token for the current user. */
4499
+ oauth_token?: string;
4500
+ /** Returns response with indentations and line breaks. */
4501
+ prettyPrint?: boolean;
4502
+ /** 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. */
4503
+ quotaUser?: string;
4504
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4505
+ upload_protocol?: string;
4506
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4507
+ uploadType?: string;
4508
+ }): Request<GoogleCloudDiscoveryengineV1TargetSite>;
4509
+ /** Gets a list of TargetSites. */
4510
+ list(request?: {
4511
+ /** V1 error format. */
4512
+ '$.xgafv'?: string;
4513
+ /** OAuth access token. */
4514
+ access_token?: string;
4515
+ /** Data format for response. */
4516
+ alt?: string;
4517
+ /** JSONP */
4518
+ callback?: string;
4519
+ /** Selector specifying which fields to include in a partial response. */
4520
+ fields?: string;
4521
+ /** 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. */
4522
+ key?: string;
4523
+ /** OAuth 2.0 token for the current user. */
4524
+ oauth_token?: string;
4525
+ /** Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default. The maximum value is 1000; values above 1000 will be coerced to 1000. If this field is negative, an INVALID_ARGUMENT error is returned. */
4526
+ pageSize?: number;
4527
+ /** A page token, received from a previous `ListTargetSites` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListTargetSites` must match the call that provided the page token. */
4528
+ pageToken?: string;
4529
+ /** Required. The parent site search engine resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine`. If the caller does not have permission to list TargetSites under this site search engine, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned. */
4530
+ parent: string;
4531
+ /** Returns response with indentations and line breaks. */
4532
+ prettyPrint?: boolean;
4533
+ /** 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. */
4534
+ quotaUser?: string;
4535
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4536
+ upload_protocol?: string;
4537
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4538
+ uploadType?: string;
4539
+ }): Request<GoogleCloudDiscoveryengineV1ListTargetSitesResponse>;
4540
+ /** Updates a TargetSite. */
4541
+ patch(request: {
4542
+ /** V1 error format. */
4543
+ '$.xgafv'?: string;
4544
+ /** OAuth access token. */
4545
+ access_token?: string;
4546
+ /** Data format for response. */
4547
+ alt?: string;
4548
+ /** JSONP */
4549
+ callback?: string;
4550
+ /** Selector specifying which fields to include in a partial response. */
4551
+ fields?: string;
4552
+ /** 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. */
4553
+ key?: string;
4554
+ /** Output only. The fully qualified resource name of the target site. `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/siteSearchEngine/targetSites/{target_site}` The `target_site_id` is system-generated. */
4555
+ name: string;
4556
+ /** OAuth 2.0 token for the current user. */
4557
+ oauth_token?: string;
4558
+ /** Returns response with indentations and line breaks. */
4559
+ prettyPrint?: boolean;
4560
+ /** 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. */
4561
+ quotaUser?: string;
4562
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
4563
+ upload_protocol?: string;
4564
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
4565
+ uploadType?: string;
4566
+ /** Request body */
4567
+ resource: GoogleCloudDiscoveryengineV1TargetSite;
3828
4568
  }): Request<GoogleLongrunningOperation>;
3829
4569
  patch(
3830
4570
  request: {
@@ -4276,7 +5016,7 @@ declare namespace gapi.client {
4276
5016
  /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
4277
5017
  userEvent?: string;
4278
5018
  }): Request<GoogleApiHttpBody>;
4279
- /** Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. */
5019
+ /** Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. */
4280
5020
  import(request: {
4281
5021
  /** V1 error format. */
4282
5022
  '$.xgafv'?: string;
@@ -4677,6 +5417,7 @@ declare namespace gapi.client {
4677
5417
  operations: OperationsResource;
4678
5418
  schemas: SchemasResource;
4679
5419
  servingConfigs: ServingConfigsResource;
5420
+ sessions: SessionsResource;
4680
5421
  siteSearchEngine: SiteSearchEngineResource;
4681
5422
  suggestionDenyListEntries: SuggestionDenyListEntriesResource;
4682
5423
  userEvents: UserEventsResource;
@@ -5013,8 +5754,8 @@ declare namespace gapi.client {
5013
5754
  }): Request<GoogleLongrunningListOperationsResponse>;
5014
5755
  }
5015
5756
  interface ServingConfigsResource {
5016
- /** Makes a recommendation, which requires a contextual user event. */
5017
- recommend(request: {
5757
+ /** Answer query method. */
5758
+ answer(request: {
5018
5759
  /** V1 error format. */
5019
5760
  '$.xgafv'?: string;
5020
5761
  /** OAuth access token. */
@@ -5033,16 +5774,16 @@ declare namespace gapi.client {
5033
5774
  prettyPrint?: boolean;
5034
5775
  /** 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. */
5035
5776
  quotaUser?: string;
5036
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
5777
+ /** 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/*‍/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
5037
5778
  servingConfig: string;
5038
5779
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5039
5780
  upload_protocol?: string;
5040
5781
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5041
5782
  uploadType?: string;
5042
5783
  /** Request body */
5043
- resource: GoogleCloudDiscoveryengineV1RecommendRequest;
5044
- }): Request<GoogleCloudDiscoveryengineV1RecommendResponse>;
5045
- recommend(
5784
+ resource: GoogleCloudDiscoveryengineV1AnswerQueryRequest;
5785
+ }): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
5786
+ answer(
5046
5787
  request: {
5047
5788
  /** V1 error format. */
5048
5789
  '$.xgafv'?: string;
@@ -5062,17 +5803,17 @@ declare namespace gapi.client {
5062
5803
  prettyPrint?: boolean;
5063
5804
  /** 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. */
5064
5805
  quotaUser?: string;
5065
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
5806
+ /** 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/*‍/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
5066
5807
  servingConfig: string;
5067
5808
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5068
5809
  upload_protocol?: string;
5069
5810
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5070
5811
  uploadType?: string;
5071
5812
  },
5072
- body: GoogleCloudDiscoveryengineV1RecommendRequest
5073
- ): Request<GoogleCloudDiscoveryengineV1RecommendResponse>;
5074
- /** Performs a search. */
5075
- search(request: {
5813
+ body: GoogleCloudDiscoveryengineV1AnswerQueryRequest
5814
+ ): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
5815
+ /** Makes a recommendation, which requires a contextual user event. */
5816
+ recommend(request: {
5076
5817
  /** V1 error format. */
5077
5818
  '$.xgafv'?: string;
5078
5819
  /** OAuth access token. */
@@ -5091,16 +5832,16 @@ declare namespace gapi.client {
5091
5832
  prettyPrint?: boolean;
5092
5833
  /** 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. */
5093
5834
  quotaUser?: string;
5094
- /** 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. */
5835
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
5095
5836
  servingConfig: string;
5096
5837
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5097
5838
  upload_protocol?: string;
5098
5839
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5099
5840
  uploadType?: string;
5100
5841
  /** Request body */
5101
- resource: GoogleCloudDiscoveryengineV1SearchRequest;
5102
- }): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
5103
- search(
5842
+ resource: GoogleCloudDiscoveryengineV1RecommendRequest;
5843
+ }): Request<GoogleCloudDiscoveryengineV1RecommendResponse>;
5844
+ recommend(
5104
5845
  request: {
5105
5846
  /** V1 error format. */
5106
5847
  '$.xgafv'?: string;
@@ -5120,19 +5861,17 @@ declare namespace gapi.client {
5120
5861
  prettyPrint?: boolean;
5121
5862
  /** 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. */
5122
5863
  quotaUser?: string;
5123
- /** 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. */
5864
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
5124
5865
  servingConfig: string;
5125
5866
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5126
5867
  upload_protocol?: string;
5127
5868
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5128
5869
  uploadType?: string;
5129
5870
  },
5130
- body: GoogleCloudDiscoveryengineV1SearchRequest
5131
- ): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
5132
- }
5133
- interface EnginesResource {
5134
- /** Creates a Engine. */
5135
- create(request: {
5871
+ body: GoogleCloudDiscoveryengineV1RecommendRequest
5872
+ ): Request<GoogleCloudDiscoveryengineV1RecommendResponse>;
5873
+ /** Performs a search. */
5874
+ search(request: {
5136
5875
  /** V1 error format. */
5137
5876
  '$.xgafv'?: string;
5138
5877
  /** OAuth access token. */
@@ -5141,28 +5880,26 @@ declare namespace gapi.client {
5141
5880
  alt?: string;
5142
5881
  /** JSONP */
5143
5882
  callback?: string;
5144
- /** Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
5145
- engineId?: string;
5146
5883
  /** Selector specifying which fields to include in a partial response. */
5147
5884
  fields?: string;
5148
5885
  /** 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. */
5149
5886
  key?: string;
5150
5887
  /** OAuth 2.0 token for the current user. */
5151
5888
  oauth_token?: string;
5152
- /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
5153
- parent: string;
5154
5889
  /** Returns response with indentations and line breaks. */
5155
5890
  prettyPrint?: boolean;
5156
5891
  /** 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. */
5157
5892
  quotaUser?: string;
5893
+ /** 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. */
5894
+ servingConfig: string;
5158
5895
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5159
5896
  upload_protocol?: string;
5160
5897
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5161
5898
  uploadType?: string;
5162
5899
  /** Request body */
5163
- resource: GoogleCloudDiscoveryengineV1Engine;
5164
- }): Request<GoogleLongrunningOperation>;
5165
- create(
5900
+ resource: GoogleCloudDiscoveryengineV1SearchRequest;
5901
+ }): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
5902
+ search(
5166
5903
  request: {
5167
5904
  /** V1 error format. */
5168
5905
  '$.xgafv'?: string;
@@ -5172,32 +5909,32 @@ declare namespace gapi.client {
5172
5909
  alt?: string;
5173
5910
  /** JSONP */
5174
5911
  callback?: string;
5175
- /** Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
5176
- engineId?: string;
5177
5912
  /** Selector specifying which fields to include in a partial response. */
5178
5913
  fields?: string;
5179
5914
  /** 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. */
5180
5915
  key?: string;
5181
5916
  /** OAuth 2.0 token for the current user. */
5182
5917
  oauth_token?: string;
5183
- /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
5184
- parent: string;
5185
5918
  /** Returns response with indentations and line breaks. */
5186
5919
  prettyPrint?: boolean;
5187
5920
  /** 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. */
5188
5921
  quotaUser?: string;
5922
+ /** 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. */
5923
+ servingConfig: string;
5189
5924
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5190
5925
  upload_protocol?: string;
5191
5926
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5192
5927
  uploadType?: string;
5193
5928
  },
5194
- body: GoogleCloudDiscoveryengineV1Engine
5195
- ): Request<GoogleLongrunningOperation>;
5196
- /** Deletes a Engine. */
5197
- delete(request?: {
5198
- /** V1 error format. */
5199
- '$.xgafv'?: string;
5200
- /** OAuth access token. */
5929
+ body: GoogleCloudDiscoveryengineV1SearchRequest
5930
+ ): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
5931
+ }
5932
+ interface AnswersResource {
5933
+ /** Gets a Answer. */
5934
+ get(request?: {
5935
+ /** V1 error format. */
5936
+ '$.xgafv'?: string;
5937
+ /** OAuth access token. */
5201
5938
  access_token?: string;
5202
5939
  /** Data format for response. */
5203
5940
  alt?: string;
@@ -5207,7 +5944,7 @@ declare namespace gapi.client {
5207
5944
  fields?: string;
5208
5945
  /** 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. */
5209
5946
  key?: string;
5210
- /** Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. */
5947
+ /** Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` */
5211
5948
  name: string;
5212
5949
  /** OAuth 2.0 token for the current user. */
5213
5950
  oauth_token?: string;
@@ -5219,9 +5956,11 @@ declare namespace gapi.client {
5219
5956
  upload_protocol?: string;
5220
5957
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5221
5958
  uploadType?: string;
5222
- }): Request<GoogleLongrunningOperation>;
5223
- /** Gets a Engine. */
5224
- get(request?: {
5959
+ }): Request<GoogleCloudDiscoveryengineV1Answer>;
5960
+ }
5961
+ interface SessionsResource {
5962
+ /** Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. */
5963
+ create(request: {
5225
5964
  /** V1 error format. */
5226
5965
  '$.xgafv'?: string;
5227
5966
  /** OAuth access token. */
@@ -5234,10 +5973,10 @@ declare namespace gapi.client {
5234
5973
  fields?: string;
5235
5974
  /** 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. */
5236
5975
  key?: string;
5237
- /** Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. */
5238
- name: string;
5239
5976
  /** OAuth 2.0 token for the current user. */
5240
5977
  oauth_token?: string;
5978
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
5979
+ parent: string;
5241
5980
  /** Returns response with indentations and line breaks. */
5242
5981
  prettyPrint?: boolean;
5243
5982
  /** 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. */
@@ -5246,9 +5985,40 @@ declare namespace gapi.client {
5246
5985
  upload_protocol?: string;
5247
5986
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5248
5987
  uploadType?: string;
5249
- }): Request<GoogleCloudDiscoveryengineV1Engine>;
5250
- /** Lists all the Engines associated with the project. */
5251
- list(request?: {
5988
+ /** Request body */
5989
+ resource: GoogleCloudDiscoveryengineV1Session;
5990
+ }): Request<GoogleCloudDiscoveryengineV1Session>;
5991
+ create(
5992
+ request: {
5993
+ /** V1 error format. */
5994
+ '$.xgafv'?: string;
5995
+ /** OAuth access token. */
5996
+ access_token?: string;
5997
+ /** Data format for response. */
5998
+ alt?: string;
5999
+ /** JSONP */
6000
+ callback?: string;
6001
+ /** Selector specifying which fields to include in a partial response. */
6002
+ fields?: string;
6003
+ /** 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. */
6004
+ key?: string;
6005
+ /** OAuth 2.0 token for the current user. */
6006
+ oauth_token?: string;
6007
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
6008
+ parent: string;
6009
+ /** Returns response with indentations and line breaks. */
6010
+ prettyPrint?: boolean;
6011
+ /** 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. */
6012
+ quotaUser?: string;
6013
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6014
+ upload_protocol?: string;
6015
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6016
+ uploadType?: string;
6017
+ },
6018
+ body: GoogleCloudDiscoveryengineV1Session
6019
+ ): Request<GoogleCloudDiscoveryengineV1Session>;
6020
+ /** Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. */
6021
+ delete(request?: {
5252
6022
  /** V1 error format. */
5253
6023
  '$.xgafv'?: string;
5254
6024
  /** OAuth access token. */
@@ -5259,18 +6029,12 @@ declare namespace gapi.client {
5259
6029
  callback?: string;
5260
6030
  /** Selector specifying which fields to include in a partial response. */
5261
6031
  fields?: string;
5262
- /** Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH */
5263
- filter?: string;
5264
6032
  /** 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. */
5265
6033
  key?: string;
6034
+ /** Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
6035
+ name: string;
5266
6036
  /** OAuth 2.0 token for the current user. */
5267
6037
  oauth_token?: string;
5268
- /** Optional. Not supported. */
5269
- pageSize?: number;
5270
- /** Optional. Not supported. */
5271
- pageToken?: string;
5272
- /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. */
5273
- parent: string;
5274
6038
  /** Returns response with indentations and line breaks. */
5275
6039
  prettyPrint?: boolean;
5276
6040
  /** 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. */
@@ -5279,9 +6043,9 @@ declare namespace gapi.client {
5279
6043
  upload_protocol?: string;
5280
6044
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5281
6045
  uploadType?: string;
5282
- }): Request<GoogleCloudDiscoveryengineV1ListEnginesResponse>;
5283
- /** Updates an Engine */
5284
- patch(request: {
6046
+ }): Request<{}>;
6047
+ /** Gets a Session. */
6048
+ get(request?: {
5285
6049
  /** V1 error format. */
5286
6050
  '$.xgafv'?: string;
5287
6051
  /** OAuth access token. */
@@ -5294,7 +6058,7 @@ declare namespace gapi.client {
5294
6058
  fields?: string;
5295
6059
  /** 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. */
5296
6060
  key?: string;
5297
- /** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an INVALID_ARGUMENT error is returned. */
6061
+ /** Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
5298
6062
  name: string;
5299
6063
  /** OAuth 2.0 token for the current user. */
5300
6064
  oauth_token?: string;
@@ -5302,53 +6066,13 @@ declare namespace gapi.client {
5302
6066
  prettyPrint?: boolean;
5303
6067
  /** 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. */
5304
6068
  quotaUser?: string;
5305
- /** Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
5306
- updateMask?: string;
5307
6069
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5308
6070
  upload_protocol?: string;
5309
6071
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5310
6072
  uploadType?: string;
5311
- /** Request body */
5312
- resource: GoogleCloudDiscoveryengineV1Engine;
5313
- }): Request<GoogleCloudDiscoveryengineV1Engine>;
5314
- patch(
5315
- request: {
5316
- /** V1 error format. */
5317
- '$.xgafv'?: string;
5318
- /** OAuth access token. */
5319
- access_token?: string;
5320
- /** Data format for response. */
5321
- alt?: string;
5322
- /** JSONP */
5323
- callback?: string;
5324
- /** Selector specifying which fields to include in a partial response. */
5325
- fields?: string;
5326
- /** 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. */
5327
- key?: string;
5328
- /** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an INVALID_ARGUMENT error is returned. */
5329
- name: string;
5330
- /** OAuth 2.0 token for the current user. */
5331
- oauth_token?: string;
5332
- /** Returns response with indentations and line breaks. */
5333
- prettyPrint?: boolean;
5334
- /** 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. */
5335
- quotaUser?: string;
5336
- /** Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
5337
- updateMask?: string;
5338
- /** Upload protocol for media (e.g. "raw", "multipart"). */
5339
- upload_protocol?: string;
5340
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5341
- uploadType?: string;
5342
- },
5343
- body: GoogleCloudDiscoveryengineV1Engine
5344
- ): Request<GoogleCloudDiscoveryengineV1Engine>;
5345
- conversations: ConversationsResource;
5346
- operations: OperationsResource;
5347
- servingConfigs: ServingConfigsResource;
5348
- }
5349
- interface OperationsResource {
5350
- /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
5351
- get(request?: {
6073
+ }): Request<GoogleCloudDiscoveryengineV1Session>;
6074
+ /** Lists all Sessions by their parent DataStore. */
6075
+ list(request?: {
5352
6076
  /** V1 error format. */
5353
6077
  '$.xgafv'?: string;
5354
6078
  /** OAuth access token. */
@@ -5359,12 +6083,20 @@ declare namespace gapi.client {
5359
6083
  callback?: string;
5360
6084
  /** Selector specifying which fields to include in a partial response. */
5361
6085
  fields?: string;
6086
+ /** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
6087
+ filter?: string;
5362
6088
  /** 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. */
5363
6089
  key?: string;
5364
- /** The name of the operation resource. */
5365
- name: string;
5366
6090
  /** OAuth 2.0 token for the current user. */
5367
6091
  oauth_token?: string;
6092
+ /** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" */
6093
+ orderBy?: string;
6094
+ /** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
6095
+ pageSize?: number;
6096
+ /** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
6097
+ pageToken?: string;
6098
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
6099
+ parent: string;
5368
6100
  /** Returns response with indentations and line breaks. */
5369
6101
  prettyPrint?: boolean;
5370
6102
  /** 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. */
@@ -5373,9 +6105,9 @@ declare namespace gapi.client {
5373
6105
  upload_protocol?: string;
5374
6106
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5375
6107
  uploadType?: string;
5376
- }): Request<GoogleLongrunningOperation>;
5377
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
5378
- list(request?: {
6108
+ }): Request<GoogleCloudDiscoveryengineV1ListSessionsResponse>;
6109
+ /** Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. */
6110
+ patch(request: {
5379
6111
  /** V1 error format. */
5380
6112
  '$.xgafv'?: string;
5381
6113
  /** OAuth access token. */
@@ -5386,36 +6118,60 @@ declare namespace gapi.client {
5386
6118
  callback?: string;
5387
6119
  /** Selector specifying which fields to include in a partial response. */
5388
6120
  fields?: string;
5389
- /** The standard list filter. */
5390
- filter?: string;
5391
6121
  /** 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. */
5392
6122
  key?: string;
5393
- /** The name of the operation's parent resource. */
6123
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
5394
6124
  name: string;
5395
6125
  /** OAuth 2.0 token for the current user. */
5396
6126
  oauth_token?: string;
5397
- /** The standard list page size. */
5398
- pageSize?: number;
5399
- /** The standard list page token. */
5400
- pageToken?: string;
5401
6127
  /** Returns response with indentations and line breaks. */
5402
6128
  prettyPrint?: boolean;
5403
6129
  /** 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. */
5404
6130
  quotaUser?: string;
6131
+ /** Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. */
6132
+ updateMask?: string;
5405
6133
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5406
6134
  upload_protocol?: string;
5407
6135
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5408
6136
  uploadType?: string;
5409
- }): Request<GoogleLongrunningListOperationsResponse>;
5410
- }
5411
- interface CollectionsResource {
5412
- dataConnector: DataConnectorResource;
5413
- dataStores: DataStoresResource;
5414
- engines: EnginesResource;
5415
- operations: OperationsResource;
6137
+ /** Request body */
6138
+ resource: GoogleCloudDiscoveryengineV1Session;
6139
+ }): Request<GoogleCloudDiscoveryengineV1Session>;
6140
+ patch(
6141
+ request: {
6142
+ /** V1 error format. */
6143
+ '$.xgafv'?: string;
6144
+ /** OAuth access token. */
6145
+ access_token?: string;
6146
+ /** Data format for response. */
6147
+ alt?: string;
6148
+ /** JSONP */
6149
+ callback?: string;
6150
+ /** Selector specifying which fields to include in a partial response. */
6151
+ fields?: string;
6152
+ /** 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. */
6153
+ key?: string;
6154
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
6155
+ name: string;
6156
+ /** OAuth 2.0 token for the current user. */
6157
+ oauth_token?: string;
6158
+ /** Returns response with indentations and line breaks. */
6159
+ prettyPrint?: boolean;
6160
+ /** 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. */
6161
+ quotaUser?: string;
6162
+ /** Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. */
6163
+ updateMask?: string;
6164
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6165
+ upload_protocol?: string;
6166
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6167
+ uploadType?: string;
6168
+ },
6169
+ body: GoogleCloudDiscoveryengineV1Session
6170
+ ): Request<GoogleCloudDiscoveryengineV1Session>;
6171
+ answers: AnswersResource;
5416
6172
  }
5417
- interface DocumentsResource {
5418
- /** Creates a Document. */
6173
+ interface EnginesResource {
6174
+ /** Creates a Engine. */
5419
6175
  create(request: {
5420
6176
  /** V1 error format. */
5421
6177
  '$.xgafv'?: string;
@@ -5425,15 +6181,15 @@ declare namespace gapi.client {
5425
6181
  alt?: string;
5426
6182
  /** JSONP */
5427
6183
  callback?: string;
5428
- /** Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
5429
- documentId?: string;
6184
+ /** Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
6185
+ engineId?: string;
5430
6186
  /** Selector specifying which fields to include in a partial response. */
5431
6187
  fields?: string;
5432
6188
  /** 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. */
5433
6189
  key?: string;
5434
6190
  /** OAuth 2.0 token for the current user. */
5435
6191
  oauth_token?: string;
5436
- /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
6192
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
5437
6193
  parent: string;
5438
6194
  /** Returns response with indentations and line breaks. */
5439
6195
  prettyPrint?: boolean;
@@ -5444,8 +6200,8 @@ declare namespace gapi.client {
5444
6200
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5445
6201
  uploadType?: string;
5446
6202
  /** Request body */
5447
- resource: GoogleCloudDiscoveryengineV1Document;
5448
- }): Request<GoogleCloudDiscoveryengineV1Document>;
6203
+ resource: GoogleCloudDiscoveryengineV1Engine;
6204
+ }): Request<GoogleLongrunningOperation>;
5449
6205
  create(
5450
6206
  request: {
5451
6207
  /** V1 error format. */
@@ -5456,15 +6212,15 @@ declare namespace gapi.client {
5456
6212
  alt?: string;
5457
6213
  /** JSONP */
5458
6214
  callback?: string;
5459
- /** Required. The ID to use for the Document, which will become the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
5460
- documentId?: string;
6215
+ /** Required. The ID to use for the Engine, which will become the final component of the Engine's resource name. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an INVALID_ARGUMENT error is returned. */
6216
+ engineId?: string;
5461
6217
  /** Selector specifying which fields to include in a partial response. */
5462
6218
  fields?: string;
5463
6219
  /** 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. */
5464
6220
  key?: string;
5465
6221
  /** OAuth 2.0 token for the current user. */
5466
6222
  oauth_token?: string;
5467
- /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
6223
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}`. */
5468
6224
  parent: string;
5469
6225
  /** Returns response with indentations and line breaks. */
5470
6226
  prettyPrint?: boolean;
@@ -5475,9 +6231,9 @@ declare namespace gapi.client {
5475
6231
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5476
6232
  uploadType?: string;
5477
6233
  },
5478
- body: GoogleCloudDiscoveryengineV1Document
5479
- ): Request<GoogleCloudDiscoveryengineV1Document>;
5480
- /** Deletes a Document. */
6234
+ body: GoogleCloudDiscoveryengineV1Engine
6235
+ ): Request<GoogleLongrunningOperation>;
6236
+ /** Deletes a Engine. */
5481
6237
  delete(request?: {
5482
6238
  /** V1 error format. */
5483
6239
  '$.xgafv'?: string;
@@ -5491,7 +6247,7 @@ declare namespace gapi.client {
5491
6247
  fields?: string;
5492
6248
  /** 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. */
5493
6249
  key?: string;
5494
- /** Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. */
6250
+ /** Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. If the caller does not have permission to delete the Engine, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Engine to delete does not exist, a NOT_FOUND error is returned. */
5495
6251
  name: string;
5496
6252
  /** OAuth 2.0 token for the current user. */
5497
6253
  oauth_token?: string;
@@ -5503,8 +6259,8 @@ declare namespace gapi.client {
5503
6259
  upload_protocol?: string;
5504
6260
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5505
6261
  uploadType?: string;
5506
- }): Request<{}>;
5507
- /** Gets a Document. */
6262
+ }): Request<GoogleLongrunningOperation>;
6263
+ /** Gets a Engine. */
5508
6264
  get(request?: {
5509
6265
  /** V1 error format. */
5510
6266
  '$.xgafv'?: string;
@@ -5518,7 +6274,7 @@ declare namespace gapi.client {
5518
6274
  fields?: string;
5519
6275
  /** 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. */
5520
6276
  key?: string;
5521
- /** Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. */
6277
+ /** Required. Full resource name of Engine, such as `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`. */
5522
6278
  name: string;
5523
6279
  /** OAuth 2.0 token for the current user. */
5524
6280
  oauth_token?: string;
@@ -5530,9 +6286,9 @@ declare namespace gapi.client {
5530
6286
  upload_protocol?: string;
5531
6287
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5532
6288
  uploadType?: string;
5533
- }): Request<GoogleCloudDiscoveryengineV1Document>;
5534
- /** Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items will be created. Note: It is possible for a subset of the Documents to be successfully updated. */
5535
- import(request: {
6289
+ }): Request<GoogleCloudDiscoveryengineV1Engine>;
6290
+ /** Lists all the Engines associated with the project. */
6291
+ list(request?: {
5536
6292
  /** V1 error format. */
5537
6293
  '$.xgafv'?: string;
5538
6294
  /** OAuth access token. */
@@ -5543,11 +6299,17 @@ declare namespace gapi.client {
5543
6299
  callback?: string;
5544
6300
  /** Selector specifying which fields to include in a partial response. */
5545
6301
  fields?: string;
6302
+ /** Optional. Filter by solution type. For example: solution_type=SOLUTION_TYPE_SEARCH */
6303
+ filter?: string;
5546
6304
  /** 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. */
5547
6305
  key?: string;
5548
6306
  /** OAuth 2.0 token for the current user. */
5549
6307
  oauth_token?: string;
5550
- /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission. */
6308
+ /** Optional. Not supported. */
6309
+ pageSize?: number;
6310
+ /** Optional. Not supported. */
6311
+ pageToken?: string;
6312
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection_id}`. */
5551
6313
  parent: string;
5552
6314
  /** Returns response with indentations and line breaks. */
5553
6315
  prettyPrint?: boolean;
@@ -5557,10 +6319,39 @@ declare namespace gapi.client {
5557
6319
  upload_protocol?: string;
5558
6320
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5559
6321
  uploadType?: string;
6322
+ }): Request<GoogleCloudDiscoveryengineV1ListEnginesResponse>;
6323
+ /** Updates an Engine */
6324
+ patch(request: {
6325
+ /** V1 error format. */
6326
+ '$.xgafv'?: string;
6327
+ /** OAuth access token. */
6328
+ access_token?: string;
6329
+ /** Data format for response. */
6330
+ alt?: string;
6331
+ /** JSONP */
6332
+ callback?: string;
6333
+ /** Selector specifying which fields to include in a partial response. */
6334
+ fields?: string;
6335
+ /** 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. */
6336
+ key?: string;
6337
+ /** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an INVALID_ARGUMENT error is returned. */
6338
+ name: string;
6339
+ /** OAuth 2.0 token for the current user. */
6340
+ oauth_token?: string;
6341
+ /** Returns response with indentations and line breaks. */
6342
+ prettyPrint?: boolean;
6343
+ /** 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. */
6344
+ quotaUser?: string;
6345
+ /** Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
6346
+ updateMask?: string;
6347
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6348
+ upload_protocol?: string;
6349
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6350
+ uploadType?: string;
5560
6351
  /** Request body */
5561
- resource: GoogleCloudDiscoveryengineV1ImportDocumentsRequest;
5562
- }): Request<GoogleLongrunningOperation>;
5563
- import(
6352
+ resource: GoogleCloudDiscoveryengineV1Engine;
6353
+ }): Request<GoogleCloudDiscoveryengineV1Engine>;
6354
+ patch(
5564
6355
  request: {
5565
6356
  /** V1 error format. */
5566
6357
  '$.xgafv'?: string;
@@ -5574,24 +6365,32 @@ declare namespace gapi.client {
5574
6365
  fields?: string;
5575
6366
  /** 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. */
5576
6367
  key?: string;
6368
+ /** Immutable. The fully qualified resource name of the engine. This field must be a UTF-8 encoded string with a length limit of 1024 characters. Format: `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}` engine should be 1-63 characters, and valid characters are /a-z0-9*‍/. Otherwise, an INVALID_ARGUMENT error is returned. */
6369
+ name: string;
5577
6370
  /** OAuth 2.0 token for the current user. */
5578
6371
  oauth_token?: string;
5579
- /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission. */
5580
- parent: string;
5581
6372
  /** Returns response with indentations and line breaks. */
5582
6373
  prettyPrint?: boolean;
5583
6374
  /** 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. */
5584
6375
  quotaUser?: string;
6376
+ /** Indicates which fields in the provided Engine to update. If an unsupported or unknown field is provided, an INVALID_ARGUMENT error is returned. */
6377
+ updateMask?: string;
5585
6378
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5586
6379
  upload_protocol?: string;
5587
6380
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5588
6381
  uploadType?: string;
5589
6382
  },
5590
- body: GoogleCloudDiscoveryengineV1ImportDocumentsRequest
5591
- ): Request<GoogleLongrunningOperation>;
5592
- /** Gets a list of Documents. */
5593
- list(request?: {
5594
- /** V1 error format. */
6383
+ body: GoogleCloudDiscoveryengineV1Engine
6384
+ ): Request<GoogleCloudDiscoveryengineV1Engine>;
6385
+ conversations: ConversationsResource;
6386
+ operations: OperationsResource;
6387
+ servingConfigs: ServingConfigsResource;
6388
+ sessions: SessionsResource;
6389
+ }
6390
+ interface OperationsResource {
6391
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
6392
+ get(request?: {
6393
+ /** V1 error format. */
5595
6394
  '$.xgafv'?: string;
5596
6395
  /** OAuth access token. */
5597
6396
  access_token?: string;
@@ -5603,14 +6402,10 @@ declare namespace gapi.client {
5603
6402
  fields?: string;
5604
6403
  /** 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. */
5605
6404
  key?: string;
6405
+ /** The name of the operation resource. */
6406
+ name: string;
5606
6407
  /** OAuth 2.0 token for the current user. */
5607
6408
  oauth_token?: string;
5608
- /** Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
5609
- pageSize?: number;
5610
- /** A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
5611
- pageToken?: string;
5612
- /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. */
5613
- parent: string;
5614
6409
  /** Returns response with indentations and line breaks. */
5615
6410
  prettyPrint?: boolean;
5616
6411
  /** 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. */
@@ -5619,75 +6414,50 @@ declare namespace gapi.client {
5619
6414
  upload_protocol?: string;
5620
6415
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5621
6416
  uploadType?: string;
5622
- }): Request<GoogleCloudDiscoveryengineV1ListDocumentsResponse>;
5623
- /** Updates a Document. */
5624
- patch(request: {
6417
+ }): Request<GoogleLongrunningOperation>;
6418
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
6419
+ list(request?: {
5625
6420
  /** V1 error format. */
5626
6421
  '$.xgafv'?: string;
5627
6422
  /** OAuth access token. */
5628
6423
  access_token?: string;
5629
- /** If set to true, and the Document is not found, a new Document will be created. */
5630
- allowMissing?: boolean;
5631
6424
  /** Data format for response. */
5632
6425
  alt?: string;
5633
6426
  /** JSONP */
5634
6427
  callback?: string;
5635
6428
  /** Selector specifying which fields to include in a partial response. */
5636
6429
  fields?: string;
6430
+ /** The standard list filter. */
6431
+ filter?: string;
5637
6432
  /** 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. */
5638
6433
  key?: string;
5639
- /** Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
6434
+ /** The name of the operation's parent resource. */
5640
6435
  name: string;
5641
6436
  /** OAuth 2.0 token for the current user. */
5642
6437
  oauth_token?: string;
6438
+ /** The standard list page size. */
6439
+ pageSize?: number;
6440
+ /** The standard list page token. */
6441
+ pageToken?: string;
5643
6442
  /** Returns response with indentations and line breaks. */
5644
6443
  prettyPrint?: boolean;
5645
6444
  /** 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. */
5646
6445
  quotaUser?: string;
5647
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
5648
- updateMask?: string;
5649
6446
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5650
6447
  upload_protocol?: string;
5651
6448
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5652
6449
  uploadType?: string;
5653
- /** Request body */
5654
- resource: GoogleCloudDiscoveryengineV1Document;
5655
- }): Request<GoogleCloudDiscoveryengineV1Document>;
5656
- patch(
5657
- request: {
5658
- /** V1 error format. */
5659
- '$.xgafv'?: string;
5660
- /** OAuth access token. */
5661
- access_token?: string;
5662
- /** If set to true, and the Document is not found, a new Document will be created. */
5663
- allowMissing?: boolean;
5664
- /** Data format for response. */
5665
- alt?: string;
5666
- /** JSONP */
5667
- callback?: string;
5668
- /** Selector specifying which fields to include in a partial response. */
5669
- fields?: string;
5670
- /** 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. */
5671
- key?: string;
5672
- /** Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
5673
- name: string;
5674
- /** OAuth 2.0 token for the current user. */
5675
- oauth_token?: string;
5676
- /** Returns response with indentations and line breaks. */
5677
- prettyPrint?: boolean;
5678
- /** 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. */
5679
- quotaUser?: string;
5680
- /** Indicates which fields in the provided imported 'document' to update. If not set, will by default update all fields. */
5681
- updateMask?: string;
5682
- /** Upload protocol for media (e.g. "raw", "multipart"). */
5683
- upload_protocol?: string;
5684
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5685
- uploadType?: string;
5686
- },
5687
- body: GoogleCloudDiscoveryengineV1Document
5688
- ): Request<GoogleCloudDiscoveryengineV1Document>;
5689
- /** Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. */
5690
- purge(request: {
6450
+ }): Request<GoogleLongrunningListOperationsResponse>;
6451
+ }
6452
+ interface CollectionsResource {
6453
+ dataConnector: DataConnectorResource;
6454
+ dataStores: DataStoresResource;
6455
+ engines: EnginesResource;
6456
+ operations: OperationsResource;
6457
+ }
6458
+ interface DocumentsResource {
6459
+ /** Creates a Document. */
6460
+ create(request: {
5691
6461
  /** V1 error format. */
5692
6462
  '$.xgafv'?: string;
5693
6463
  /** OAuth access token. */
@@ -5696,6 +6466,8 @@ declare namespace gapi.client {
5696
6466
  alt?: string;
5697
6467
  /** JSONP */
5698
6468
  callback?: string;
6469
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
6470
+ documentId?: string;
5699
6471
  /** Selector specifying which fields to include in a partial response. */
5700
6472
  fields?: string;
5701
6473
  /** 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. */
@@ -5713,9 +6485,9 @@ declare namespace gapi.client {
5713
6485
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5714
6486
  uploadType?: string;
5715
6487
  /** Request body */
5716
- resource: GoogleCloudDiscoveryengineV1PurgeDocumentsRequest;
5717
- }): Request<GoogleLongrunningOperation>;
5718
- purge(
6488
+ resource: GoogleCloudDiscoveryengineV1Document;
6489
+ }): Request<GoogleCloudDiscoveryengineV1Document>;
6490
+ create(
5719
6491
  request: {
5720
6492
  /** V1 error format. */
5721
6493
  '$.xgafv'?: string;
@@ -5725,6 +6497,8 @@ declare namespace gapi.client {
5725
6497
  alt?: string;
5726
6498
  /** JSONP */
5727
6499
  callback?: string;
6500
+ /** Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. This field must be unique among all Documents with the same parent. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned. */
6501
+ documentId?: string;
5728
6502
  /** Selector specifying which fields to include in a partial response. */
5729
6503
  fields?: string;
5730
6504
  /** 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. */
@@ -5742,12 +6516,10 @@ declare namespace gapi.client {
5742
6516
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5743
6517
  uploadType?: string;
5744
6518
  },
5745
- body: GoogleCloudDiscoveryengineV1PurgeDocumentsRequest
5746
- ): Request<GoogleLongrunningOperation>;
5747
- }
5748
- interface OperationsResource {
5749
- /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
5750
- get(request?: {
6519
+ body: GoogleCloudDiscoveryengineV1Document
6520
+ ): Request<GoogleCloudDiscoveryengineV1Document>;
6521
+ /** Deletes a Document. */
6522
+ delete(request?: {
5751
6523
  /** V1 error format. */
5752
6524
  '$.xgafv'?: string;
5753
6525
  /** OAuth access token. */
@@ -5760,7 +6532,7 @@ declare namespace gapi.client {
5760
6532
  fields?: string;
5761
6533
  /** 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. */
5762
6534
  key?: string;
5763
- /** The name of the operation resource. */
6535
+ /** Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the Document to delete does not exist, a `NOT_FOUND` error is returned. */
5764
6536
  name: string;
5765
6537
  /** OAuth 2.0 token for the current user. */
5766
6538
  oauth_token?: string;
@@ -5772,9 +6544,9 @@ declare namespace gapi.client {
5772
6544
  upload_protocol?: string;
5773
6545
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5774
6546
  uploadType?: string;
5775
- }): Request<GoogleLongrunningOperation>;
5776
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
5777
- list(request?: {
6547
+ }): Request<{}>;
6548
+ /** Gets a Document. */
6549
+ get(request?: {
5778
6550
  /** V1 error format. */
5779
6551
  '$.xgafv'?: string;
5780
6552
  /** OAuth access token. */
@@ -5785,18 +6557,12 @@ declare namespace gapi.client {
5785
6557
  callback?: string;
5786
6558
  /** Selector specifying which fields to include in a partial response. */
5787
6559
  fields?: string;
5788
- /** The standard list filter. */
5789
- filter?: string;
5790
6560
  /** 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. */
5791
6561
  key?: string;
5792
- /** The name of the operation's parent resource. */
6562
+ /** Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a `PERMISSION_DENIED` error is returned. If the requested Document does not exist, a `NOT_FOUND` error is returned. */
5793
6563
  name: string;
5794
6564
  /** OAuth 2.0 token for the current user. */
5795
6565
  oauth_token?: string;
5796
- /** The standard list page size. */
5797
- pageSize?: number;
5798
- /** The standard list page token. */
5799
- pageToken?: string;
5800
6566
  /** Returns response with indentations and line breaks. */
5801
6567
  prettyPrint?: boolean;
5802
6568
  /** 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. */
@@ -5805,15 +6571,9 @@ declare namespace gapi.client {
5805
6571
  upload_protocol?: string;
5806
6572
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5807
6573
  uploadType?: string;
5808
- }): Request<GoogleLongrunningListOperationsResponse>;
5809
- }
5810
- interface BranchesResource {
5811
- documents: DocumentsResource;
5812
- operations: OperationsResource;
5813
- }
5814
- interface ConversationsResource {
5815
- /** Converses a conversation. */
5816
- converse(request: {
6574
+ }): Request<GoogleCloudDiscoveryengineV1Document>;
6575
+ /** Bulk import of multiple Documents. Request processing may be synchronous. Non-existing items are created. Note: It is possible for a subset of the Documents to be successfully updated. */
6576
+ import(request: {
5817
6577
  /** V1 error format. */
5818
6578
  '$.xgafv'?: string;
5819
6579
  /** OAuth access token. */
@@ -5826,10 +6586,10 @@ declare namespace gapi.client {
5826
6586
  fields?: string;
5827
6587
  /** 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. */
5828
6588
  key?: string;
5829
- /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
5830
- name: string;
5831
6589
  /** OAuth 2.0 token for the current user. */
5832
6590
  oauth_token?: string;
6591
+ /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission. */
6592
+ parent: string;
5833
6593
  /** Returns response with indentations and line breaks. */
5834
6594
  prettyPrint?: boolean;
5835
6595
  /** 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. */
@@ -5839,9 +6599,9 @@ declare namespace gapi.client {
5839
6599
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5840
6600
  uploadType?: string;
5841
6601
  /** Request body */
5842
- resource: GoogleCloudDiscoveryengineV1ConverseConversationRequest;
5843
- }): Request<GoogleCloudDiscoveryengineV1ConverseConversationResponse>;
5844
- converse(
6602
+ resource: GoogleCloudDiscoveryengineV1ImportDocumentsRequest;
6603
+ }): Request<GoogleLongrunningOperation>;
6604
+ import(
5845
6605
  request: {
5846
6606
  /** V1 error format. */
5847
6607
  '$.xgafv'?: string;
@@ -5855,10 +6615,10 @@ declare namespace gapi.client {
5855
6615
  fields?: string;
5856
6616
  /** 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. */
5857
6617
  key?: string;
5858
- /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
5859
- name: string;
5860
6618
  /** OAuth 2.0 token for the current user. */
5861
6619
  oauth_token?: string;
6620
+ /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission. */
6621
+ parent: string;
5862
6622
  /** Returns response with indentations and line breaks. */
5863
6623
  prettyPrint?: boolean;
5864
6624
  /** 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. */
@@ -5868,10 +6628,10 @@ declare namespace gapi.client {
5868
6628
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5869
6629
  uploadType?: string;
5870
6630
  },
5871
- body: GoogleCloudDiscoveryengineV1ConverseConversationRequest
5872
- ): Request<GoogleCloudDiscoveryengineV1ConverseConversationResponse>;
5873
- /** Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. */
5874
- create(request: {
6631
+ body: GoogleCloudDiscoveryengineV1ImportDocumentsRequest
6632
+ ): Request<GoogleLongrunningOperation>;
6633
+ /** Gets a list of Documents. */
6634
+ list(request?: {
5875
6635
  /** V1 error format. */
5876
6636
  '$.xgafv'?: string;
5877
6637
  /** OAuth access token. */
@@ -5886,7 +6646,11 @@ declare namespace gapi.client {
5886
6646
  key?: string;
5887
6647
  /** OAuth 2.0 token for the current user. */
5888
6648
  oauth_token?: string;
5889
- /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
6649
+ /** Maximum number of Documents to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 are set to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned. */
6650
+ pageSize?: number;
6651
+ /** A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned. */
6652
+ pageToken?: string;
6653
+ /** Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a `PERMISSION_DENIED` error is returned. */
5890
6654
  parent: string;
5891
6655
  /** Returns response with indentations and line breaks. */
5892
6656
  prettyPrint?: boolean;
@@ -5896,15 +6660,48 @@ declare namespace gapi.client {
5896
6660
  upload_protocol?: string;
5897
6661
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5898
6662
  uploadType?: string;
6663
+ }): Request<GoogleCloudDiscoveryengineV1ListDocumentsResponse>;
6664
+ /** Updates a Document. */
6665
+ patch(request: {
6666
+ /** V1 error format. */
6667
+ '$.xgafv'?: string;
6668
+ /** OAuth access token. */
6669
+ access_token?: string;
6670
+ /** If set to `true` and the Document is not found, a new Document is be created. */
6671
+ allowMissing?: boolean;
6672
+ /** Data format for response. */
6673
+ alt?: string;
6674
+ /** JSONP */
6675
+ callback?: string;
6676
+ /** Selector specifying which fields to include in a partial response. */
6677
+ fields?: string;
6678
+ /** 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. */
6679
+ key?: string;
6680
+ /** Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
6681
+ name: string;
6682
+ /** OAuth 2.0 token for the current user. */
6683
+ oauth_token?: string;
6684
+ /** Returns response with indentations and line breaks. */
6685
+ prettyPrint?: boolean;
6686
+ /** 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. */
6687
+ quotaUser?: string;
6688
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
6689
+ updateMask?: string;
6690
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6691
+ upload_protocol?: string;
6692
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6693
+ uploadType?: string;
5899
6694
  /** Request body */
5900
- resource: GoogleCloudDiscoveryengineV1Conversation;
5901
- }): Request<GoogleCloudDiscoveryengineV1Conversation>;
5902
- create(
6695
+ resource: GoogleCloudDiscoveryengineV1Document;
6696
+ }): Request<GoogleCloudDiscoveryengineV1Document>;
6697
+ patch(
5903
6698
  request: {
5904
6699
  /** V1 error format. */
5905
6700
  '$.xgafv'?: string;
5906
6701
  /** OAuth access token. */
5907
6702
  access_token?: string;
6703
+ /** If set to `true` and the Document is not found, a new Document is be created. */
6704
+ allowMissing?: boolean;
5908
6705
  /** Data format for response. */
5909
6706
  alt?: string;
5910
6707
  /** JSONP */
@@ -5913,23 +6710,25 @@ declare namespace gapi.client {
5913
6710
  fields?: string;
5914
6711
  /** 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. */
5915
6712
  key?: string;
6713
+ /** Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
6714
+ name: string;
5916
6715
  /** OAuth 2.0 token for the current user. */
5917
6716
  oauth_token?: string;
5918
- /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
5919
- parent: string;
5920
6717
  /** Returns response with indentations and line breaks. */
5921
6718
  prettyPrint?: boolean;
5922
6719
  /** 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. */
5923
6720
  quotaUser?: string;
6721
+ /** Indicates which fields in the provided imported 'document' to update. If not set, by default updates all fields. */
6722
+ updateMask?: string;
5924
6723
  /** Upload protocol for media (e.g. "raw", "multipart"). */
5925
6724
  upload_protocol?: string;
5926
6725
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5927
6726
  uploadType?: string;
5928
6727
  },
5929
- body: GoogleCloudDiscoveryengineV1Conversation
5930
- ): Request<GoogleCloudDiscoveryengineV1Conversation>;
5931
- /** Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. */
5932
- delete(request?: {
6728
+ body: GoogleCloudDiscoveryengineV1Document
6729
+ ): Request<GoogleCloudDiscoveryengineV1Document>;
6730
+ /** Permanently deletes all selected Documents in a branch. This process is asynchronous. Depending on the number of Documents to be deleted, this operation can take hours to complete. Before the delete operation completes, some Documents might still be returned by DocumentService.GetDocument or DocumentService.ListDocuments. To get a list of the Documents to be deleted, set PurgeDocumentsRequest.force to false. */
6731
+ purge(request: {
5933
6732
  /** V1 error format. */
5934
6733
  '$.xgafv'?: string;
5935
6734
  /** OAuth access token. */
@@ -5942,10 +6741,10 @@ declare namespace gapi.client {
5942
6741
  fields?: string;
5943
6742
  /** 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. */
5944
6743
  key?: string;
5945
- /** Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
5946
- name: string;
5947
6744
  /** OAuth 2.0 token for the current user. */
5948
6745
  oauth_token?: string;
6746
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
6747
+ parent: string;
5949
6748
  /** Returns response with indentations and line breaks. */
5950
6749
  prettyPrint?: boolean;
5951
6750
  /** 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. */
@@ -5954,9 +6753,42 @@ declare namespace gapi.client {
5954
6753
  upload_protocol?: string;
5955
6754
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5956
6755
  uploadType?: string;
5957
- }): Request<{}>;
5958
- /** Gets a Conversation. */
5959
- get(request?: {
6756
+ /** Request body */
6757
+ resource: GoogleCloudDiscoveryengineV1PurgeDocumentsRequest;
6758
+ }): Request<GoogleLongrunningOperation>;
6759
+ purge(
6760
+ request: {
6761
+ /** V1 error format. */
6762
+ '$.xgafv'?: string;
6763
+ /** OAuth access token. */
6764
+ access_token?: string;
6765
+ /** Data format for response. */
6766
+ alt?: string;
6767
+ /** JSONP */
6768
+ callback?: string;
6769
+ /** Selector specifying which fields to include in a partial response. */
6770
+ fields?: string;
6771
+ /** 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. */
6772
+ key?: string;
6773
+ /** OAuth 2.0 token for the current user. */
6774
+ oauth_token?: string;
6775
+ /** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
6776
+ parent: string;
6777
+ /** Returns response with indentations and line breaks. */
6778
+ prettyPrint?: boolean;
6779
+ /** 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. */
6780
+ quotaUser?: string;
6781
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6782
+ upload_protocol?: string;
6783
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6784
+ uploadType?: string;
6785
+ },
6786
+ body: GoogleCloudDiscoveryengineV1PurgeDocumentsRequest
6787
+ ): Request<GoogleLongrunningOperation>;
6788
+ }
6789
+ interface OperationsResource {
6790
+ /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */
6791
+ cancel(request: {
5960
6792
  /** V1 error format. */
5961
6793
  '$.xgafv'?: string;
5962
6794
  /** OAuth access token. */
@@ -5969,7 +6801,7 @@ declare namespace gapi.client {
5969
6801
  fields?: string;
5970
6802
  /** 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. */
5971
6803
  key?: string;
5972
- /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
6804
+ /** The name of the operation resource to be cancelled. */
5973
6805
  name: string;
5974
6806
  /** OAuth 2.0 token for the current user. */
5975
6807
  oauth_token?: string;
@@ -5981,33 +6813,89 @@ declare namespace gapi.client {
5981
6813
  upload_protocol?: string;
5982
6814
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
5983
6815
  uploadType?: string;
5984
- }): Request<GoogleCloudDiscoveryengineV1Conversation>;
5985
- /** Lists all Conversations by their parent DataStore. */
5986
- list(request?: {
5987
- /** V1 error format. */
5988
- '$.xgafv'?: string;
5989
- /** OAuth access token. */
5990
- access_token?: string;
5991
- /** Data format for response. */
5992
- alt?: string;
5993
- /** JSONP */
5994
- callback?: string;
5995
- /** Selector specifying which fields to include in a partial response. */
5996
- fields?: string;
5997
- /** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
6816
+ /** Request body */
6817
+ resource: GoogleLongrunningCancelOperationRequest;
6818
+ }): Request<{}>;
6819
+ cancel(
6820
+ request: {
6821
+ /** V1 error format. */
6822
+ '$.xgafv'?: string;
6823
+ /** OAuth access token. */
6824
+ access_token?: string;
6825
+ /** Data format for response. */
6826
+ alt?: string;
6827
+ /** JSONP */
6828
+ callback?: string;
6829
+ /** Selector specifying which fields to include in a partial response. */
6830
+ fields?: string;
6831
+ /** 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. */
6832
+ key?: string;
6833
+ /** The name of the operation resource to be cancelled. */
6834
+ name: string;
6835
+ /** OAuth 2.0 token for the current user. */
6836
+ oauth_token?: string;
6837
+ /** Returns response with indentations and line breaks. */
6838
+ prettyPrint?: boolean;
6839
+ /** 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. */
6840
+ quotaUser?: string;
6841
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6842
+ upload_protocol?: string;
6843
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6844
+ uploadType?: string;
6845
+ },
6846
+ body: GoogleLongrunningCancelOperationRequest
6847
+ ): Request<{}>;
6848
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
6849
+ get(request?: {
6850
+ /** V1 error format. */
6851
+ '$.xgafv'?: string;
6852
+ /** OAuth access token. */
6853
+ access_token?: string;
6854
+ /** Data format for response. */
6855
+ alt?: string;
6856
+ /** JSONP */
6857
+ callback?: string;
6858
+ /** Selector specifying which fields to include in a partial response. */
6859
+ fields?: string;
6860
+ /** 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. */
6861
+ key?: string;
6862
+ /** The name of the operation resource. */
6863
+ name: string;
6864
+ /** OAuth 2.0 token for the current user. */
6865
+ oauth_token?: string;
6866
+ /** Returns response with indentations and line breaks. */
6867
+ prettyPrint?: boolean;
6868
+ /** 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. */
6869
+ quotaUser?: string;
6870
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
6871
+ upload_protocol?: string;
6872
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6873
+ uploadType?: string;
6874
+ }): Request<GoogleLongrunningOperation>;
6875
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
6876
+ list(request?: {
6877
+ /** V1 error format. */
6878
+ '$.xgafv'?: string;
6879
+ /** OAuth access token. */
6880
+ access_token?: string;
6881
+ /** Data format for response. */
6882
+ alt?: string;
6883
+ /** JSONP */
6884
+ callback?: string;
6885
+ /** Selector specifying which fields to include in a partial response. */
6886
+ fields?: string;
6887
+ /** The standard list filter. */
5998
6888
  filter?: string;
5999
6889
  /** 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. */
6000
6890
  key?: string;
6891
+ /** The name of the operation's parent resource. */
6892
+ name: string;
6001
6893
  /** OAuth 2.0 token for the current user. */
6002
6894
  oauth_token?: string;
6003
- /** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" */
6004
- orderBy?: string;
6005
- /** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
6895
+ /** The standard list page size. */
6006
6896
  pageSize?: number;
6007
- /** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
6897
+ /** The standard list page token. */
6008
6898
  pageToken?: string;
6009
- /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
6010
- parent: string;
6011
6899
  /** Returns response with indentations and line breaks. */
6012
6900
  prettyPrint?: boolean;
6013
6901
  /** 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. */
@@ -6016,9 +6904,15 @@ declare namespace gapi.client {
6016
6904
  upload_protocol?: string;
6017
6905
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6018
6906
  uploadType?: string;
6019
- }): Request<GoogleCloudDiscoveryengineV1ListConversationsResponse>;
6020
- /** Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. */
6021
- patch(request: {
6907
+ }): Request<GoogleLongrunningListOperationsResponse>;
6908
+ }
6909
+ interface BranchesResource {
6910
+ documents: DocumentsResource;
6911
+ operations: OperationsResource;
6912
+ }
6913
+ interface ConversationsResource {
6914
+ /** Converses a conversation. */
6915
+ converse(request: {
6022
6916
  /** V1 error format. */
6023
6917
  '$.xgafv'?: string;
6024
6918
  /** OAuth access token. */
@@ -6031,7 +6925,7 @@ declare namespace gapi.client {
6031
6925
  fields?: string;
6032
6926
  /** 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. */
6033
6927
  key?: string;
6034
- /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
6928
+ /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
6035
6929
  name: string;
6036
6930
  /** OAuth 2.0 token for the current user. */
6037
6931
  oauth_token?: string;
@@ -6039,16 +6933,14 @@ declare namespace gapi.client {
6039
6933
  prettyPrint?: boolean;
6040
6934
  /** 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. */
6041
6935
  quotaUser?: string;
6042
- /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */
6043
- updateMask?: string;
6044
6936
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6045
6937
  upload_protocol?: string;
6046
6938
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6047
6939
  uploadType?: string;
6048
6940
  /** Request body */
6049
- resource: GoogleCloudDiscoveryengineV1Conversation;
6050
- }): Request<GoogleCloudDiscoveryengineV1Conversation>;
6051
- patch(
6941
+ resource: GoogleCloudDiscoveryengineV1ConverseConversationRequest;
6942
+ }): Request<GoogleCloudDiscoveryengineV1ConverseConversationResponse>;
6943
+ converse(
6052
6944
  request: {
6053
6945
  /** V1 error format. */
6054
6946
  '$.xgafv'?: string;
@@ -6062,7 +6954,7 @@ declare namespace gapi.client {
6062
6954
  fields?: string;
6063
6955
  /** 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. */
6064
6956
  key?: string;
6065
- /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
6957
+ /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. */
6066
6958
  name: string;
6067
6959
  /** OAuth 2.0 token for the current user. */
6068
6960
  oauth_token?: string;
@@ -6070,19 +6962,15 @@ declare namespace gapi.client {
6070
6962
  prettyPrint?: boolean;
6071
6963
  /** 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. */
6072
6964
  quotaUser?: string;
6073
- /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */
6074
- updateMask?: string;
6075
6965
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6076
6966
  upload_protocol?: string;
6077
6967
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6078
6968
  uploadType?: string;
6079
6969
  },
6080
- body: GoogleCloudDiscoveryengineV1Conversation
6081
- ): Request<GoogleCloudDiscoveryengineV1Conversation>;
6082
- }
6083
- interface OperationsResource {
6084
- /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
6085
- get(request?: {
6970
+ body: GoogleCloudDiscoveryengineV1ConverseConversationRequest
6971
+ ): Request<GoogleCloudDiscoveryengineV1ConverseConversationResponse>;
6972
+ /** Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned. */
6973
+ create(request: {
6086
6974
  /** V1 error format. */
6087
6975
  '$.xgafv'?: string;
6088
6976
  /** OAuth access token. */
@@ -6095,10 +6983,10 @@ declare namespace gapi.client {
6095
6983
  fields?: string;
6096
6984
  /** 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. */
6097
6985
  key?: string;
6098
- /** The name of the operation resource. */
6099
- name: string;
6100
6986
  /** OAuth 2.0 token for the current user. */
6101
6987
  oauth_token?: string;
6988
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
6989
+ parent: string;
6102
6990
  /** Returns response with indentations and line breaks. */
6103
6991
  prettyPrint?: boolean;
6104
6992
  /** 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. */
@@ -6107,9 +6995,40 @@ declare namespace gapi.client {
6107
6995
  upload_protocol?: string;
6108
6996
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6109
6997
  uploadType?: string;
6110
- }): Request<GoogleLongrunningOperation>;
6111
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
6112
- list(request?: {
6998
+ /** Request body */
6999
+ resource: GoogleCloudDiscoveryengineV1Conversation;
7000
+ }): Request<GoogleCloudDiscoveryengineV1Conversation>;
7001
+ create(
7002
+ request: {
7003
+ /** V1 error format. */
7004
+ '$.xgafv'?: string;
7005
+ /** OAuth access token. */
7006
+ access_token?: string;
7007
+ /** Data format for response. */
7008
+ alt?: string;
7009
+ /** JSONP */
7010
+ callback?: string;
7011
+ /** Selector specifying which fields to include in a partial response. */
7012
+ fields?: string;
7013
+ /** 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. */
7014
+ key?: string;
7015
+ /** OAuth 2.0 token for the current user. */
7016
+ oauth_token?: string;
7017
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
7018
+ parent: string;
7019
+ /** Returns response with indentations and line breaks. */
7020
+ prettyPrint?: boolean;
7021
+ /** 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. */
7022
+ quotaUser?: string;
7023
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7024
+ upload_protocol?: string;
7025
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7026
+ uploadType?: string;
7027
+ },
7028
+ body: GoogleCloudDiscoveryengineV1Conversation
7029
+ ): Request<GoogleCloudDiscoveryengineV1Conversation>;
7030
+ /** Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned. */
7031
+ delete(request?: {
6113
7032
  /** V1 error format. */
6114
7033
  '$.xgafv'?: string;
6115
7034
  /** OAuth access token. */
@@ -6120,18 +7039,12 @@ declare namespace gapi.client {
6120
7039
  callback?: string;
6121
7040
  /** Selector specifying which fields to include in a partial response. */
6122
7041
  fields?: string;
6123
- /** The standard list filter. */
6124
- filter?: string;
6125
7042
  /** 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. */
6126
7043
  key?: string;
6127
- /** The name of the operation's parent resource. */
7044
+ /** Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
6128
7045
  name: string;
6129
7046
  /** OAuth 2.0 token for the current user. */
6130
7047
  oauth_token?: string;
6131
- /** The standard list page size. */
6132
- pageSize?: number;
6133
- /** The standard list page token. */
6134
- pageToken?: string;
6135
7048
  /** Returns response with indentations and line breaks. */
6136
7049
  prettyPrint?: boolean;
6137
7050
  /** 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. */
@@ -6140,13 +7053,8 @@ declare namespace gapi.client {
6140
7053
  upload_protocol?: string;
6141
7054
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6142
7055
  uploadType?: string;
6143
- }): Request<GoogleLongrunningListOperationsResponse>;
6144
- }
6145
- interface ModelsResource {
6146
- operations: OperationsResource;
6147
- }
6148
- interface OperationsResource {
6149
- /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
7056
+ }): Request<{}>;
7057
+ /** Gets a Conversation. */
6150
7058
  get(request?: {
6151
7059
  /** V1 error format. */
6152
7060
  '$.xgafv'?: string;
@@ -6160,7 +7068,7 @@ declare namespace gapi.client {
6160
7068
  fields?: string;
6161
7069
  /** 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. */
6162
7070
  key?: string;
6163
- /** The name of the operation resource. */
7071
+ /** Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` */
6164
7072
  name: string;
6165
7073
  /** OAuth 2.0 token for the current user. */
6166
7074
  oauth_token?: string;
@@ -6172,8 +7080,8 @@ declare namespace gapi.client {
6172
7080
  upload_protocol?: string;
6173
7081
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6174
7082
  uploadType?: string;
6175
- }): Request<GoogleLongrunningOperation>;
6176
- /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
7083
+ }): Request<GoogleCloudDiscoveryengineV1Conversation>;
7084
+ /** Lists all Conversations by their parent DataStore. */
6177
7085
  list(request?: {
6178
7086
  /** V1 error format. */
6179
7087
  '$.xgafv'?: string;
@@ -6185,18 +7093,20 @@ declare namespace gapi.client {
6185
7093
  callback?: string;
6186
7094
  /** Selector specifying which fields to include in a partial response. */
6187
7095
  fields?: string;
6188
- /** The standard list filter. */
7096
+ /** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
6189
7097
  filter?: string;
6190
7098
  /** 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. */
6191
7099
  key?: string;
6192
- /** The name of the operation's parent resource. */
6193
- name: string;
6194
7100
  /** OAuth 2.0 token for the current user. */
6195
7101
  oauth_token?: string;
6196
- /** The standard list page size. */
7102
+ /** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time" */
7103
+ orderBy?: string;
7104
+ /** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
6197
7105
  pageSize?: number;
6198
- /** The standard list page token. */
7106
+ /** A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page. */
6199
7107
  pageToken?: string;
7108
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
7109
+ parent: string;
6200
7110
  /** Returns response with indentations and line breaks. */
6201
7111
  prettyPrint?: boolean;
6202
7112
  /** 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. */
@@ -6205,11 +7115,9 @@ declare namespace gapi.client {
6205
7115
  upload_protocol?: string;
6206
7116
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6207
7117
  uploadType?: string;
6208
- }): Request<GoogleLongrunningListOperationsResponse>;
6209
- }
6210
- interface SchemasResource {
6211
- /** Creates a Schema. */
6212
- create(request: {
7118
+ }): Request<GoogleCloudDiscoveryengineV1ListConversationsResponse>;
7119
+ /** Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned. */
7120
+ patch(request: {
6213
7121
  /** V1 error format. */
6214
7122
  '$.xgafv'?: string;
6215
7123
  /** OAuth access token. */
@@ -6222,24 +7130,24 @@ declare namespace gapi.client {
6222
7130
  fields?: string;
6223
7131
  /** 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. */
6224
7132
  key?: string;
7133
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
7134
+ name: string;
6225
7135
  /** OAuth 2.0 token for the current user. */
6226
7136
  oauth_token?: string;
6227
- /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
6228
- parent: string;
6229
7137
  /** Returns response with indentations and line breaks. */
6230
7138
  prettyPrint?: boolean;
6231
7139
  /** 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. */
6232
7140
  quotaUser?: string;
6233
- /** Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
6234
- schemaId?: string;
7141
+ /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */
7142
+ updateMask?: string;
6235
7143
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6236
7144
  upload_protocol?: string;
6237
7145
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6238
7146
  uploadType?: string;
6239
7147
  /** Request body */
6240
- resource: GoogleCloudDiscoveryengineV1Schema;
6241
- }): Request<GoogleLongrunningOperation>;
6242
- create(
7148
+ resource: GoogleCloudDiscoveryengineV1Conversation;
7149
+ }): Request<GoogleCloudDiscoveryengineV1Conversation>;
7150
+ patch(
6243
7151
  request: {
6244
7152
  /** V1 error format. */
6245
7153
  '$.xgafv'?: string;
@@ -6253,25 +7161,27 @@ declare namespace gapi.client {
6253
7161
  fields?: string;
6254
7162
  /** 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. */
6255
7163
  key?: string;
7164
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/dataStore/*‍/conversations/*` or `projects/{project}/locations/global/collections/{collection}/engines/*‍/conversations/*`. */
7165
+ name: string;
6256
7166
  /** OAuth 2.0 token for the current user. */
6257
7167
  oauth_token?: string;
6258
- /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
6259
- parent: string;
6260
7168
  /** Returns response with indentations and line breaks. */
6261
7169
  prettyPrint?: boolean;
6262
7170
  /** 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. */
6263
7171
  quotaUser?: string;
6264
- /** Required. The ID to use for the Schema, which will become the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
6265
- schemaId?: string;
7172
+ /** Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated. */
7173
+ updateMask?: string;
6266
7174
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6267
7175
  upload_protocol?: string;
6268
7176
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6269
7177
  uploadType?: string;
6270
7178
  },
6271
- body: GoogleCloudDiscoveryengineV1Schema
6272
- ): Request<GoogleLongrunningOperation>;
6273
- /** Deletes a Schema. */
6274
- delete(request?: {
7179
+ body: GoogleCloudDiscoveryengineV1Conversation
7180
+ ): Request<GoogleCloudDiscoveryengineV1Conversation>;
7181
+ }
7182
+ interface OperationsResource {
7183
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
7184
+ get(request?: {
6275
7185
  /** V1 error format. */
6276
7186
  '$.xgafv'?: string;
6277
7187
  /** OAuth access token. */
@@ -6284,7 +7194,7 @@ declare namespace gapi.client {
6284
7194
  fields?: string;
6285
7195
  /** 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. */
6286
7196
  key?: string;
6287
- /** Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. */
7197
+ /** The name of the operation resource. */
6288
7198
  name: string;
6289
7199
  /** OAuth 2.0 token for the current user. */
6290
7200
  oauth_token?: string;
@@ -6297,8 +7207,8 @@ declare namespace gapi.client {
6297
7207
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6298
7208
  uploadType?: string;
6299
7209
  }): Request<GoogleLongrunningOperation>;
6300
- /** Gets a Schema. */
6301
- get(request?: {
7210
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
7211
+ list(request?: {
6302
7212
  /** V1 error format. */
6303
7213
  '$.xgafv'?: string;
6304
7214
  /** OAuth access token. */
@@ -6309,12 +7219,18 @@ declare namespace gapi.client {
6309
7219
  callback?: string;
6310
7220
  /** Selector specifying which fields to include in a partial response. */
6311
7221
  fields?: string;
7222
+ /** The standard list filter. */
7223
+ filter?: string;
6312
7224
  /** 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. */
6313
7225
  key?: string;
6314
- /** Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. */
7226
+ /** The name of the operation's parent resource. */
6315
7227
  name: string;
6316
7228
  /** OAuth 2.0 token for the current user. */
6317
7229
  oauth_token?: string;
7230
+ /** The standard list page size. */
7231
+ pageSize?: number;
7232
+ /** The standard list page token. */
7233
+ pageToken?: string;
6318
7234
  /** Returns response with indentations and line breaks. */
6319
7235
  prettyPrint?: boolean;
6320
7236
  /** 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. */
@@ -6323,9 +7239,550 @@ declare namespace gapi.client {
6323
7239
  upload_protocol?: string;
6324
7240
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6325
7241
  uploadType?: string;
6326
- }): Request<GoogleCloudDiscoveryengineV1Schema>;
6327
- /** Gets a list of Schemas. */
6328
- list(request?: {
7242
+ }): Request<GoogleLongrunningListOperationsResponse>;
7243
+ }
7244
+ interface ModelsResource {
7245
+ operations: OperationsResource;
7246
+ }
7247
+ interface OperationsResource {
7248
+ /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
7249
+ get(request?: {
7250
+ /** V1 error format. */
7251
+ '$.xgafv'?: string;
7252
+ /** OAuth access token. */
7253
+ access_token?: string;
7254
+ /** Data format for response. */
7255
+ alt?: string;
7256
+ /** JSONP */
7257
+ callback?: string;
7258
+ /** Selector specifying which fields to include in a partial response. */
7259
+ fields?: string;
7260
+ /** 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. */
7261
+ key?: string;
7262
+ /** The name of the operation resource. */
7263
+ name: string;
7264
+ /** OAuth 2.0 token for the current user. */
7265
+ oauth_token?: string;
7266
+ /** Returns response with indentations and line breaks. */
7267
+ prettyPrint?: boolean;
7268
+ /** 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. */
7269
+ quotaUser?: string;
7270
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7271
+ upload_protocol?: string;
7272
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7273
+ uploadType?: string;
7274
+ }): Request<GoogleLongrunningOperation>;
7275
+ /** Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. */
7276
+ list(request?: {
7277
+ /** V1 error format. */
7278
+ '$.xgafv'?: string;
7279
+ /** OAuth access token. */
7280
+ access_token?: string;
7281
+ /** Data format for response. */
7282
+ alt?: string;
7283
+ /** JSONP */
7284
+ callback?: string;
7285
+ /** Selector specifying which fields to include in a partial response. */
7286
+ fields?: string;
7287
+ /** The standard list filter. */
7288
+ filter?: string;
7289
+ /** 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. */
7290
+ key?: string;
7291
+ /** The name of the operation's parent resource. */
7292
+ name: string;
7293
+ /** OAuth 2.0 token for the current user. */
7294
+ oauth_token?: string;
7295
+ /** The standard list page size. */
7296
+ pageSize?: number;
7297
+ /** The standard list page token. */
7298
+ pageToken?: string;
7299
+ /** Returns response with indentations and line breaks. */
7300
+ prettyPrint?: boolean;
7301
+ /** 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. */
7302
+ quotaUser?: string;
7303
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7304
+ upload_protocol?: string;
7305
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7306
+ uploadType?: string;
7307
+ }): Request<GoogleLongrunningListOperationsResponse>;
7308
+ }
7309
+ interface SchemasResource {
7310
+ /** Creates a Schema. */
7311
+ create(request: {
7312
+ /** V1 error format. */
7313
+ '$.xgafv'?: string;
7314
+ /** OAuth access token. */
7315
+ access_token?: string;
7316
+ /** Data format for response. */
7317
+ alt?: string;
7318
+ /** JSONP */
7319
+ callback?: string;
7320
+ /** Selector specifying which fields to include in a partial response. */
7321
+ fields?: string;
7322
+ /** 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. */
7323
+ key?: string;
7324
+ /** OAuth 2.0 token for the current user. */
7325
+ oauth_token?: string;
7326
+ /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
7327
+ parent: string;
7328
+ /** Returns response with indentations and line breaks. */
7329
+ prettyPrint?: boolean;
7330
+ /** 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. */
7331
+ quotaUser?: string;
7332
+ /** Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
7333
+ schemaId?: string;
7334
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7335
+ upload_protocol?: string;
7336
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7337
+ uploadType?: string;
7338
+ /** Request body */
7339
+ resource: GoogleCloudDiscoveryengineV1Schema;
7340
+ }): Request<GoogleLongrunningOperation>;
7341
+ create(
7342
+ request: {
7343
+ /** V1 error format. */
7344
+ '$.xgafv'?: string;
7345
+ /** OAuth access token. */
7346
+ access_token?: string;
7347
+ /** Data format for response. */
7348
+ alt?: string;
7349
+ /** JSONP */
7350
+ callback?: string;
7351
+ /** Selector specifying which fields to include in a partial response. */
7352
+ fields?: string;
7353
+ /** 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. */
7354
+ key?: string;
7355
+ /** OAuth 2.0 token for the current user. */
7356
+ oauth_token?: string;
7357
+ /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
7358
+ parent: string;
7359
+ /** Returns response with indentations and line breaks. */
7360
+ prettyPrint?: boolean;
7361
+ /** 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. */
7362
+ quotaUser?: string;
7363
+ /** Required. The ID to use for the Schema, which becomes the final component of the Schema.name. This field should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters. */
7364
+ schemaId?: string;
7365
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7366
+ upload_protocol?: string;
7367
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7368
+ uploadType?: string;
7369
+ },
7370
+ body: GoogleCloudDiscoveryengineV1Schema
7371
+ ): Request<GoogleLongrunningOperation>;
7372
+ /** Deletes a Schema. */
7373
+ delete(request?: {
7374
+ /** V1 error format. */
7375
+ '$.xgafv'?: string;
7376
+ /** OAuth access token. */
7377
+ access_token?: string;
7378
+ /** Data format for response. */
7379
+ alt?: string;
7380
+ /** JSONP */
7381
+ callback?: string;
7382
+ /** Selector specifying which fields to include in a partial response. */
7383
+ fields?: string;
7384
+ /** 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. */
7385
+ key?: string;
7386
+ /** Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. */
7387
+ name: string;
7388
+ /** OAuth 2.0 token for the current user. */
7389
+ oauth_token?: string;
7390
+ /** Returns response with indentations and line breaks. */
7391
+ prettyPrint?: boolean;
7392
+ /** 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. */
7393
+ quotaUser?: string;
7394
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7395
+ upload_protocol?: string;
7396
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7397
+ uploadType?: string;
7398
+ }): Request<GoogleLongrunningOperation>;
7399
+ /** Gets a Schema. */
7400
+ get(request?: {
7401
+ /** V1 error format. */
7402
+ '$.xgafv'?: string;
7403
+ /** OAuth access token. */
7404
+ access_token?: string;
7405
+ /** Data format for response. */
7406
+ alt?: string;
7407
+ /** JSONP */
7408
+ callback?: string;
7409
+ /** Selector specifying which fields to include in a partial response. */
7410
+ fields?: string;
7411
+ /** 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. */
7412
+ key?: string;
7413
+ /** Required. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. */
7414
+ name: string;
7415
+ /** OAuth 2.0 token for the current user. */
7416
+ oauth_token?: string;
7417
+ /** Returns response with indentations and line breaks. */
7418
+ prettyPrint?: boolean;
7419
+ /** 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. */
7420
+ quotaUser?: string;
7421
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7422
+ upload_protocol?: string;
7423
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7424
+ uploadType?: string;
7425
+ }): Request<GoogleCloudDiscoveryengineV1Schema>;
7426
+ /** Gets a list of Schemas. */
7427
+ list(request?: {
7428
+ /** V1 error format. */
7429
+ '$.xgafv'?: string;
7430
+ /** OAuth access token. */
7431
+ access_token?: string;
7432
+ /** Data format for response. */
7433
+ alt?: string;
7434
+ /** JSONP */
7435
+ callback?: string;
7436
+ /** Selector specifying which fields to include in a partial response. */
7437
+ fields?: string;
7438
+ /** 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. */
7439
+ key?: string;
7440
+ /** OAuth 2.0 token for the current user. */
7441
+ oauth_token?: string;
7442
+ /** The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000. */
7443
+ pageSize?: number;
7444
+ /** A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. */
7445
+ pageToken?: string;
7446
+ /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
7447
+ parent: string;
7448
+ /** Returns response with indentations and line breaks. */
7449
+ prettyPrint?: boolean;
7450
+ /** 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. */
7451
+ quotaUser?: string;
7452
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7453
+ upload_protocol?: string;
7454
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7455
+ uploadType?: string;
7456
+ }): Request<GoogleCloudDiscoveryengineV1ListSchemasResponse>;
7457
+ /** Updates a Schema. */
7458
+ patch(request: {
7459
+ /** V1 error format. */
7460
+ '$.xgafv'?: string;
7461
+ /** OAuth access token. */
7462
+ access_token?: string;
7463
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
7464
+ allowMissing?: boolean;
7465
+ /** Data format for response. */
7466
+ alt?: string;
7467
+ /** JSONP */
7468
+ callback?: string;
7469
+ /** Selector specifying which fields to include in a partial response. */
7470
+ fields?: string;
7471
+ /** 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. */
7472
+ key?: string;
7473
+ /** Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
7474
+ name: string;
7475
+ /** OAuth 2.0 token for the current user. */
7476
+ oauth_token?: string;
7477
+ /** Returns response with indentations and line breaks. */
7478
+ prettyPrint?: boolean;
7479
+ /** 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. */
7480
+ quotaUser?: string;
7481
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7482
+ upload_protocol?: string;
7483
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7484
+ uploadType?: string;
7485
+ /** Request body */
7486
+ resource: GoogleCloudDiscoveryengineV1Schema;
7487
+ }): Request<GoogleLongrunningOperation>;
7488
+ patch(
7489
+ request: {
7490
+ /** V1 error format. */
7491
+ '$.xgafv'?: string;
7492
+ /** OAuth access token. */
7493
+ access_token?: string;
7494
+ /** If set to true, and the Schema is not found, a new Schema is created. In this situation, `update_mask` is ignored. */
7495
+ allowMissing?: boolean;
7496
+ /** Data format for response. */
7497
+ alt?: string;
7498
+ /** JSONP */
7499
+ callback?: string;
7500
+ /** Selector specifying which fields to include in a partial response. */
7501
+ fields?: string;
7502
+ /** 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. */
7503
+ key?: string;
7504
+ /** Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
7505
+ name: string;
7506
+ /** OAuth 2.0 token for the current user. */
7507
+ oauth_token?: string;
7508
+ /** Returns response with indentations and line breaks. */
7509
+ prettyPrint?: boolean;
7510
+ /** 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. */
7511
+ quotaUser?: string;
7512
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7513
+ upload_protocol?: string;
7514
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7515
+ uploadType?: string;
7516
+ },
7517
+ body: GoogleCloudDiscoveryengineV1Schema
7518
+ ): Request<GoogleLongrunningOperation>;
7519
+ }
7520
+ interface ServingConfigsResource {
7521
+ /** Answer query method. */
7522
+ answer(request: {
7523
+ /** V1 error format. */
7524
+ '$.xgafv'?: string;
7525
+ /** OAuth access token. */
7526
+ access_token?: string;
7527
+ /** Data format for response. */
7528
+ alt?: string;
7529
+ /** JSONP */
7530
+ callback?: string;
7531
+ /** Selector specifying which fields to include in a partial response. */
7532
+ fields?: string;
7533
+ /** 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. */
7534
+ key?: string;
7535
+ /** OAuth 2.0 token for the current user. */
7536
+ oauth_token?: string;
7537
+ /** Returns response with indentations and line breaks. */
7538
+ prettyPrint?: boolean;
7539
+ /** 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. */
7540
+ quotaUser?: string;
7541
+ /** 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/*‍/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
7542
+ servingConfig: string;
7543
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7544
+ upload_protocol?: string;
7545
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7546
+ uploadType?: string;
7547
+ /** Request body */
7548
+ resource: GoogleCloudDiscoveryengineV1AnswerQueryRequest;
7549
+ }): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
7550
+ answer(
7551
+ request: {
7552
+ /** V1 error format. */
7553
+ '$.xgafv'?: string;
7554
+ /** OAuth access token. */
7555
+ access_token?: string;
7556
+ /** Data format for response. */
7557
+ alt?: string;
7558
+ /** JSONP */
7559
+ callback?: string;
7560
+ /** Selector specifying which fields to include in a partial response. */
7561
+ fields?: string;
7562
+ /** 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. */
7563
+ key?: string;
7564
+ /** OAuth 2.0 token for the current user. */
7565
+ oauth_token?: string;
7566
+ /** Returns response with indentations and line breaks. */
7567
+ prettyPrint?: boolean;
7568
+ /** 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. */
7569
+ quotaUser?: string;
7570
+ /** 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/*‍/servingConfigs/default_serving_config`. This field is used to identify the serving configuration name, set of models used to make the search. */
7571
+ servingConfig: string;
7572
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7573
+ upload_protocol?: string;
7574
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7575
+ uploadType?: string;
7576
+ },
7577
+ body: GoogleCloudDiscoveryengineV1AnswerQueryRequest
7578
+ ): Request<GoogleCloudDiscoveryengineV1AnswerQueryResponse>;
7579
+ /** Makes a recommendation, which requires a contextual user event. */
7580
+ recommend(request: {
7581
+ /** V1 error format. */
7582
+ '$.xgafv'?: string;
7583
+ /** OAuth access token. */
7584
+ access_token?: string;
7585
+ /** Data format for response. */
7586
+ alt?: string;
7587
+ /** JSONP */
7588
+ callback?: string;
7589
+ /** Selector specifying which fields to include in a partial response. */
7590
+ fields?: string;
7591
+ /** 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. */
7592
+ key?: string;
7593
+ /** OAuth 2.0 token for the current user. */
7594
+ oauth_token?: string;
7595
+ /** Returns response with indentations and line breaks. */
7596
+ prettyPrint?: boolean;
7597
+ /** 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. */
7598
+ quotaUser?: string;
7599
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
7600
+ servingConfig: string;
7601
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7602
+ upload_protocol?: string;
7603
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7604
+ uploadType?: string;
7605
+ /** Request body */
7606
+ resource: GoogleCloudDiscoveryengineV1RecommendRequest;
7607
+ }): Request<GoogleCloudDiscoveryengineV1RecommendResponse>;
7608
+ recommend(
7609
+ request: {
7610
+ /** V1 error format. */
7611
+ '$.xgafv'?: string;
7612
+ /** OAuth access token. */
7613
+ access_token?: string;
7614
+ /** Data format for response. */
7615
+ alt?: string;
7616
+ /** JSONP */
7617
+ callback?: string;
7618
+ /** Selector specifying which fields to include in a partial response. */
7619
+ fields?: string;
7620
+ /** 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. */
7621
+ key?: string;
7622
+ /** OAuth 2.0 token for the current user. */
7623
+ oauth_token?: string;
7624
+ /** Returns response with indentations and line breaks. */
7625
+ prettyPrint?: boolean;
7626
+ /** 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. */
7627
+ quotaUser?: string;
7628
+ /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID is used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
7629
+ servingConfig: string;
7630
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7631
+ upload_protocol?: string;
7632
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7633
+ uploadType?: string;
7634
+ },
7635
+ body: GoogleCloudDiscoveryengineV1RecommendRequest
7636
+ ): Request<GoogleCloudDiscoveryengineV1RecommendResponse>;
7637
+ /** Performs a search. */
7638
+ search(request: {
7639
+ /** V1 error format. */
7640
+ '$.xgafv'?: string;
7641
+ /** OAuth access token. */
7642
+ access_token?: string;
7643
+ /** Data format for response. */
7644
+ alt?: string;
7645
+ /** JSONP */
7646
+ callback?: string;
7647
+ /** Selector specifying which fields to include in a partial response. */
7648
+ fields?: string;
7649
+ /** 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. */
7650
+ key?: string;
7651
+ /** OAuth 2.0 token for the current user. */
7652
+ oauth_token?: string;
7653
+ /** Returns response with indentations and line breaks. */
7654
+ prettyPrint?: boolean;
7655
+ /** 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. */
7656
+ quotaUser?: string;
7657
+ /** 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. */
7658
+ servingConfig: string;
7659
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7660
+ upload_protocol?: string;
7661
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7662
+ uploadType?: string;
7663
+ /** Request body */
7664
+ resource: GoogleCloudDiscoveryengineV1SearchRequest;
7665
+ }): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
7666
+ search(
7667
+ request: {
7668
+ /** V1 error format. */
7669
+ '$.xgafv'?: string;
7670
+ /** OAuth access token. */
7671
+ access_token?: string;
7672
+ /** Data format for response. */
7673
+ alt?: string;
7674
+ /** JSONP */
7675
+ callback?: string;
7676
+ /** Selector specifying which fields to include in a partial response. */
7677
+ fields?: string;
7678
+ /** 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. */
7679
+ key?: string;
7680
+ /** OAuth 2.0 token for the current user. */
7681
+ oauth_token?: string;
7682
+ /** Returns response with indentations and line breaks. */
7683
+ prettyPrint?: boolean;
7684
+ /** 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. */
7685
+ quotaUser?: string;
7686
+ /** 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. */
7687
+ servingConfig: string;
7688
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7689
+ upload_protocol?: string;
7690
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7691
+ uploadType?: string;
7692
+ },
7693
+ body: GoogleCloudDiscoveryengineV1SearchRequest
7694
+ ): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
7695
+ }
7696
+ interface AnswersResource {
7697
+ /** Gets a Answer. */
7698
+ get(request?: {
7699
+ /** V1 error format. */
7700
+ '$.xgafv'?: string;
7701
+ /** OAuth access token. */
7702
+ access_token?: string;
7703
+ /** Data format for response. */
7704
+ alt?: string;
7705
+ /** JSONP */
7706
+ callback?: string;
7707
+ /** Selector specifying which fields to include in a partial response. */
7708
+ fields?: string;
7709
+ /** 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. */
7710
+ key?: string;
7711
+ /** Required. The resource name of the Answer to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/engines/{engine_id}/sessions/{session_id}/answers/{answer_id}` */
7712
+ name: string;
7713
+ /** OAuth 2.0 token for the current user. */
7714
+ oauth_token?: string;
7715
+ /** Returns response with indentations and line breaks. */
7716
+ prettyPrint?: boolean;
7717
+ /** 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. */
7718
+ quotaUser?: string;
7719
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7720
+ upload_protocol?: string;
7721
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7722
+ uploadType?: string;
7723
+ }): Request<GoogleCloudDiscoveryengineV1Answer>;
7724
+ }
7725
+ interface SessionsResource {
7726
+ /** Creates a Session. If the Session to create already exists, an ALREADY_EXISTS error is returned. */
7727
+ create(request: {
7728
+ /** V1 error format. */
7729
+ '$.xgafv'?: string;
7730
+ /** OAuth access token. */
7731
+ access_token?: string;
7732
+ /** Data format for response. */
7733
+ alt?: string;
7734
+ /** JSONP */
7735
+ callback?: string;
7736
+ /** Selector specifying which fields to include in a partial response. */
7737
+ fields?: string;
7738
+ /** 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. */
7739
+ key?: string;
7740
+ /** OAuth 2.0 token for the current user. */
7741
+ oauth_token?: string;
7742
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
7743
+ parent: string;
7744
+ /** Returns response with indentations and line breaks. */
7745
+ prettyPrint?: boolean;
7746
+ /** 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. */
7747
+ quotaUser?: string;
7748
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7749
+ upload_protocol?: string;
7750
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7751
+ uploadType?: string;
7752
+ /** Request body */
7753
+ resource: GoogleCloudDiscoveryengineV1Session;
7754
+ }): Request<GoogleCloudDiscoveryengineV1Session>;
7755
+ create(
7756
+ request: {
7757
+ /** V1 error format. */
7758
+ '$.xgafv'?: string;
7759
+ /** OAuth access token. */
7760
+ access_token?: string;
7761
+ /** Data format for response. */
7762
+ alt?: string;
7763
+ /** JSONP */
7764
+ callback?: string;
7765
+ /** Selector specifying which fields to include in a partial response. */
7766
+ fields?: string;
7767
+ /** 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. */
7768
+ key?: string;
7769
+ /** OAuth 2.0 token for the current user. */
7770
+ oauth_token?: string;
7771
+ /** Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
7772
+ parent: string;
7773
+ /** Returns response with indentations and line breaks. */
7774
+ prettyPrint?: boolean;
7775
+ /** 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. */
7776
+ quotaUser?: string;
7777
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
7778
+ upload_protocol?: string;
7779
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
7780
+ uploadType?: string;
7781
+ },
7782
+ body: GoogleCloudDiscoveryengineV1Session
7783
+ ): Request<GoogleCloudDiscoveryengineV1Session>;
7784
+ /** Deletes a Session. If the Session to delete does not exist, a NOT_FOUND error is returned. */
7785
+ delete(request?: {
6329
7786
  /** V1 error format. */
6330
7787
  '$.xgafv'?: string;
6331
7788
  /** OAuth access token. */
@@ -6338,14 +7795,10 @@ declare namespace gapi.client {
6338
7795
  fields?: string;
6339
7796
  /** 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. */
6340
7797
  key?: string;
7798
+ /** Required. The resource name of the Session to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
7799
+ name: string;
6341
7800
  /** OAuth 2.0 token for the current user. */
6342
7801
  oauth_token?: string;
6343
- /** The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. */
6344
- pageSize?: number;
6345
- /** A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token. */
6346
- pageToken?: string;
6347
- /** Required. The parent data store resource name, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
6348
- parent: string;
6349
7802
  /** Returns response with indentations and line breaks. */
6350
7803
  prettyPrint?: boolean;
6351
7804
  /** 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. */
@@ -6354,15 +7807,13 @@ declare namespace gapi.client {
6354
7807
  upload_protocol?: string;
6355
7808
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6356
7809
  uploadType?: string;
6357
- }): Request<GoogleCloudDiscoveryengineV1ListSchemasResponse>;
6358
- /** Updates a Schema. */
6359
- patch(request: {
7810
+ }): Request<{}>;
7811
+ /** Gets a Session. */
7812
+ get(request?: {
6360
7813
  /** V1 error format. */
6361
7814
  '$.xgafv'?: string;
6362
7815
  /** OAuth access token. */
6363
7816
  access_token?: string;
6364
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
6365
- allowMissing?: boolean;
6366
7817
  /** Data format for response. */
6367
7818
  alt?: string;
6368
7819
  /** JSONP */
@@ -6371,7 +7822,7 @@ declare namespace gapi.client {
6371
7822
  fields?: string;
6372
7823
  /** 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. */
6373
7824
  key?: string;
6374
- /** Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
7825
+ /** Required. The resource name of the Session to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/sessions/{session_id}` */
6375
7826
  name: string;
6376
7827
  /** OAuth 2.0 token for the current user. */
6377
7828
  oauth_token?: string;
@@ -6383,44 +7834,9 @@ declare namespace gapi.client {
6383
7834
  upload_protocol?: string;
6384
7835
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6385
7836
  uploadType?: string;
6386
- /** Request body */
6387
- resource: GoogleCloudDiscoveryengineV1Schema;
6388
- }): Request<GoogleLongrunningOperation>;
6389
- patch(
6390
- request: {
6391
- /** V1 error format. */
6392
- '$.xgafv'?: string;
6393
- /** OAuth access token. */
6394
- access_token?: string;
6395
- /** If set to true, and the Schema is not found, a new Schema will be created. In this situation, `update_mask` is ignored. */
6396
- allowMissing?: boolean;
6397
- /** Data format for response. */
6398
- alt?: string;
6399
- /** JSONP */
6400
- callback?: string;
6401
- /** Selector specifying which fields to include in a partial response. */
6402
- fields?: string;
6403
- /** 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. */
6404
- key?: string;
6405
- /** Immutable. The full resource name of the schema, in the format of `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters. */
6406
- name: string;
6407
- /** OAuth 2.0 token for the current user. */
6408
- oauth_token?: string;
6409
- /** Returns response with indentations and line breaks. */
6410
- prettyPrint?: boolean;
6411
- /** 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. */
6412
- quotaUser?: string;
6413
- /** Upload protocol for media (e.g. "raw", "multipart"). */
6414
- upload_protocol?: string;
6415
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6416
- uploadType?: string;
6417
- },
6418
- body: GoogleCloudDiscoveryengineV1Schema
6419
- ): Request<GoogleLongrunningOperation>;
6420
- }
6421
- interface ServingConfigsResource {
6422
- /** Makes a recommendation, which requires a contextual user event. */
6423
- recommend(request: {
7837
+ }): Request<GoogleCloudDiscoveryengineV1Session>;
7838
+ /** Lists all Sessions by their parent DataStore. */
7839
+ list(request?: {
6424
7840
  /** V1 error format. */
6425
7841
  '$.xgafv'?: string;
6426
7842
  /** OAuth access token. */
@@ -6431,54 +7847,31 @@ declare namespace gapi.client {
6431
7847
  callback?: string;
6432
7848
  /** Selector specifying which fields to include in a partial response. */
6433
7849
  fields?: string;
7850
+ /** A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id" */
7851
+ filter?: string;
6434
7852
  /** 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. */
6435
7853
  key?: string;
6436
7854
  /** OAuth 2.0 token for the current user. */
6437
7855
  oauth_token?: string;
7856
+ /** A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `session_name` Example: "update_time desc" "create_time" */
7857
+ orderBy?: string;
7858
+ /** Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000. */
7859
+ pageSize?: number;
7860
+ /** A page token, received from a previous `ListSessions` call. Provide this to retrieve the subsequent page. */
7861
+ pageToken?: string;
7862
+ /** Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` */
7863
+ parent: string;
6438
7864
  /** Returns response with indentations and line breaks. */
6439
7865
  prettyPrint?: boolean;
6440
7866
  /** 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. */
6441
7867
  quotaUser?: string;
6442
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
6443
- servingConfig: string;
6444
7868
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6445
7869
  upload_protocol?: string;
6446
7870
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6447
7871
  uploadType?: string;
6448
- /** Request body */
6449
- resource: GoogleCloudDiscoveryengineV1RecommendRequest;
6450
- }): Request<GoogleCloudDiscoveryengineV1RecommendResponse>;
6451
- recommend(
6452
- request: {
6453
- /** V1 error format. */
6454
- '$.xgafv'?: string;
6455
- /** OAuth access token. */
6456
- access_token?: string;
6457
- /** Data format for response. */
6458
- alt?: string;
6459
- /** JSONP */
6460
- callback?: string;
6461
- /** Selector specifying which fields to include in a partial response. */
6462
- fields?: string;
6463
- /** 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. */
6464
- key?: string;
6465
- /** OAuth 2.0 token for the current user. */
6466
- oauth_token?: string;
6467
- /** Returns response with indentations and line breaks. */
6468
- prettyPrint?: boolean;
6469
- /** 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. */
6470
- quotaUser?: string;
6471
- /** Required. Full resource name of a ServingConfig: `projects/*‍/locations/global/collections/*‍/engines/*‍/servingConfigs/*`, or `projects/*‍/locations/global/collections/*‍/dataStores/*‍/servingConfigs/*` One default serving config is created along with your recommendation engine creation. The engine ID will be used as the ID of the default serving config. For example, for Engine `projects/*‍/locations/global/collections/*‍/engines/my-engine`, you can use `projects/*‍/locations/global/collections/*‍/engines/my-engine/servingConfigs/my-engine` for your RecommendationService.Recommend requests. */
6472
- servingConfig: string;
6473
- /** Upload protocol for media (e.g. "raw", "multipart"). */
6474
- upload_protocol?: string;
6475
- /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6476
- uploadType?: string;
6477
- },
6478
- body: GoogleCloudDiscoveryengineV1RecommendRequest
6479
- ): Request<GoogleCloudDiscoveryengineV1RecommendResponse>;
6480
- /** Performs a search. */
6481
- search(request: {
7872
+ }): Request<GoogleCloudDiscoveryengineV1ListSessionsResponse>;
7873
+ /** Updates a Session. Session action type cannot be changed. If the Session to update does not exist, a NOT_FOUND error is returned. */
7874
+ patch(request: {
6482
7875
  /** V1 error format. */
6483
7876
  '$.xgafv'?: string;
6484
7877
  /** OAuth access token. */
@@ -6491,22 +7884,24 @@ declare namespace gapi.client {
6491
7884
  fields?: string;
6492
7885
  /** 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. */
6493
7886
  key?: string;
7887
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
7888
+ name: string;
6494
7889
  /** OAuth 2.0 token for the current user. */
6495
7890
  oauth_token?: string;
6496
7891
  /** Returns response with indentations and line breaks. */
6497
7892
  prettyPrint?: boolean;
6498
7893
  /** 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. */
6499
7894
  quotaUser?: string;
6500
- /** 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. */
6501
- servingConfig: string;
7895
+ /** Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. */
7896
+ updateMask?: string;
6502
7897
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6503
7898
  upload_protocol?: string;
6504
7899
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6505
7900
  uploadType?: string;
6506
7901
  /** Request body */
6507
- resource: GoogleCloudDiscoveryengineV1SearchRequest;
6508
- }): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
6509
- search(
7902
+ resource: GoogleCloudDiscoveryengineV1Session;
7903
+ }): Request<GoogleCloudDiscoveryengineV1Session>;
7904
+ patch(
6510
7905
  request: {
6511
7906
  /** V1 error format. */
6512
7907
  '$.xgafv'?: string;
@@ -6520,21 +7915,24 @@ declare namespace gapi.client {
6520
7915
  fields?: string;
6521
7916
  /** 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. */
6522
7917
  key?: string;
7918
+ /** Immutable. Fully qualified name `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*` */
7919
+ name: string;
6523
7920
  /** OAuth 2.0 token for the current user. */
6524
7921
  oauth_token?: string;
6525
7922
  /** Returns response with indentations and line breaks. */
6526
7923
  prettyPrint?: boolean;
6527
7924
  /** 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. */
6528
7925
  quotaUser?: string;
6529
- /** 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. */
6530
- servingConfig: string;
7926
+ /** Indicates which fields in the provided Session to update. The following are NOT supported: * Session.name If not set or empty, all supported fields are updated. */
7927
+ updateMask?: string;
6531
7928
  /** Upload protocol for media (e.g. "raw", "multipart"). */
6532
7929
  upload_protocol?: string;
6533
7930
  /** Legacy upload protocol for media (e.g. "media", "multipart"). */
6534
7931
  uploadType?: string;
6535
7932
  },
6536
- body: GoogleCloudDiscoveryengineV1SearchRequest
6537
- ): Request<GoogleCloudDiscoveryengineV1SearchResponse>;
7933
+ body: GoogleCloudDiscoveryengineV1Session
7934
+ ): Request<GoogleCloudDiscoveryengineV1Session>;
7935
+ answers: AnswersResource;
6538
7936
  }
6539
7937
  interface TargetSitesResource {
6540
7938
  /** Creates TargetSite in a batch. */
@@ -7126,7 +8524,7 @@ declare namespace gapi.client {
7126
8524
  /** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
7127
8525
  userEvent?: string;
7128
8526
  }): Request<GoogleApiHttpBody>;
7129
- /** Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. */
8527
+ /** Bulk import of user events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events. Operation.response is of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata. */
7130
8528
  import(request: {
7131
8529
  /** V1 error format. */
7132
8530
  '$.xgafv'?: string;
@@ -7527,10 +8925,71 @@ declare namespace gapi.client {
7527
8925
  operations: OperationsResource;
7528
8926
  schemas: SchemasResource;
7529
8927
  servingConfigs: ServingConfigsResource;
8928
+ sessions: SessionsResource;
7530
8929
  siteSearchEngine: SiteSearchEngineResource;
7531
8930
  suggestionDenyListEntries: SuggestionDenyListEntriesResource;
7532
8931
  userEvents: UserEventsResource;
7533
8932
  }
8933
+ interface GroundingConfigsResource {
8934
+ /** Performs a grounding check. */
8935
+ check(request: {
8936
+ /** V1 error format. */
8937
+ '$.xgafv'?: string;
8938
+ /** OAuth access token. */
8939
+ access_token?: string;
8940
+ /** Data format for response. */
8941
+ alt?: string;
8942
+ /** JSONP */
8943
+ callback?: string;
8944
+ /** Selector specifying which fields to include in a partial response. */
8945
+ fields?: string;
8946
+ /** Required. The resource name of the grounding config, such as `projects/*‍/locations/global/groundingConfigs/default_grounding_config`. */
8947
+ groundingConfig: string;
8948
+ /** 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. */
8949
+ key?: string;
8950
+ /** OAuth 2.0 token for the current user. */
8951
+ oauth_token?: string;
8952
+ /** Returns response with indentations and line breaks. */
8953
+ prettyPrint?: boolean;
8954
+ /** 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. */
8955
+ quotaUser?: string;
8956
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8957
+ upload_protocol?: string;
8958
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8959
+ uploadType?: string;
8960
+ /** Request body */
8961
+ resource: GoogleCloudDiscoveryengineV1CheckGroundingRequest;
8962
+ }): Request<GoogleCloudDiscoveryengineV1CheckGroundingResponse>;
8963
+ check(
8964
+ request: {
8965
+ /** V1 error format. */
8966
+ '$.xgafv'?: string;
8967
+ /** OAuth access token. */
8968
+ access_token?: string;
8969
+ /** Data format for response. */
8970
+ alt?: string;
8971
+ /** JSONP */
8972
+ callback?: string;
8973
+ /** Selector specifying which fields to include in a partial response. */
8974
+ fields?: string;
8975
+ /** Required. The resource name of the grounding config, such as `projects/*‍/locations/global/groundingConfigs/default_grounding_config`. */
8976
+ groundingConfig: string;
8977
+ /** 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. */
8978
+ key?: string;
8979
+ /** OAuth 2.0 token for the current user. */
8980
+ oauth_token?: string;
8981
+ /** Returns response with indentations and line breaks. */
8982
+ prettyPrint?: boolean;
8983
+ /** 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. */
8984
+ quotaUser?: string;
8985
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
8986
+ upload_protocol?: string;
8987
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
8988
+ uploadType?: string;
8989
+ },
8990
+ body: GoogleCloudDiscoveryengineV1CheckGroundingRequest
8991
+ ): Request<GoogleCloudDiscoveryengineV1CheckGroundingResponse>;
8992
+ }
7534
8993
  interface OperationsResource {
7535
8994
  /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
7536
8995
  get(request?: {
@@ -7593,6 +9052,66 @@ declare namespace gapi.client {
7593
9052
  uploadType?: string;
7594
9053
  }): Request<GoogleLongrunningListOperationsResponse>;
7595
9054
  }
9055
+ interface RankingConfigsResource {
9056
+ /** Ranks a list of text records based on the given input query. */
9057
+ rank(request: {
9058
+ /** V1 error format. */
9059
+ '$.xgafv'?: string;
9060
+ /** OAuth access token. */
9061
+ access_token?: string;
9062
+ /** Data format for response. */
9063
+ alt?: string;
9064
+ /** JSONP */
9065
+ callback?: string;
9066
+ /** Selector specifying which fields to include in a partial response. */
9067
+ fields?: string;
9068
+ /** 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. */
9069
+ key?: string;
9070
+ /** OAuth 2.0 token for the current user. */
9071
+ oauth_token?: string;
9072
+ /** Returns response with indentations and line breaks. */
9073
+ prettyPrint?: boolean;
9074
+ /** 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. */
9075
+ quotaUser?: string;
9076
+ /** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. */
9077
+ rankingConfig: string;
9078
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
9079
+ upload_protocol?: string;
9080
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9081
+ uploadType?: string;
9082
+ /** Request body */
9083
+ resource: GoogleCloudDiscoveryengineV1RankRequest;
9084
+ }): Request<GoogleCloudDiscoveryengineV1RankResponse>;
9085
+ rank(
9086
+ request: {
9087
+ /** V1 error format. */
9088
+ '$.xgafv'?: string;
9089
+ /** OAuth access token. */
9090
+ access_token?: string;
9091
+ /** Data format for response. */
9092
+ alt?: string;
9093
+ /** JSONP */
9094
+ callback?: string;
9095
+ /** Selector specifying which fields to include in a partial response. */
9096
+ fields?: string;
9097
+ /** 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. */
9098
+ key?: string;
9099
+ /** OAuth 2.0 token for the current user. */
9100
+ oauth_token?: string;
9101
+ /** Returns response with indentations and line breaks. */
9102
+ prettyPrint?: boolean;
9103
+ /** 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. */
9104
+ quotaUser?: string;
9105
+ /** Required. The resource name of the rank service config, such as `projects/{project_num}/locations/{location_id}/rankingConfigs/default_ranking_config`. */
9106
+ rankingConfig: string;
9107
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
9108
+ upload_protocol?: string;
9109
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9110
+ uploadType?: string;
9111
+ },
9112
+ body: GoogleCloudDiscoveryengineV1RankRequest
9113
+ ): Request<GoogleCloudDiscoveryengineV1RankResponse>;
9114
+ }
7596
9115
  interface UserEventsResource {
7597
9116
  /** Writes a single user event. */
7598
9117
  write(request: {
@@ -7656,10 +9175,70 @@ declare namespace gapi.client {
7656
9175
  interface LocationsResource {
7657
9176
  collections: CollectionsResource;
7658
9177
  dataStores: DataStoresResource;
9178
+ groundingConfigs: GroundingConfigsResource;
7659
9179
  operations: OperationsResource;
9180
+ rankingConfigs: RankingConfigsResource;
7660
9181
  userEvents: UserEventsResource;
7661
9182
  }
7662
9183
  interface OperationsResource {
9184
+ /** Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`. */
9185
+ cancel(request: {
9186
+ /** V1 error format. */
9187
+ '$.xgafv'?: string;
9188
+ /** OAuth access token. */
9189
+ access_token?: string;
9190
+ /** Data format for response. */
9191
+ alt?: string;
9192
+ /** JSONP */
9193
+ callback?: string;
9194
+ /** Selector specifying which fields to include in a partial response. */
9195
+ fields?: string;
9196
+ /** 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. */
9197
+ key?: string;
9198
+ /** The name of the operation resource to be cancelled. */
9199
+ name: string;
9200
+ /** OAuth 2.0 token for the current user. */
9201
+ oauth_token?: string;
9202
+ /** Returns response with indentations and line breaks. */
9203
+ prettyPrint?: boolean;
9204
+ /** 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. */
9205
+ quotaUser?: string;
9206
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
9207
+ upload_protocol?: string;
9208
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9209
+ uploadType?: string;
9210
+ /** Request body */
9211
+ resource: GoogleLongrunningCancelOperationRequest;
9212
+ }): Request<{}>;
9213
+ cancel(
9214
+ request: {
9215
+ /** V1 error format. */
9216
+ '$.xgafv'?: string;
9217
+ /** OAuth access token. */
9218
+ access_token?: string;
9219
+ /** Data format for response. */
9220
+ alt?: string;
9221
+ /** JSONP */
9222
+ callback?: string;
9223
+ /** Selector specifying which fields to include in a partial response. */
9224
+ fields?: string;
9225
+ /** 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. */
9226
+ key?: string;
9227
+ /** The name of the operation resource to be cancelled. */
9228
+ name: string;
9229
+ /** OAuth 2.0 token for the current user. */
9230
+ oauth_token?: string;
9231
+ /** Returns response with indentations and line breaks. */
9232
+ prettyPrint?: boolean;
9233
+ /** 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. */
9234
+ quotaUser?: string;
9235
+ /** Upload protocol for media (e.g. "raw", "multipart"). */
9236
+ upload_protocol?: string;
9237
+ /** Legacy upload protocol for media (e.g. "media", "multipart"). */
9238
+ uploadType?: string;
9239
+ },
9240
+ body: GoogleLongrunningCancelOperationRequest
9241
+ ): Request<{}>;
7663
9242
  /** Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service. */
7664
9243
  get(request?: {
7665
9244
  /** V1 error format. */