• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1type: google.api.Service
2config_version: 3
3name: discoveryengine.googleapis.com
4title: Discovery Engine API
5
6apis:
7- name: google.cloud.discoveryengine.v1beta.CompletionService
8- name: google.cloud.discoveryengine.v1beta.ConversationalSearchService
9- name: google.cloud.discoveryengine.v1beta.DataStoreService
10- name: google.cloud.discoveryengine.v1beta.DocumentService
11- name: google.cloud.discoveryengine.v1beta.EngineService
12- name: google.cloud.discoveryengine.v1beta.GroundedGenerationService
13- name: google.cloud.discoveryengine.v1beta.RankService
14- name: google.cloud.discoveryengine.v1beta.RecommendationService
15- name: google.cloud.discoveryengine.v1beta.SchemaService
16- name: google.cloud.discoveryengine.v1beta.SearchService
17- name: google.cloud.discoveryengine.v1beta.SearchTuningService
18- name: google.cloud.discoveryengine.v1beta.ServingConfigService
19- name: google.cloud.discoveryengine.v1beta.SiteSearchEngineService
20- name: google.cloud.discoveryengine.v1beta.UserEventService
21- name: google.cloud.location.Locations
22- name: google.longrunning.Operations
23
24types:
25- name: google.cloud.discoveryengine.logging.ErrorLog
26- name: google.cloud.discoveryengine.v1beta.BatchCreateTargetSiteMetadata
27- name: google.cloud.discoveryengine.v1beta.BatchCreateTargetSitesResponse
28- name: google.cloud.discoveryengine.v1beta.CreateDataStoreMetadata
29- name: google.cloud.discoveryengine.v1beta.CreateEngineMetadata
30- name: google.cloud.discoveryengine.v1beta.CreateSchemaMetadata
31- name: google.cloud.discoveryengine.v1beta.CreateTargetSiteMetadata
32- name: google.cloud.discoveryengine.v1beta.DataStore
33- name: google.cloud.discoveryengine.v1beta.DeleteDataStoreMetadata
34- name: google.cloud.discoveryengine.v1beta.DeleteEngineMetadata
35- name: google.cloud.discoveryengine.v1beta.DeleteSchemaMetadata
36- name: google.cloud.discoveryengine.v1beta.DeleteTargetSiteMetadata
37- name: google.cloud.discoveryengine.v1beta.DisableAdvancedSiteSearchMetadata
38- name: google.cloud.discoveryengine.v1beta.DisableAdvancedSiteSearchResponse
39- name: google.cloud.discoveryengine.v1beta.EnableAdvancedSiteSearchMetadata
40- name: google.cloud.discoveryengine.v1beta.EnableAdvancedSiteSearchResponse
41- name: google.cloud.discoveryengine.v1beta.Engine
42- name: google.cloud.discoveryengine.v1beta.ImportDocumentsMetadata
43- name: google.cloud.discoveryengine.v1beta.ImportDocumentsResponse
44- name: google.cloud.discoveryengine.v1beta.ImportSuggestionDenyListEntriesMetadata
45- name: google.cloud.discoveryengine.v1beta.ImportSuggestionDenyListEntriesResponse
46- name: google.cloud.discoveryengine.v1beta.ImportUserEventsMetadata
47- name: google.cloud.discoveryengine.v1beta.ImportUserEventsResponse
48- name: google.cloud.discoveryengine.v1beta.PurgeDocumentsMetadata
49- name: google.cloud.discoveryengine.v1beta.PurgeDocumentsResponse
50- name: google.cloud.discoveryengine.v1beta.PurgeSuggestionDenyListEntriesMetadata
51- name: google.cloud.discoveryengine.v1beta.PurgeSuggestionDenyListEntriesResponse
52- name: google.cloud.discoveryengine.v1beta.Schema
53- name: google.cloud.discoveryengine.v1beta.TargetSite
54- name: google.cloud.discoveryengine.v1beta.TrainCustomModelMetadata
55- name: google.cloud.discoveryengine.v1beta.TrainCustomModelResponse
56- name: google.cloud.discoveryengine.v1beta.TuneEngineMetadata
57- name: google.cloud.discoveryengine.v1beta.TuneEngineResponse
58- name: google.cloud.discoveryengine.v1beta.UpdateSchemaMetadata
59- name: google.cloud.discoveryengine.v1beta.UpdateTargetSiteMetadata
60
61documentation:
62  summary: Discovery Engine API.
63
64http:
65  rules:
66  - selector: google.longrunning.Operations.GetOperation
67    get: '/v1beta/{name=projects/*/locations/*/collections/*/dataConnector/operations/*}'
68    additional_bindings:
69    - get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*/operations/*}'
70    - get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/models/*/operations/*}'
71    - get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/operations/*}'
72    - get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*/operations/*}'
73    - get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/operations/*}'
74    - get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites/operations/*}'
75    - get: '/v1beta/{name=projects/*/locations/*/collections/*/engines/*/operations/*}'
76    - get: '/v1beta/{name=projects/*/locations/*/collections/*/operations/*}'
77    - get: '/v1beta/{name=projects/*/locations/*/dataStores/*/branches/*/operations/*}'
78    - get: '/v1beta/{name=projects/*/locations/*/dataStores/*/models/*/operations/*}'
79    - get: '/v1beta/{name=projects/*/locations/*/dataStores/*/operations/*}'
80    - get: '/v1beta/{name=projects/*/locations/*/operations/*}'
81    - get: '/v1beta/{name=projects/*/operations/*}'
82  - selector: google.longrunning.Operations.ListOperations
83    get: '/v1beta/{name=projects/*/locations/*/collections/*/dataConnector}/operations'
84    additional_bindings:
85    - get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/branches/*}/operations'
86    - get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/models/*}/operations'
87    - get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/schemas/*}/operations'
88    - get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine/targetSites}/operations'
89    - get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*/siteSearchEngine}/operations'
90    - get: '/v1beta/{name=projects/*/locations/*/collections/*/dataStores/*}/operations'
91    - get: '/v1beta/{name=projects/*/locations/*/collections/*/engines/*}/operations'
92    - get: '/v1beta/{name=projects/*/locations/*/collections/*}/operations'
93    - get: '/v1beta/{name=projects/*/locations/*/dataStores/*/branches/*}/operations'
94    - get: '/v1beta/{name=projects/*/locations/*/dataStores/*/models/*}/operations'
95    - get: '/v1beta/{name=projects/*/locations/*/dataStores/*}/operations'
96    - get: '/v1beta/{name=projects/*/locations/*}/operations'
97    - get: '/v1beta/{name=projects/*}/operations'
98
99authentication:
100  rules:
101  - selector: 'google.cloud.discoveryengine.v1beta.CompletionService.*'
102    oauth:
103      canonical_scopes: |-
104        https://www.googleapis.com/auth/cloud-platform
105  - selector: 'google.cloud.discoveryengine.v1beta.ConversationalSearchService.*'
106    oauth:
107      canonical_scopes: |-
108        https://www.googleapis.com/auth/cloud-platform
109  - selector: 'google.cloud.discoveryengine.v1beta.DataStoreService.*'
110    oauth:
111      canonical_scopes: |-
112        https://www.googleapis.com/auth/cloud-platform
113  - selector: 'google.cloud.discoveryengine.v1beta.DocumentService.*'
114    oauth:
115      canonical_scopes: |-
116        https://www.googleapis.com/auth/cloud-platform
117  - selector: 'google.cloud.discoveryengine.v1beta.EngineService.*'
118    oauth:
119      canonical_scopes: |-
120        https://www.googleapis.com/auth/cloud-platform
121  - selector: google.cloud.discoveryengine.v1beta.GroundedGenerationService.CheckGrounding
122    oauth:
123      canonical_scopes: |-
124        https://www.googleapis.com/auth/cloud-platform
125  - selector: google.cloud.discoveryengine.v1beta.RankService.Rank
126    oauth:
127      canonical_scopes: |-
128        https://www.googleapis.com/auth/cloud-platform
129  - selector: google.cloud.discoveryengine.v1beta.RecommendationService.Recommend
130    oauth:
131      canonical_scopes: |-
132        https://www.googleapis.com/auth/cloud-platform
133  - selector: 'google.cloud.discoveryengine.v1beta.SchemaService.*'
134    oauth:
135      canonical_scopes: |-
136        https://www.googleapis.com/auth/cloud-platform
137  - selector: google.cloud.discoveryengine.v1beta.SearchService.Search
138    oauth:
139      canonical_scopes: |-
140        https://www.googleapis.com/auth/cloud-platform
141  - selector: google.cloud.discoveryengine.v1beta.SearchTuningService.TrainCustomModel
142    oauth:
143      canonical_scopes: |-
144        https://www.googleapis.com/auth/cloud-platform
145  - selector: 'google.cloud.discoveryengine.v1beta.ServingConfigService.*'
146    oauth:
147      canonical_scopes: |-
148        https://www.googleapis.com/auth/cloud-platform
149  - selector: 'google.cloud.discoveryengine.v1beta.SiteSearchEngineService.*'
150    oauth:
151      canonical_scopes: |-
152        https://www.googleapis.com/auth/cloud-platform
153  - selector: 'google.cloud.discoveryengine.v1beta.UserEventService.*'
154    oauth:
155      canonical_scopes: |-
156        https://www.googleapis.com/auth/cloud-platform
157  - selector: google.longrunning.Operations.GetOperation
158    oauth:
159      canonical_scopes: |-
160        https://www.googleapis.com/auth/cloud-platform
161  - selector: google.longrunning.Operations.ListOperations
162    oauth:
163      canonical_scopes: |-
164        https://www.googleapis.com/auth/cloud-platform
165
166publishing:
167  new_issue_uri: https://issuetracker.google.com/issues/new?component=911831&template=1480251
168  documentation_uri: https://cloud.google.com/generative-ai-app-builder/docs
169  api_short_name: discoveryengine
170  github_label: 'api: discoveryengine'
171  doc_tag_prefix: discoveryengine
172  organization: CLOUD
173  library_settings:
174  - version: google.cloud.discoveryengine.v1beta
175    launch_stage: BETA
176    java_settings:
177      common:
178        destinations:
179        - PACKAGE_MANAGER
180    cpp_settings:
181      common:
182        destinations:
183        - PACKAGE_MANAGER
184    php_settings:
185      common:
186        destinations:
187        - PACKAGE_MANAGER
188    python_settings:
189      common:
190        destinations:
191        - PACKAGE_MANAGER
192    node_settings:
193      common:
194        destinations:
195        - PACKAGE_MANAGER
196    dotnet_settings:
197      common:
198        destinations:
199        - PACKAGE_MANAGER
200    ruby_settings:
201      common:
202        destinations:
203        - PACKAGE_MANAGER
204    go_settings:
205      common:
206        destinations:
207        - PACKAGE_MANAGER
208  proto_reference_documentation_uri: https://cloud.google.com/generative-ai-app-builder/docs/reference/rpc
209