2022-11-05
▼ ▲ discoveryengine.projects.locations.dataStores.operations.get
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations/{operationsId}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
Parameters:
name
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Location: path
Type: string
Required: Yes
Path: v1beta/{+name}
HTTP Method: GET
▼ ▲ discoveryengine.projects.locations.dataStores.operations.list
Parameters:
pageSize
Format: int32
Description: The standard list page size.
Location: query
Type: integer
pageToken
Type: string
Description: The standard list page token.
Location: query
name
Type: string
Description: The name of the operation's parent resource.
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
filter
Type: string
Location: query
Description: The standard list filter.
HTTP Method: GET
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Path: v1beta/{+name}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/operations
▼ ▲ discoveryengine.projects.locations.dataStores.servingConfigs.recommend
Path: v1beta/{+servingConfig}:recommend
HTTP Method: POST
Description: Makes a recommendation, which requires a contextual user event.
Parameter Order: servingConfig
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend
Parameters:
servingConfig
Description: Required. Full resource name of the format: projects/*/locations/global/dataStores/*/servingConfigs/* Before you can request recommendations from your model, you must create at least one serving config for it.
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$
Location: path
▼ ▲ discoveryengine.projects.locations.dataStores.userEvents.write
HTTP Method: POST
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
Location: path
Description: Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}`.
Type: string
Required: Yes
Parameter Order: parent
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+parent}/userEvents:write
Description: Writes a single user event.
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:write
▼ ▲ discoveryengine.projects.locations.dataStores.userEvents.import
HTTP Method: POST
Path: v1beta/{+parent}/userEvents:import
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: parent
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:import
Description: 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.
Parameters:
parent
Description: Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/dataStores/{data_store}`
Required: Yes
Type: string
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
▼ ▲ discoveryengine.projects.locations.dataStores.userEvents.collect
Scopes: https://www.googleapis.com/auth/cloud-platform
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/userEvents:collect
Parameter Order: parent
Path: v1beta/{+parent}/userEvents:collect
Description: 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 API JavaScript pixel and Google Tag Manager. Users should not call this method directly.
HTTP Method: GET
Parameters:
ets
Description: The event timestamp in milliseconds. This prevents browser caching of otherwise identical get requests. The name is abbreviated to reduce the payload bytes.
Type: string
Format: int64
Location: query
parent
Description: Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}`.
Required: Yes
Location: path
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+$
userEvent
Location: query
Type: string
Description: Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.
uri
Type: string
Description: 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 only send the domain for 3rd party requests.
Location: query
▼ ▲ discoveryengine.projects.locations.dataStores.models.operations.get
Parameters:
name
Location: path
Description: The name of the operation resource.
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/models/[^/]+/operations/[^/]+$
Type: string
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Parameter Order: name
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations/{operationsId}
Description: 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.
Path: v1beta/{+name}
▼ ▲ discoveryengine.projects.locations.dataStores.models.operations.list
Path: v1beta/{+name}/operations
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/models/{modelsId}/operations
Parameters:
pageToken
Description: The standard list page token.
Type: string
Location: query
filter
Location: query
Type: string
Description: The standard list filter.
pageSize
Type: integer
Location: query
Description: The standard list page size.
Format: int32
name
Type: string
Required: Yes
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/models/[^/]+$
Description: The name of the operation's parent resource.
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
HTTP Method: GET
▼ ▲ discoveryengine.projects.locations.dataStores.branches.operations.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
pageToken
Location: query
Type: string
Description: The standard list page token.
pageSize
Description: The standard list page size.
Location: query
Type: integer
Format: int32
name
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$
Type: string
Description: The name of the operation's parent resource.
Required: Yes
filter
Description: The standard list filter.
Type: string
Location: query
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameter Order: name
Path: v1beta/{+name}/operations
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations
HTTP Method: GET
▼ ▲ discoveryengine.projects.locations.dataStores.branches.operations.get
HTTP Method: GET
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/operations/[^/]+$
Description: The name of the operation resource.
Required: Yes
Location: path
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/operations/{operationsId}
Path: v1beta/{+name}
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Description: 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.
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.patch
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameters:
allowMissing
Description: If set to true, and the Document is not found, a new Document will be created.
Type: boolean
Location: query
name
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$
Location: path
Required: Yes
Type: string
Description: Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
HTTP Method: PATCH
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}
Parameter Order: name
Description: Updates a Document.
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.create
Parameter Order: parent
Description: Creates a Document.
HTTP Method: POST
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+parent}/documents
Parameters:
documentId
Location: query
Type: string
Description: 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.
parent
Location: path
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$
Required: Yes
Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`.
Type: string
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.list
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: GET
Path: v1beta/{+parent}/documents
Description: Gets a list of Documents.
Parameters:
parent
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$
Type: string
Location: path
Required: Yes
Description: Required. The parent branch resource name, such as `projects/{project}/locations/{location}/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 Documentss under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
pageSize
Type: integer
Location: query
Format: int32
Description: 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.
pageToken
Location: query
Description: 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.
Type: string
Parameter Order: parent
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.import
Parameters:
parent
Description: Required. The parent branch resource name, such as `projects/{project}/locations/{location}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission.
Location: path
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+$
Description: 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.
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: POST
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import
Parameter Order: parent
Path: v1beta/{+parent}/documents:import
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.get
HTTP Method: GET
Path: v1beta/{+name}
Parameter Order: name
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}
Parameters:
name
Location: path
Description: Required. Full resource name of Document, such as `projects/{project}/locations/{location}/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.
Type: string
Required: Yes
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Gets a Document.
▼ ▲ discoveryengine.projects.locations.dataStores.branches.documents.delete
Parameters:
name
Type: string
Required: Yes
Location: path
Description: Required. Full resource name of Document, such as `projects/{project}/locations/{location}/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.
Pattern: ^projects/[^/]+/locations/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$
Description: Deletes a Document.
Path: v1beta/{+name}
Parameter Order: name
Scopes: https://www.googleapis.com/auth/cloud-platform
HTTP Method: DELETE
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}
▼ ▲ discoveryengine.projects.locations.operations.get
Parameters:
name
Required: Yes
Type: string
Pattern: ^projects/[^/]+/locations/[^/]+/operations/[^/]+$
Location: path
Description: The name of the operation resource.
Description: 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.
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Parameter Order: name
Path: v1beta/{+name}
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}
▼ ▲ discoveryengine.projects.locations.operations.list
Scopes: https://www.googleapis.com/auth/cloud-platform
Path: v1beta/{+name}/operations
Parameters:
pageToken
Description: The standard list page token.
Type: string
Location: query
pageSize
Format: int32
Type: integer
Location: query
Description: The standard list page size.
name
Pattern: ^projects/[^/]+/locations/[^/]+$
Description: The name of the operation's parent resource.
Required: Yes
Location: path
Type: string
filter
Type: string
Description: The standard list filter.
Location: query
Flat Path: v1beta/projects/{projectsId}/locations/{locationsId}/operations
Parameter Order: name
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
HTTP Method: GET
▼ ▲ discoveryengine.projects.operations.get
Path: v1beta/{+name}
HTTP Method: GET
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: 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.
Flat Path: v1beta/projects/{projectsId}/operations/{operationsId}
Parameters:
name
Type: string
Pattern: ^projects/[^/]+/operations/[^/]+$
Location: path
Required: Yes
Description: The name of the operation resource.
Parameter Order: name
▼ ▲ discoveryengine.projects.operations.list
Parameters:
pageSize
Location: query
Format: int32
Description: The standard list page size.
Type: integer
name
Type: string
Required: Yes
Description: The name of the operation's parent resource.
Pattern: ^projects/[^/]+$
Location: path
pageToken
Type: string
Description: The standard list page token.
Location: query
filter
Description: The standard list filter.
Location: query
Type: string
Parameter Order: name
Flat Path: v1beta/projects/{projectsId}/operations
Scopes: https://www.googleapis.com/auth/cloud-platform
Description: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`. NOTE: the `name` binding allows API services to override the binding to use different resource name schemes, such as `users/*/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/*}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Path: v1beta/{+name}/operations
HTTP Method: GET