@maxim_mazurok/gapi.client.discoveryengine-v1alpha 0.0.20230203 → 0.0.20230227
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/index.d.ts +584 -44
- package/package.json +1 -1
- package/tests.ts +363 -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=v1alpha
|
|
12
|
-
// Revision:
|
|
12
|
+
// Revision: 20230227
|
|
13
13
|
|
|
14
14
|
/// <reference types="gapi.client" />
|
|
15
15
|
|
|
@@ -43,18 +43,6 @@ declare namespace gapi.client {
|
|
|
43
43
|
importPayload?: GoogleCloudDiscoveryengineLoggingImportErrorContext;
|
|
44
44
|
/** A message describing the error. */
|
|
45
45
|
message?: string;
|
|
46
|
-
/**
|
|
47
|
-
* The API request payload, represented as a protocol buffer. Most API request types are supported. For example:
|
|
48
|
-
* "type.googleapis.com/google.cloud.discoveryengine.v1alpha.DocumentService.CreateDocumentRequest"
|
|
49
|
-
* "type.googleapis.com/google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEventRequest"
|
|
50
|
-
*/
|
|
51
|
-
requestPayload?: { [P in string]: any };
|
|
52
|
-
/**
|
|
53
|
-
* The API response payload, represented as a protocol buffer. This is used to log some "soft errors", where the response is valid but we consider there are some quality issues like
|
|
54
|
-
* unjoined events. The following API responses are supported and no PII is included: "google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend"
|
|
55
|
-
* "google.cloud.discoveryengine.v1alpha.UserEventService.WriteUserEvent" "google.cloud.discoveryengine.v1alpha.UserEventService.CollectUserEvent"
|
|
56
|
-
*/
|
|
57
|
-
responsePayload?: { [P in string]: any };
|
|
58
46
|
/** The service context in which this error has occurred. */
|
|
59
47
|
serviceContext?: GoogleCloudDiscoveryengineLoggingServiceContext;
|
|
60
48
|
/** The RPC status associated with the error log. */
|
|
@@ -77,11 +65,11 @@ declare namespace gapi.client {
|
|
|
77
65
|
userEvent?: string;
|
|
78
66
|
}
|
|
79
67
|
interface GoogleCloudDiscoveryengineLoggingServiceContext {
|
|
80
|
-
/** An identifier of the service
|
|
68
|
+
/** An identifier of the service—for example, `discoveryengine.googleapis.com`. */
|
|
81
69
|
service?: string;
|
|
82
70
|
}
|
|
83
71
|
interface GoogleCloudDiscoveryengineLoggingSourceLocation {
|
|
84
|
-
/** Human-readable name of a function or method
|
|
72
|
+
/** Human-readable name of a function or method—for example, `google.cloud.discoveryengine.v1alpha.RecommendationService.Recommend`. */
|
|
85
73
|
functionName?: string;
|
|
86
74
|
}
|
|
87
75
|
interface GoogleCloudDiscoveryengineV1alphaBigQuerySource {
|
|
@@ -128,8 +116,9 @@ declare namespace gapi.client {
|
|
|
128
116
|
/** The JSON string representation of the document. It should conform to the registered schema or an INVALID_ARGUMENT error is thrown. */
|
|
129
117
|
jsonData?: string;
|
|
130
118
|
/**
|
|
131
|
-
* Immutable. The full resource name of the document. Format:
|
|
132
|
-
* must be a UTF-8 encoded string with
|
|
119
|
+
* Immutable. The full resource name of the document. Format:
|
|
120
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with
|
|
121
|
+
* a length limit of 1024 characters.
|
|
133
122
|
*/
|
|
134
123
|
name?: string;
|
|
135
124
|
/**
|
|
@@ -145,7 +134,10 @@ declare namespace gapi.client {
|
|
|
145
134
|
interface GoogleCloudDiscoveryengineV1alphaDocumentInfo {
|
|
146
135
|
/** Required. The Document resource ID. */
|
|
147
136
|
id?: string;
|
|
148
|
-
/**
|
|
137
|
+
/**
|
|
138
|
+
* Required. The Document resource full name, of the form:
|
|
139
|
+
* projects/{project\_id}/locations/{location}/collections/{collection\_id}/dataStores/{data\_store\_id}/branches/{branch\_id}/documents/{document\_id}
|
|
140
|
+
*/
|
|
149
141
|
name?: string;
|
|
150
142
|
/** The promotion IDs associated with this Document. Currently, this field is restricted to at most one ID. */
|
|
151
143
|
promotionIds?: string[];
|
|
@@ -610,7 +602,7 @@ declare namespace gapi.client {
|
|
|
610
602
|
key?: string;
|
|
611
603
|
/** OAuth 2.0 token for the current user. */
|
|
612
604
|
oauth_token?: string;
|
|
613
|
-
/** Required. The parent resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`. */
|
|
605
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
|
|
614
606
|
parent: string;
|
|
615
607
|
/** Returns response with indentations and line breaks. */
|
|
616
608
|
prettyPrint?: boolean;
|
|
@@ -645,7 +637,7 @@ declare namespace gapi.client {
|
|
|
645
637
|
key?: string;
|
|
646
638
|
/** OAuth 2.0 token for the current user. */
|
|
647
639
|
oauth_token?: string;
|
|
648
|
-
/** Required. The parent resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`. */
|
|
640
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
|
|
649
641
|
parent: string;
|
|
650
642
|
/** Returns response with indentations and line breaks. */
|
|
651
643
|
prettyPrint?: boolean;
|
|
@@ -672,9 +664,9 @@ declare namespace gapi.client {
|
|
|
672
664
|
/** 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. */
|
|
673
665
|
key?: string;
|
|
674
666
|
/**
|
|
675
|
-
* Required. Full resource name of Document, such as
|
|
676
|
-
*
|
|
677
|
-
* error is returned.
|
|
667
|
+
* Required. Full resource name of Document, such as
|
|
668
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to
|
|
669
|
+
* 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.
|
|
678
670
|
*/
|
|
679
671
|
name: string;
|
|
680
672
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -703,9 +695,9 @@ declare namespace gapi.client {
|
|
|
703
695
|
/** 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. */
|
|
704
696
|
key?: string;
|
|
705
697
|
/**
|
|
706
|
-
* Required. Full resource name of Document, such as
|
|
707
|
-
*
|
|
708
|
-
* error is returned.
|
|
698
|
+
* Required. Full resource name of Document, such as
|
|
699
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to
|
|
700
|
+
* 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.
|
|
709
701
|
*/
|
|
710
702
|
name: string;
|
|
711
703
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -738,7 +730,10 @@ declare namespace gapi.client {
|
|
|
738
730
|
key?: string;
|
|
739
731
|
/** OAuth 2.0 token for the current user. */
|
|
740
732
|
oauth_token?: string;
|
|
741
|
-
/**
|
|
733
|
+
/**
|
|
734
|
+
* Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires
|
|
735
|
+
* create/update permission.
|
|
736
|
+
*/
|
|
742
737
|
parent: string;
|
|
743
738
|
/** Returns response with indentations and line breaks. */
|
|
744
739
|
prettyPrint?: boolean;
|
|
@@ -766,7 +761,549 @@ declare namespace gapi.client {
|
|
|
766
761
|
key?: string;
|
|
767
762
|
/** OAuth 2.0 token for the current user. */
|
|
768
763
|
oauth_token?: string;
|
|
769
|
-
/**
|
|
764
|
+
/**
|
|
765
|
+
* Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires
|
|
766
|
+
* create/update permission.
|
|
767
|
+
*/
|
|
768
|
+
parent: string;
|
|
769
|
+
/** Returns response with indentations and line breaks. */
|
|
770
|
+
prettyPrint?: boolean;
|
|
771
|
+
/** 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. */
|
|
772
|
+
quotaUser?: string;
|
|
773
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
774
|
+
upload_protocol?: string;
|
|
775
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
776
|
+
uploadType?: string;
|
|
777
|
+
},
|
|
778
|
+
body: GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest): Request<GoogleLongrunningOperation>;
|
|
779
|
+
/** Gets a list of Documents. */
|
|
780
|
+
list(request?: {
|
|
781
|
+
/** V1 error format. */
|
|
782
|
+
"$.xgafv"?: string;
|
|
783
|
+
/** OAuth access token. */
|
|
784
|
+
access_token?: string;
|
|
785
|
+
/** Data format for response. */
|
|
786
|
+
alt?: string;
|
|
787
|
+
/** JSONP */
|
|
788
|
+
callback?: string;
|
|
789
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
790
|
+
fields?: string;
|
|
791
|
+
/** 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. */
|
|
792
|
+
key?: string;
|
|
793
|
+
/** OAuth 2.0 token for the current user. */
|
|
794
|
+
oauth_token?: string;
|
|
795
|
+
/**
|
|
796
|
+
* 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,
|
|
797
|
+
* an INVALID_ARGUMENT error is returned.
|
|
798
|
+
*/
|
|
799
|
+
pageSize?: number;
|
|
800
|
+
/**
|
|
801
|
+
* A page token ListDocumentsResponse.next_page_token, received from a previous DocumentService.ListDocuments call. Provide this to retrieve the subsequent page. When paginating,
|
|
802
|
+
* all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
|
|
803
|
+
*/
|
|
804
|
+
pageToken?: string;
|
|
805
|
+
/**
|
|
806
|
+
* Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use
|
|
807
|
+
* `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether
|
|
808
|
+
* or not this branch exists, a PERMISSION_DENIED error is returned.
|
|
809
|
+
*/
|
|
810
|
+
parent: string;
|
|
811
|
+
/** Returns response with indentations and line breaks. */
|
|
812
|
+
prettyPrint?: boolean;
|
|
813
|
+
/** 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. */
|
|
814
|
+
quotaUser?: string;
|
|
815
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
816
|
+
upload_protocol?: string;
|
|
817
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
818
|
+
uploadType?: string;
|
|
819
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaListDocumentsResponse>;
|
|
820
|
+
/** Updates a Document. */
|
|
821
|
+
patch(request: {
|
|
822
|
+
/** V1 error format. */
|
|
823
|
+
"$.xgafv"?: string;
|
|
824
|
+
/** OAuth access token. */
|
|
825
|
+
access_token?: string;
|
|
826
|
+
/** If set to true, and the Document is not found, a new Document will be created. */
|
|
827
|
+
allowMissing?: boolean;
|
|
828
|
+
/** Data format for response. */
|
|
829
|
+
alt?: string;
|
|
830
|
+
/** JSONP */
|
|
831
|
+
callback?: string;
|
|
832
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
833
|
+
fields?: string;
|
|
834
|
+
/** 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. */
|
|
835
|
+
key?: string;
|
|
836
|
+
/**
|
|
837
|
+
* Immutable. The full resource name of the document. Format:
|
|
838
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string
|
|
839
|
+
* with a length limit of 1024 characters.
|
|
840
|
+
*/
|
|
841
|
+
name: string;
|
|
842
|
+
/** OAuth 2.0 token for the current user. */
|
|
843
|
+
oauth_token?: string;
|
|
844
|
+
/** Returns response with indentations and line breaks. */
|
|
845
|
+
prettyPrint?: boolean;
|
|
846
|
+
/** 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. */
|
|
847
|
+
quotaUser?: string;
|
|
848
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
849
|
+
upload_protocol?: string;
|
|
850
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
851
|
+
uploadType?: string;
|
|
852
|
+
/** Request body */
|
|
853
|
+
resource: GoogleCloudDiscoveryengineV1alphaDocument;
|
|
854
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
|
|
855
|
+
patch(request: {
|
|
856
|
+
/** V1 error format. */
|
|
857
|
+
"$.xgafv"?: string;
|
|
858
|
+
/** OAuth access token. */
|
|
859
|
+
access_token?: string;
|
|
860
|
+
/** If set to true, and the Document is not found, a new Document will be created. */
|
|
861
|
+
allowMissing?: boolean;
|
|
862
|
+
/** Data format for response. */
|
|
863
|
+
alt?: string;
|
|
864
|
+
/** JSONP */
|
|
865
|
+
callback?: string;
|
|
866
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
867
|
+
fields?: string;
|
|
868
|
+
/** 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. */
|
|
869
|
+
key?: string;
|
|
870
|
+
/**
|
|
871
|
+
* Immutable. The full resource name of the document. Format:
|
|
872
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string
|
|
873
|
+
* with a length limit of 1024 characters.
|
|
874
|
+
*/
|
|
875
|
+
name: string;
|
|
876
|
+
/** OAuth 2.0 token for the current user. */
|
|
877
|
+
oauth_token?: string;
|
|
878
|
+
/** Returns response with indentations and line breaks. */
|
|
879
|
+
prettyPrint?: boolean;
|
|
880
|
+
/** 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. */
|
|
881
|
+
quotaUser?: string;
|
|
882
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
883
|
+
upload_protocol?: string;
|
|
884
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
885
|
+
uploadType?: string;
|
|
886
|
+
},
|
|
887
|
+
body: GoogleCloudDiscoveryengineV1alphaDocument): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
|
|
888
|
+
}
|
|
889
|
+
interface BranchesResource {
|
|
890
|
+
documents: DocumentsResource;
|
|
891
|
+
}
|
|
892
|
+
interface ServingConfigsResource {
|
|
893
|
+
/** Makes a recommendation, which requires a contextual user event. */
|
|
894
|
+
recommend(request: {
|
|
895
|
+
/** V1 error format. */
|
|
896
|
+
"$.xgafv"?: string;
|
|
897
|
+
/** OAuth access token. */
|
|
898
|
+
access_token?: string;
|
|
899
|
+
/** Data format for response. */
|
|
900
|
+
alt?: string;
|
|
901
|
+
/** JSONP */
|
|
902
|
+
callback?: string;
|
|
903
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
904
|
+
fields?: string;
|
|
905
|
+
/** 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. */
|
|
906
|
+
key?: string;
|
|
907
|
+
/** OAuth 2.0 token for the current user. */
|
|
908
|
+
oauth_token?: string;
|
|
909
|
+
/** Returns response with indentations and line breaks. */
|
|
910
|
+
prettyPrint?: boolean;
|
|
911
|
+
/** 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. */
|
|
912
|
+
quotaUser?: string;
|
|
913
|
+
/**
|
|
914
|
+
* Required. Full resource name of the format: projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* Before you can request recommendations from your model,
|
|
915
|
+
* you must create at least one serving config for it.
|
|
916
|
+
*/
|
|
917
|
+
servingConfig: string;
|
|
918
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
919
|
+
upload_protocol?: string;
|
|
920
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
921
|
+
uploadType?: string;
|
|
922
|
+
/** Request body */
|
|
923
|
+
resource: GoogleCloudDiscoveryengineV1alphaRecommendRequest;
|
|
924
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
|
|
925
|
+
recommend(request: {
|
|
926
|
+
/** V1 error format. */
|
|
927
|
+
"$.xgafv"?: string;
|
|
928
|
+
/** OAuth access token. */
|
|
929
|
+
access_token?: string;
|
|
930
|
+
/** Data format for response. */
|
|
931
|
+
alt?: string;
|
|
932
|
+
/** JSONP */
|
|
933
|
+
callback?: string;
|
|
934
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
935
|
+
fields?: string;
|
|
936
|
+
/** 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. */
|
|
937
|
+
key?: string;
|
|
938
|
+
/** OAuth 2.0 token for the current user. */
|
|
939
|
+
oauth_token?: string;
|
|
940
|
+
/** Returns response with indentations and line breaks. */
|
|
941
|
+
prettyPrint?: boolean;
|
|
942
|
+
/** 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. */
|
|
943
|
+
quotaUser?: string;
|
|
944
|
+
/**
|
|
945
|
+
* Required. Full resource name of the format: projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* Before you can request recommendations from your model,
|
|
946
|
+
* you must create at least one serving config for it.
|
|
947
|
+
*/
|
|
948
|
+
servingConfig: string;
|
|
949
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
950
|
+
upload_protocol?: string;
|
|
951
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
952
|
+
uploadType?: string;
|
|
953
|
+
},
|
|
954
|
+
body: GoogleCloudDiscoveryengineV1alphaRecommendRequest): Request<GoogleCloudDiscoveryengineV1alphaRecommendResponse>;
|
|
955
|
+
}
|
|
956
|
+
interface UserEventsResource {
|
|
957
|
+
/**
|
|
958
|
+
* Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery
|
|
959
|
+
* Engine API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
|
|
960
|
+
*/
|
|
961
|
+
collect(request?: {
|
|
962
|
+
/** V1 error format. */
|
|
963
|
+
"$.xgafv"?: string;
|
|
964
|
+
/** OAuth access token. */
|
|
965
|
+
access_token?: string;
|
|
966
|
+
/** Data format for response. */
|
|
967
|
+
alt?: string;
|
|
968
|
+
/** JSONP */
|
|
969
|
+
callback?: string;
|
|
970
|
+
/** The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes. */
|
|
971
|
+
ets?: string;
|
|
972
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
973
|
+
fields?: string;
|
|
974
|
+
/** 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. */
|
|
975
|
+
key?: string;
|
|
976
|
+
/** OAuth 2.0 token for the current user. */
|
|
977
|
+
oauth_token?: string;
|
|
978
|
+
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
979
|
+
parent: string;
|
|
980
|
+
/** Returns response with indentations and line breaks. */
|
|
981
|
+
prettyPrint?: boolean;
|
|
982
|
+
/** 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. */
|
|
983
|
+
quotaUser?: string;
|
|
984
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
985
|
+
upload_protocol?: string;
|
|
986
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
987
|
+
uploadType?: string;
|
|
988
|
+
/**
|
|
989
|
+
* The URL including cgi-parameters but excluding the hash fragment with a length limit of 5,000 characters. This is often more useful than the referer URL, because many browsers
|
|
990
|
+
* only send the domain for 3rd party requests.
|
|
991
|
+
*/
|
|
992
|
+
uri?: string;
|
|
993
|
+
/** Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters. */
|
|
994
|
+
userEvent?: string;
|
|
995
|
+
}): Request<GoogleApiHttpBody>;
|
|
996
|
+
/**
|
|
997
|
+
* Bulk import of User events. Request processing might be synchronous. Events that already exist are skipped. Use this method for backfilling historical user events.
|
|
998
|
+
* 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.
|
|
999
|
+
*/
|
|
1000
|
+
import(request: {
|
|
1001
|
+
/** V1 error format. */
|
|
1002
|
+
"$.xgafv"?: string;
|
|
1003
|
+
/** OAuth access token. */
|
|
1004
|
+
access_token?: string;
|
|
1005
|
+
/** Data format for response. */
|
|
1006
|
+
alt?: string;
|
|
1007
|
+
/** JSONP */
|
|
1008
|
+
callback?: string;
|
|
1009
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1010
|
+
fields?: string;
|
|
1011
|
+
/** 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. */
|
|
1012
|
+
key?: string;
|
|
1013
|
+
/** OAuth 2.0 token for the current user. */
|
|
1014
|
+
oauth_token?: string;
|
|
1015
|
+
/** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
|
|
1016
|
+
parent: string;
|
|
1017
|
+
/** Returns response with indentations and line breaks. */
|
|
1018
|
+
prettyPrint?: boolean;
|
|
1019
|
+
/** 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. */
|
|
1020
|
+
quotaUser?: string;
|
|
1021
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1022
|
+
upload_protocol?: string;
|
|
1023
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1024
|
+
uploadType?: string;
|
|
1025
|
+
/** Request body */
|
|
1026
|
+
resource: GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest;
|
|
1027
|
+
}): Request<GoogleLongrunningOperation>;
|
|
1028
|
+
import(request: {
|
|
1029
|
+
/** V1 error format. */
|
|
1030
|
+
"$.xgafv"?: string;
|
|
1031
|
+
/** OAuth access token. */
|
|
1032
|
+
access_token?: string;
|
|
1033
|
+
/** Data format for response. */
|
|
1034
|
+
alt?: string;
|
|
1035
|
+
/** JSONP */
|
|
1036
|
+
callback?: string;
|
|
1037
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1038
|
+
fields?: string;
|
|
1039
|
+
/** 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. */
|
|
1040
|
+
key?: string;
|
|
1041
|
+
/** OAuth 2.0 token for the current user. */
|
|
1042
|
+
oauth_token?: string;
|
|
1043
|
+
/** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
|
|
1044
|
+
parent: string;
|
|
1045
|
+
/** Returns response with indentations and line breaks. */
|
|
1046
|
+
prettyPrint?: boolean;
|
|
1047
|
+
/** 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. */
|
|
1048
|
+
quotaUser?: string;
|
|
1049
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1050
|
+
upload_protocol?: string;
|
|
1051
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1052
|
+
uploadType?: string;
|
|
1053
|
+
},
|
|
1054
|
+
body: GoogleCloudDiscoveryengineV1alphaImportUserEventsRequest): Request<GoogleLongrunningOperation>;
|
|
1055
|
+
/** Writes a single user event. */
|
|
1056
|
+
write(request: {
|
|
1057
|
+
/** V1 error format. */
|
|
1058
|
+
"$.xgafv"?: string;
|
|
1059
|
+
/** OAuth access token. */
|
|
1060
|
+
access_token?: string;
|
|
1061
|
+
/** Data format for response. */
|
|
1062
|
+
alt?: string;
|
|
1063
|
+
/** JSONP */
|
|
1064
|
+
callback?: string;
|
|
1065
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1066
|
+
fields?: string;
|
|
1067
|
+
/** 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. */
|
|
1068
|
+
key?: string;
|
|
1069
|
+
/** OAuth 2.0 token for the current user. */
|
|
1070
|
+
oauth_token?: string;
|
|
1071
|
+
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
1072
|
+
parent: string;
|
|
1073
|
+
/** Returns response with indentations and line breaks. */
|
|
1074
|
+
prettyPrint?: boolean;
|
|
1075
|
+
/** 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. */
|
|
1076
|
+
quotaUser?: string;
|
|
1077
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1078
|
+
upload_protocol?: string;
|
|
1079
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1080
|
+
uploadType?: string;
|
|
1081
|
+
/** Request body */
|
|
1082
|
+
resource: GoogleCloudDiscoveryengineV1alphaUserEvent;
|
|
1083
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
|
|
1084
|
+
write(request: {
|
|
1085
|
+
/** V1 error format. */
|
|
1086
|
+
"$.xgafv"?: string;
|
|
1087
|
+
/** OAuth access token. */
|
|
1088
|
+
access_token?: string;
|
|
1089
|
+
/** Data format for response. */
|
|
1090
|
+
alt?: string;
|
|
1091
|
+
/** JSONP */
|
|
1092
|
+
callback?: string;
|
|
1093
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1094
|
+
fields?: string;
|
|
1095
|
+
/** 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. */
|
|
1096
|
+
key?: string;
|
|
1097
|
+
/** OAuth 2.0 token for the current user. */
|
|
1098
|
+
oauth_token?: string;
|
|
1099
|
+
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
1100
|
+
parent: string;
|
|
1101
|
+
/** Returns response with indentations and line breaks. */
|
|
1102
|
+
prettyPrint?: boolean;
|
|
1103
|
+
/** 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. */
|
|
1104
|
+
quotaUser?: string;
|
|
1105
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1106
|
+
upload_protocol?: string;
|
|
1107
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1108
|
+
uploadType?: string;
|
|
1109
|
+
},
|
|
1110
|
+
body: GoogleCloudDiscoveryengineV1alphaUserEvent): Request<GoogleCloudDiscoveryengineV1alphaUserEvent>;
|
|
1111
|
+
}
|
|
1112
|
+
interface DataStoresResource {
|
|
1113
|
+
branches: BranchesResource;
|
|
1114
|
+
servingConfigs: ServingConfigsResource;
|
|
1115
|
+
userEvents: UserEventsResource;
|
|
1116
|
+
}
|
|
1117
|
+
interface CollectionsResource {
|
|
1118
|
+
dataStores: DataStoresResource;
|
|
1119
|
+
}
|
|
1120
|
+
interface DocumentsResource {
|
|
1121
|
+
/** Creates a Document. */
|
|
1122
|
+
create(request: {
|
|
1123
|
+
/** V1 error format. */
|
|
1124
|
+
"$.xgafv"?: string;
|
|
1125
|
+
/** OAuth access token. */
|
|
1126
|
+
access_token?: string;
|
|
1127
|
+
/** Data format for response. */
|
|
1128
|
+
alt?: string;
|
|
1129
|
+
/** JSONP */
|
|
1130
|
+
callback?: string;
|
|
1131
|
+
/**
|
|
1132
|
+
* 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
|
|
1133
|
+
* 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
|
|
1134
|
+
* 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
|
|
1135
|
+
* returned.
|
|
1136
|
+
*/
|
|
1137
|
+
documentId?: string;
|
|
1138
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1139
|
+
fields?: string;
|
|
1140
|
+
/** 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. */
|
|
1141
|
+
key?: string;
|
|
1142
|
+
/** OAuth 2.0 token for the current user. */
|
|
1143
|
+
oauth_token?: string;
|
|
1144
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
|
|
1145
|
+
parent: string;
|
|
1146
|
+
/** Returns response with indentations and line breaks. */
|
|
1147
|
+
prettyPrint?: boolean;
|
|
1148
|
+
/** 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. */
|
|
1149
|
+
quotaUser?: string;
|
|
1150
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1151
|
+
upload_protocol?: string;
|
|
1152
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1153
|
+
uploadType?: string;
|
|
1154
|
+
/** Request body */
|
|
1155
|
+
resource: GoogleCloudDiscoveryengineV1alphaDocument;
|
|
1156
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
|
|
1157
|
+
create(request: {
|
|
1158
|
+
/** V1 error format. */
|
|
1159
|
+
"$.xgafv"?: string;
|
|
1160
|
+
/** OAuth access token. */
|
|
1161
|
+
access_token?: string;
|
|
1162
|
+
/** Data format for response. */
|
|
1163
|
+
alt?: string;
|
|
1164
|
+
/** JSONP */
|
|
1165
|
+
callback?: string;
|
|
1166
|
+
/**
|
|
1167
|
+
* 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
|
|
1168
|
+
* 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
|
|
1169
|
+
* 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
|
|
1170
|
+
* returned.
|
|
1171
|
+
*/
|
|
1172
|
+
documentId?: string;
|
|
1173
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1174
|
+
fields?: string;
|
|
1175
|
+
/** 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. */
|
|
1176
|
+
key?: string;
|
|
1177
|
+
/** OAuth 2.0 token for the current user. */
|
|
1178
|
+
oauth_token?: string;
|
|
1179
|
+
/** Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. */
|
|
1180
|
+
parent: string;
|
|
1181
|
+
/** Returns response with indentations and line breaks. */
|
|
1182
|
+
prettyPrint?: boolean;
|
|
1183
|
+
/** 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. */
|
|
1184
|
+
quotaUser?: string;
|
|
1185
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1186
|
+
upload_protocol?: string;
|
|
1187
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1188
|
+
uploadType?: string;
|
|
1189
|
+
},
|
|
1190
|
+
body: GoogleCloudDiscoveryengineV1alphaDocument): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
|
|
1191
|
+
/** Deletes a Document. */
|
|
1192
|
+
delete(request?: {
|
|
1193
|
+
/** V1 error format. */
|
|
1194
|
+
"$.xgafv"?: string;
|
|
1195
|
+
/** OAuth access token. */
|
|
1196
|
+
access_token?: string;
|
|
1197
|
+
/** Data format for response. */
|
|
1198
|
+
alt?: string;
|
|
1199
|
+
/** JSONP */
|
|
1200
|
+
callback?: string;
|
|
1201
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1202
|
+
fields?: string;
|
|
1203
|
+
/** 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. */
|
|
1204
|
+
key?: string;
|
|
1205
|
+
/**
|
|
1206
|
+
* Required. Full resource name of Document, such as
|
|
1207
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to
|
|
1208
|
+
* 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.
|
|
1209
|
+
*/
|
|
1210
|
+
name: string;
|
|
1211
|
+
/** OAuth 2.0 token for the current user. */
|
|
1212
|
+
oauth_token?: string;
|
|
1213
|
+
/** Returns response with indentations and line breaks. */
|
|
1214
|
+
prettyPrint?: boolean;
|
|
1215
|
+
/** 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. */
|
|
1216
|
+
quotaUser?: string;
|
|
1217
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1218
|
+
upload_protocol?: string;
|
|
1219
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1220
|
+
uploadType?: string;
|
|
1221
|
+
}): Request<{}>;
|
|
1222
|
+
/** Gets a Document. */
|
|
1223
|
+
get(request?: {
|
|
1224
|
+
/** V1 error format. */
|
|
1225
|
+
"$.xgafv"?: string;
|
|
1226
|
+
/** OAuth access token. */
|
|
1227
|
+
access_token?: string;
|
|
1228
|
+
/** Data format for response. */
|
|
1229
|
+
alt?: string;
|
|
1230
|
+
/** JSONP */
|
|
1231
|
+
callback?: string;
|
|
1232
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1233
|
+
fields?: string;
|
|
1234
|
+
/** 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. */
|
|
1235
|
+
key?: string;
|
|
1236
|
+
/**
|
|
1237
|
+
* Required. Full resource name of Document, such as
|
|
1238
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to
|
|
1239
|
+
* 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.
|
|
1240
|
+
*/
|
|
1241
|
+
name: string;
|
|
1242
|
+
/** OAuth 2.0 token for the current user. */
|
|
1243
|
+
oauth_token?: string;
|
|
1244
|
+
/** Returns response with indentations and line breaks. */
|
|
1245
|
+
prettyPrint?: boolean;
|
|
1246
|
+
/** 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. */
|
|
1247
|
+
quotaUser?: string;
|
|
1248
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1249
|
+
upload_protocol?: string;
|
|
1250
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1251
|
+
uploadType?: string;
|
|
1252
|
+
}): Request<GoogleCloudDiscoveryengineV1alphaDocument>;
|
|
1253
|
+
/**
|
|
1254
|
+
* 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
|
|
1255
|
+
* updated.
|
|
1256
|
+
*/
|
|
1257
|
+
import(request: {
|
|
1258
|
+
/** V1 error format. */
|
|
1259
|
+
"$.xgafv"?: string;
|
|
1260
|
+
/** OAuth access token. */
|
|
1261
|
+
access_token?: string;
|
|
1262
|
+
/** Data format for response. */
|
|
1263
|
+
alt?: string;
|
|
1264
|
+
/** JSONP */
|
|
1265
|
+
callback?: string;
|
|
1266
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1267
|
+
fields?: string;
|
|
1268
|
+
/** 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. */
|
|
1269
|
+
key?: string;
|
|
1270
|
+
/** OAuth 2.0 token for the current user. */
|
|
1271
|
+
oauth_token?: string;
|
|
1272
|
+
/**
|
|
1273
|
+
* Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires
|
|
1274
|
+
* create/update permission.
|
|
1275
|
+
*/
|
|
1276
|
+
parent: string;
|
|
1277
|
+
/** Returns response with indentations and line breaks. */
|
|
1278
|
+
prettyPrint?: boolean;
|
|
1279
|
+
/** 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. */
|
|
1280
|
+
quotaUser?: string;
|
|
1281
|
+
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
1282
|
+
upload_protocol?: string;
|
|
1283
|
+
/** Legacy upload protocol for media (e.g. "media", "multipart"). */
|
|
1284
|
+
uploadType?: string;
|
|
1285
|
+
/** Request body */
|
|
1286
|
+
resource: GoogleCloudDiscoveryengineV1alphaImportDocumentsRequest;
|
|
1287
|
+
}): Request<GoogleLongrunningOperation>;
|
|
1288
|
+
import(request: {
|
|
1289
|
+
/** V1 error format. */
|
|
1290
|
+
"$.xgafv"?: string;
|
|
1291
|
+
/** OAuth access token. */
|
|
1292
|
+
access_token?: string;
|
|
1293
|
+
/** Data format for response. */
|
|
1294
|
+
alt?: string;
|
|
1295
|
+
/** JSONP */
|
|
1296
|
+
callback?: string;
|
|
1297
|
+
/** Selector specifying which fields to include in a partial response. */
|
|
1298
|
+
fields?: string;
|
|
1299
|
+
/** 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. */
|
|
1300
|
+
key?: string;
|
|
1301
|
+
/** OAuth 2.0 token for the current user. */
|
|
1302
|
+
oauth_token?: string;
|
|
1303
|
+
/**
|
|
1304
|
+
* Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires
|
|
1305
|
+
* create/update permission.
|
|
1306
|
+
*/
|
|
770
1307
|
parent: string;
|
|
771
1308
|
/** Returns response with indentations and line breaks. */
|
|
772
1309
|
prettyPrint?: boolean;
|
|
@@ -805,9 +1342,9 @@ declare namespace gapi.client {
|
|
|
805
1342
|
*/
|
|
806
1343
|
pageToken?: string;
|
|
807
1344
|
/**
|
|
808
|
-
* Required. The parent branch resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`. Use
|
|
809
|
-
* list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether
|
|
810
|
-
* PERMISSION_DENIED error is returned.
|
|
1345
|
+
* Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use
|
|
1346
|
+
* `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether
|
|
1347
|
+
* or not this branch exists, a PERMISSION_DENIED error is returned.
|
|
811
1348
|
*/
|
|
812
1349
|
parent: string;
|
|
813
1350
|
/** Returns response with indentations and line breaks. */
|
|
@@ -836,8 +1373,9 @@ declare namespace gapi.client {
|
|
|
836
1373
|
/** 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. */
|
|
837
1374
|
key?: string;
|
|
838
1375
|
/**
|
|
839
|
-
* Immutable. The full resource name of the document. Format:
|
|
840
|
-
* field must be a UTF-8 encoded string
|
|
1376
|
+
* Immutable. The full resource name of the document. Format:
|
|
1377
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string
|
|
1378
|
+
* with a length limit of 1024 characters.
|
|
841
1379
|
*/
|
|
842
1380
|
name: string;
|
|
843
1381
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -869,8 +1407,9 @@ declare namespace gapi.client {
|
|
|
869
1407
|
/** 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. */
|
|
870
1408
|
key?: string;
|
|
871
1409
|
/**
|
|
872
|
-
* Immutable. The full resource name of the document. Format:
|
|
873
|
-
* field must be a UTF-8 encoded string
|
|
1410
|
+
* Immutable. The full resource name of the document. Format:
|
|
1411
|
+
* `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string
|
|
1412
|
+
* with a length limit of 1024 characters.
|
|
874
1413
|
*/
|
|
875
1414
|
name: string;
|
|
876
1415
|
/** OAuth 2.0 token for the current user. */
|
|
@@ -1116,8 +1655,8 @@ declare namespace gapi.client {
|
|
|
1116
1655
|
/** 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. */
|
|
1117
1656
|
quotaUser?: string;
|
|
1118
1657
|
/**
|
|
1119
|
-
* Required. Full resource name of the format: projects/*/locations/global/dataStores/*/servingConfigs/* Before you can request recommendations from your model,
|
|
1120
|
-
* at least one serving config for it.
|
|
1658
|
+
* Required. Full resource name of the format: projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* Before you can request recommendations from your model,
|
|
1659
|
+
* you must create at least one serving config for it.
|
|
1121
1660
|
*/
|
|
1122
1661
|
servingConfig: string;
|
|
1123
1662
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
@@ -1147,8 +1686,8 @@ declare namespace gapi.client {
|
|
|
1147
1686
|
/** 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. */
|
|
1148
1687
|
quotaUser?: string;
|
|
1149
1688
|
/**
|
|
1150
|
-
* Required. Full resource name of the format: projects/*/locations/global/dataStores/*/servingConfigs/* Before you can request recommendations from your model,
|
|
1151
|
-
* at least one serving config for it.
|
|
1689
|
+
* Required. Full resource name of the format: projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* Before you can request recommendations from your model,
|
|
1690
|
+
* you must create at least one serving config for it.
|
|
1152
1691
|
*/
|
|
1153
1692
|
servingConfig: string;
|
|
1154
1693
|
/** Upload protocol for media (e.g. "raw", "multipart"). */
|
|
@@ -1180,7 +1719,7 @@ declare namespace gapi.client {
|
|
|
1180
1719
|
key?: string;
|
|
1181
1720
|
/** OAuth 2.0 token for the current user. */
|
|
1182
1721
|
oauth_token?: string;
|
|
1183
|
-
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}`. */
|
|
1722
|
+
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
1184
1723
|
parent: string;
|
|
1185
1724
|
/** Returns response with indentations and line breaks. */
|
|
1186
1725
|
prettyPrint?: boolean;
|
|
@@ -1217,7 +1756,7 @@ declare namespace gapi.client {
|
|
|
1217
1756
|
key?: string;
|
|
1218
1757
|
/** OAuth 2.0 token for the current user. */
|
|
1219
1758
|
oauth_token?: string;
|
|
1220
|
-
/** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/dataStores/{data_store}` */
|
|
1759
|
+
/** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
|
|
1221
1760
|
parent: string;
|
|
1222
1761
|
/** Returns response with indentations and line breaks. */
|
|
1223
1762
|
prettyPrint?: boolean;
|
|
@@ -1245,7 +1784,7 @@ declare namespace gapi.client {
|
|
|
1245
1784
|
key?: string;
|
|
1246
1785
|
/** OAuth 2.0 token for the current user. */
|
|
1247
1786
|
oauth_token?: string;
|
|
1248
|
-
/** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/dataStores/{data_store}` */
|
|
1787
|
+
/** Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}` */
|
|
1249
1788
|
parent: string;
|
|
1250
1789
|
/** Returns response with indentations and line breaks. */
|
|
1251
1790
|
prettyPrint?: boolean;
|
|
@@ -1273,7 +1812,7 @@ declare namespace gapi.client {
|
|
|
1273
1812
|
key?: string;
|
|
1274
1813
|
/** OAuth 2.0 token for the current user. */
|
|
1275
1814
|
oauth_token?: string;
|
|
1276
|
-
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}`. */
|
|
1815
|
+
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
1277
1816
|
parent: string;
|
|
1278
1817
|
/** Returns response with indentations and line breaks. */
|
|
1279
1818
|
prettyPrint?: boolean;
|
|
@@ -1301,7 +1840,7 @@ declare namespace gapi.client {
|
|
|
1301
1840
|
key?: string;
|
|
1302
1841
|
/** OAuth 2.0 token for the current user. */
|
|
1303
1842
|
oauth_token?: string;
|
|
1304
|
-
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}`. */
|
|
1843
|
+
/** Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. */
|
|
1305
1844
|
parent: string;
|
|
1306
1845
|
/** Returns response with indentations and line breaks. */
|
|
1307
1846
|
prettyPrint?: boolean;
|
|
@@ -1389,6 +1928,7 @@ declare namespace gapi.client {
|
|
|
1389
1928
|
}): Request<GoogleLongrunningListOperationsResponse>;
|
|
1390
1929
|
}
|
|
1391
1930
|
interface LocationsResource {
|
|
1931
|
+
collections: CollectionsResource;
|
|
1392
1932
|
dataStores: DataStoresResource;
|
|
1393
1933
|
operations: OperationsResource;
|
|
1394
1934
|
}
|
package/package.json
CHANGED
package/tests.ts
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
// This file was generated by https://github.com/Maxim-Mazurok/google-api-typings-generator. Please do not edit it manually.
|
|
4
4
|
// In case of any problems please post issue to https://github.com/Maxim-Mazurok/google-api-typings-generator
|
|
5
5
|
|
|
6
|
-
// Revision:
|
|
6
|
+
// Revision: 20230227
|
|
7
7
|
|
|
8
8
|
gapi.load('client', async () => {
|
|
9
9
|
/** now we can use gapi.client */
|
|
@@ -29,6 +29,368 @@ gapi.load('client', async () => {
|
|
|
29
29
|
});
|
|
30
30
|
|
|
31
31
|
async function run() {
|
|
32
|
+
/** Creates a Document. */
|
|
33
|
+
await gapi.client.discoveryengine.projects.locations.collections.dataStores.branches.documents.create({
|
|
34
|
+
documentId: "Test string",
|
|
35
|
+
parent: "Test string",
|
|
36
|
+
}, {
|
|
37
|
+
id: "Test string",
|
|
38
|
+
jsonData: "Test string",
|
|
39
|
+
name: "Test string",
|
|
40
|
+
parentDocumentId: "Test string",
|
|
41
|
+
schemaId: "Test string",
|
|
42
|
+
structData: {
|
|
43
|
+
A: 42
|
|
44
|
+
},
|
|
45
|
+
});
|
|
46
|
+
/** Deletes a Document. */
|
|
47
|
+
await gapi.client.discoveryengine.projects.locations.collections.dataStores.branches.documents.delete({
|
|
48
|
+
name: "Test string",
|
|
49
|
+
});
|
|
50
|
+
/** Gets a Document. */
|
|
51
|
+
await gapi.client.discoveryengine.projects.locations.collections.dataStores.branches.documents.get({
|
|
52
|
+
name: "Test string",
|
|
53
|
+
});
|
|
54
|
+
/**
|
|
55
|
+
* 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
|
|
56
|
+
* updated.
|
|
57
|
+
*/
|
|
58
|
+
await gapi.client.discoveryengine.projects.locations.collections.dataStores.branches.documents.import({
|
|
59
|
+
parent: "Test string",
|
|
60
|
+
}, {
|
|
61
|
+
bigquerySource: {
|
|
62
|
+
dataSchema: "Test string",
|
|
63
|
+
datasetId: "Test string",
|
|
64
|
+
gcsStagingDir: "Test string",
|
|
65
|
+
partitionDate: {
|
|
66
|
+
day: 42,
|
|
67
|
+
month: 42,
|
|
68
|
+
year: 42,
|
|
69
|
+
},
|
|
70
|
+
projectId: "Test string",
|
|
71
|
+
tableId: "Test string",
|
|
72
|
+
},
|
|
73
|
+
errorConfig: {
|
|
74
|
+
gcsPrefix: "Test string",
|
|
75
|
+
},
|
|
76
|
+
gcsSource: {
|
|
77
|
+
dataSchema: "Test string",
|
|
78
|
+
inputUris: [
|
|
79
|
+
"Test string"
|
|
80
|
+
],
|
|
81
|
+
},
|
|
82
|
+
inlineSource: {
|
|
83
|
+
documents: [
|
|
84
|
+
{
|
|
85
|
+
id: "Test string",
|
|
86
|
+
jsonData: "Test string",
|
|
87
|
+
name: "Test string",
|
|
88
|
+
parentDocumentId: "Test string",
|
|
89
|
+
schemaId: "Test string",
|
|
90
|
+
structData: {
|
|
91
|
+
A: 42
|
|
92
|
+
},
|
|
93
|
+
}
|
|
94
|
+
],
|
|
95
|
+
},
|
|
96
|
+
reconciliationMode: "Test string",
|
|
97
|
+
});
|
|
98
|
+
/** Gets a list of Documents. */
|
|
99
|
+
await gapi.client.discoveryengine.projects.locations.collections.dataStores.branches.documents.list({
|
|
100
|
+
pageSize: 42,
|
|
101
|
+
pageToken: "Test string",
|
|
102
|
+
parent: "Test string",
|
|
103
|
+
});
|
|
104
|
+
/** Updates a Document. */
|
|
105
|
+
await gapi.client.discoveryengine.projects.locations.collections.dataStores.branches.documents.patch({
|
|
106
|
+
allowMissing: true,
|
|
107
|
+
name: "Test string",
|
|
108
|
+
}, {
|
|
109
|
+
id: "Test string",
|
|
110
|
+
jsonData: "Test string",
|
|
111
|
+
name: "Test string",
|
|
112
|
+
parentDocumentId: "Test string",
|
|
113
|
+
schemaId: "Test string",
|
|
114
|
+
structData: {
|
|
115
|
+
A: 42
|
|
116
|
+
},
|
|
117
|
+
});
|
|
118
|
+
/** Makes a recommendation, which requires a contextual user event. */
|
|
119
|
+
await gapi.client.discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend({
|
|
120
|
+
servingConfig: "Test string",
|
|
121
|
+
}, {
|
|
122
|
+
filter: "Test string",
|
|
123
|
+
pageSize: 42,
|
|
124
|
+
params: {
|
|
125
|
+
A: 42
|
|
126
|
+
},
|
|
127
|
+
userEvent: {
|
|
128
|
+
attributes: {
|
|
129
|
+
A: {
|
|
130
|
+
numbers: [
|
|
131
|
+
42
|
|
132
|
+
],
|
|
133
|
+
text: [
|
|
134
|
+
"Test string"
|
|
135
|
+
],
|
|
136
|
+
}
|
|
137
|
+
},
|
|
138
|
+
attributionToken: "Test string",
|
|
139
|
+
completionInfo: {
|
|
140
|
+
selectedPosition: 42,
|
|
141
|
+
selectedSuggestion: "Test string",
|
|
142
|
+
},
|
|
143
|
+
directUserRequest: true,
|
|
144
|
+
documents: [
|
|
145
|
+
{
|
|
146
|
+
id: "Test string",
|
|
147
|
+
name: "Test string",
|
|
148
|
+
promotionIds: [
|
|
149
|
+
"Test string"
|
|
150
|
+
],
|
|
151
|
+
quantity: 42,
|
|
152
|
+
}
|
|
153
|
+
],
|
|
154
|
+
eventTime: "Test string",
|
|
155
|
+
eventType: "Test string",
|
|
156
|
+
filter: "Test string",
|
|
157
|
+
mediaInfo: {
|
|
158
|
+
mediaProgressDuration: "Test string",
|
|
159
|
+
mediaProgressPercentage: 42,
|
|
160
|
+
},
|
|
161
|
+
pageInfo: {
|
|
162
|
+
pageCategory: "Test string",
|
|
163
|
+
pageviewId: "Test string",
|
|
164
|
+
referrerUri: "Test string",
|
|
165
|
+
uri: "Test string",
|
|
166
|
+
},
|
|
167
|
+
panel: {
|
|
168
|
+
displayName: "Test string",
|
|
169
|
+
panelId: "Test string",
|
|
170
|
+
panelPosition: 42,
|
|
171
|
+
totalPanels: 42,
|
|
172
|
+
},
|
|
173
|
+
promotionIds: [
|
|
174
|
+
"Test string"
|
|
175
|
+
],
|
|
176
|
+
searchInfo: {
|
|
177
|
+
offset: 42,
|
|
178
|
+
orderBy: "Test string",
|
|
179
|
+
searchQuery: "Test string",
|
|
180
|
+
},
|
|
181
|
+
sessionId: "Test string",
|
|
182
|
+
tagIds: [
|
|
183
|
+
"Test string"
|
|
184
|
+
],
|
|
185
|
+
transactionInfo: {
|
|
186
|
+
cost: 42,
|
|
187
|
+
currency: "Test string",
|
|
188
|
+
discountValue: 42,
|
|
189
|
+
tax: 42,
|
|
190
|
+
transactionId: "Test string",
|
|
191
|
+
value: 42,
|
|
192
|
+
},
|
|
193
|
+
userInfo: {
|
|
194
|
+
userAgent: "Test string",
|
|
195
|
+
userId: "Test string",
|
|
196
|
+
},
|
|
197
|
+
userPseudoId: "Test string",
|
|
198
|
+
},
|
|
199
|
+
userLabels: {
|
|
200
|
+
A: "Test string"
|
|
201
|
+
},
|
|
202
|
+
validateOnly: true,
|
|
203
|
+
});
|
|
204
|
+
/**
|
|
205
|
+
* Writes a single user event from the browser. This uses a GET request to due to browser restriction of POST-ing to a 3rd party domain. This method is used only by the Discovery Engine
|
|
206
|
+
* API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
|
|
207
|
+
*/
|
|
208
|
+
await gapi.client.discoveryengine.projects.locations.collections.dataStores.userEvents.collect({
|
|
209
|
+
ets: "Test string",
|
|
210
|
+
parent: "Test string",
|
|
211
|
+
uri: "Test string",
|
|
212
|
+
userEvent: "Test string",
|
|
213
|
+
});
|
|
214
|
+
/**
|
|
215
|
+
* 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
|
|
216
|
+
* of type ImportResponse. Note that it is possible for a subset of the items to be successfully inserted. Operation.metadata is of type ImportMetadata.
|
|
217
|
+
*/
|
|
218
|
+
await gapi.client.discoveryengine.projects.locations.collections.dataStores.userEvents.import({
|
|
219
|
+
parent: "Test string",
|
|
220
|
+
}, {
|
|
221
|
+
bigquerySource: {
|
|
222
|
+
dataSchema: "Test string",
|
|
223
|
+
datasetId: "Test string",
|
|
224
|
+
gcsStagingDir: "Test string",
|
|
225
|
+
partitionDate: {
|
|
226
|
+
day: 42,
|
|
227
|
+
month: 42,
|
|
228
|
+
year: 42,
|
|
229
|
+
},
|
|
230
|
+
projectId: "Test string",
|
|
231
|
+
tableId: "Test string",
|
|
232
|
+
},
|
|
233
|
+
errorConfig: {
|
|
234
|
+
gcsPrefix: "Test string",
|
|
235
|
+
},
|
|
236
|
+
gcsSource: {
|
|
237
|
+
dataSchema: "Test string",
|
|
238
|
+
inputUris: [
|
|
239
|
+
"Test string"
|
|
240
|
+
],
|
|
241
|
+
},
|
|
242
|
+
inlineSource: {
|
|
243
|
+
userEvents: [
|
|
244
|
+
{
|
|
245
|
+
attributes: {
|
|
246
|
+
A: {
|
|
247
|
+
numbers: [
|
|
248
|
+
42
|
|
249
|
+
],
|
|
250
|
+
text: [
|
|
251
|
+
"Test string"
|
|
252
|
+
],
|
|
253
|
+
}
|
|
254
|
+
},
|
|
255
|
+
attributionToken: "Test string",
|
|
256
|
+
completionInfo: {
|
|
257
|
+
selectedPosition: 42,
|
|
258
|
+
selectedSuggestion: "Test string",
|
|
259
|
+
},
|
|
260
|
+
directUserRequest: true,
|
|
261
|
+
documents: [
|
|
262
|
+
{
|
|
263
|
+
id: "Test string",
|
|
264
|
+
name: "Test string",
|
|
265
|
+
promotionIds: [
|
|
266
|
+
"Test string"
|
|
267
|
+
],
|
|
268
|
+
quantity: 42,
|
|
269
|
+
}
|
|
270
|
+
],
|
|
271
|
+
eventTime: "Test string",
|
|
272
|
+
eventType: "Test string",
|
|
273
|
+
filter: "Test string",
|
|
274
|
+
mediaInfo: {
|
|
275
|
+
mediaProgressDuration: "Test string",
|
|
276
|
+
mediaProgressPercentage: 42,
|
|
277
|
+
},
|
|
278
|
+
pageInfo: {
|
|
279
|
+
pageCategory: "Test string",
|
|
280
|
+
pageviewId: "Test string",
|
|
281
|
+
referrerUri: "Test string",
|
|
282
|
+
uri: "Test string",
|
|
283
|
+
},
|
|
284
|
+
panel: {
|
|
285
|
+
displayName: "Test string",
|
|
286
|
+
panelId: "Test string",
|
|
287
|
+
panelPosition: 42,
|
|
288
|
+
totalPanels: 42,
|
|
289
|
+
},
|
|
290
|
+
promotionIds: [
|
|
291
|
+
"Test string"
|
|
292
|
+
],
|
|
293
|
+
searchInfo: {
|
|
294
|
+
offset: 42,
|
|
295
|
+
orderBy: "Test string",
|
|
296
|
+
searchQuery: "Test string",
|
|
297
|
+
},
|
|
298
|
+
sessionId: "Test string",
|
|
299
|
+
tagIds: [
|
|
300
|
+
"Test string"
|
|
301
|
+
],
|
|
302
|
+
transactionInfo: {
|
|
303
|
+
cost: 42,
|
|
304
|
+
currency: "Test string",
|
|
305
|
+
discountValue: 42,
|
|
306
|
+
tax: 42,
|
|
307
|
+
transactionId: "Test string",
|
|
308
|
+
value: 42,
|
|
309
|
+
},
|
|
310
|
+
userInfo: {
|
|
311
|
+
userAgent: "Test string",
|
|
312
|
+
userId: "Test string",
|
|
313
|
+
},
|
|
314
|
+
userPseudoId: "Test string",
|
|
315
|
+
}
|
|
316
|
+
],
|
|
317
|
+
},
|
|
318
|
+
});
|
|
319
|
+
/** Writes a single user event. */
|
|
320
|
+
await gapi.client.discoveryengine.projects.locations.collections.dataStores.userEvents.write({
|
|
321
|
+
parent: "Test string",
|
|
322
|
+
}, {
|
|
323
|
+
attributes: {
|
|
324
|
+
A: {
|
|
325
|
+
numbers: [
|
|
326
|
+
42
|
|
327
|
+
],
|
|
328
|
+
text: [
|
|
329
|
+
"Test string"
|
|
330
|
+
],
|
|
331
|
+
}
|
|
332
|
+
},
|
|
333
|
+
attributionToken: "Test string",
|
|
334
|
+
completionInfo: {
|
|
335
|
+
selectedPosition: 42,
|
|
336
|
+
selectedSuggestion: "Test string",
|
|
337
|
+
},
|
|
338
|
+
directUserRequest: true,
|
|
339
|
+
documents: [
|
|
340
|
+
{
|
|
341
|
+
id: "Test string",
|
|
342
|
+
name: "Test string",
|
|
343
|
+
promotionIds: [
|
|
344
|
+
"Test string"
|
|
345
|
+
],
|
|
346
|
+
quantity: 42,
|
|
347
|
+
}
|
|
348
|
+
],
|
|
349
|
+
eventTime: "Test string",
|
|
350
|
+
eventType: "Test string",
|
|
351
|
+
filter: "Test string",
|
|
352
|
+
mediaInfo: {
|
|
353
|
+
mediaProgressDuration: "Test string",
|
|
354
|
+
mediaProgressPercentage: 42,
|
|
355
|
+
},
|
|
356
|
+
pageInfo: {
|
|
357
|
+
pageCategory: "Test string",
|
|
358
|
+
pageviewId: "Test string",
|
|
359
|
+
referrerUri: "Test string",
|
|
360
|
+
uri: "Test string",
|
|
361
|
+
},
|
|
362
|
+
panel: {
|
|
363
|
+
displayName: "Test string",
|
|
364
|
+
panelId: "Test string",
|
|
365
|
+
panelPosition: 42,
|
|
366
|
+
totalPanels: 42,
|
|
367
|
+
},
|
|
368
|
+
promotionIds: [
|
|
369
|
+
"Test string"
|
|
370
|
+
],
|
|
371
|
+
searchInfo: {
|
|
372
|
+
offset: 42,
|
|
373
|
+
orderBy: "Test string",
|
|
374
|
+
searchQuery: "Test string",
|
|
375
|
+
},
|
|
376
|
+
sessionId: "Test string",
|
|
377
|
+
tagIds: [
|
|
378
|
+
"Test string"
|
|
379
|
+
],
|
|
380
|
+
transactionInfo: {
|
|
381
|
+
cost: 42,
|
|
382
|
+
currency: "Test string",
|
|
383
|
+
discountValue: 42,
|
|
384
|
+
tax: 42,
|
|
385
|
+
transactionId: "Test string",
|
|
386
|
+
value: 42,
|
|
387
|
+
},
|
|
388
|
+
userInfo: {
|
|
389
|
+
userAgent: "Test string",
|
|
390
|
+
userId: "Test string",
|
|
391
|
+
},
|
|
392
|
+
userPseudoId: "Test string",
|
|
393
|
+
});
|
|
32
394
|
/** Creates a Document. */
|
|
33
395
|
await gapi.client.discoveryengine.projects.locations.dataStores.branches.documents.create({
|
|
34
396
|
documentId: "Test string",
|