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