Discovery Engine API (discoveryengine:v1alpha)

Additions

Methods


• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.userEvents.collect

  Path: v1alpha/{+parent}/userEvents:collect

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:collect

  Parameters:

  userEvent

  Location: query

  Description: Required. URL encoded UserEvent proto with a length limit of 2,000,000 characters.

  Type: string

  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

  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

  parent

  Required: Yes

  Location: path

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$

  Description: Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.

  HTTP Method: GET

  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.

  Parameter Order: parent

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.userEvents.import

  Parameters:

  parent

  Location: path

  Required: Yes

  Description: Required. Parent DataStore resource name, of the form `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$

  HTTP Method: POST

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:import

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Parameter Order: parent

  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.

  Path: v1alpha/{+parent}/userEvents:import

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.userEvents.write

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/userEvents:write

  HTTP Method: POST

  Description: Writes a single user event.

  Parameter Order: parent

  Parameters:

  parent

  Type: string

  Required: Yes

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+$

  Description: Required. The parent DataStore resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.

  Path: v1alpha/{+parent}/userEvents:write

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.servingConfigs.recommend

  HTTP Method: POST

  Description: Makes a recommendation, which requires a contextual user event.

  Parameter Order: servingConfig

  Path: v1alpha/{+servingConfig}:recommend

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Parameters:

  servingConfig

  Required: Yes

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/servingConfigs/[^/]+$

  Type: string

  Description: Required. Full resource name of the format: projects/*/locations/global/collections/*/dataStores/*/servingConfigs/* Before you can request recommendations from your model, you must create at least one serving config for it.

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/servingConfigs/{servingConfigsId}:recommend

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.import

  Parameter Order: parent

  Parameters:

  parent

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$

  Description: Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Requires create/update permission.

  Type: string

  Location: path

  Required: Yes

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents:import

  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.

  Path: v1alpha/{+parent}/documents:import

  HTTP Method: POST

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.get

  HTTP Method: GET

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}

  Parameter Order: name

  Path: v1alpha/{+name}

  Description: Gets a Document.

  Parameters:

  name

  Type: string

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$

  Description: Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to access the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the requested Document does not exist, a NOT_FOUND error is returned.

  Location: path

  Required: Yes

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.list

  Path: v1alpha/{+parent}/documents

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents

  Description: Gets a list of Documents.

  HTTP Method: GET

  Parameter Order: parent

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Parameters:

  parent

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$

  Type: string

  Required: Yes

  Description: Required. The parent branch resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`. Use `default_branch` as the branch ID, to list documents under the default branch. If the caller does not have permission to list Documentss under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED 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

  pageSize

  Format: int32

  Location: query

  Type: integer

  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.

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.patch

  Parameter Order: name

  HTTP Method: PATCH

  Path: v1alpha/{+name}

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Parameters:

  allowMissing

  Type: boolean

  Location: query

  Description: If set to true, and the Document is not found, a new Document will be created.

  name

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$

  Required: Yes

  Location: path

  Type: string

  Description: Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}

  Description: Updates a Document.

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.delete

  HTTP Method: DELETE

  Description: Deletes a Document.

  Parameter Order: name

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents/{documentsId}

  Path: v1alpha/{+name}

  Parameters:

  name

  Type: string

  Required: Yes

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+/documents/[^/]+$

  Description: Required. Full resource name of Document, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document}`. If the caller does not have permission to delete the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. If the Document to delete does not exist, a NOT_FOUND error is returned.

  Location: path

  Scopes: https://www.googleapis.com/auth/cloud-platform

• ▼ ▲ discoveryengine.projects.locations.collections.dataStores.branches.documents.create

  Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/branches/{branchesId}/documents

  HTTP Method: POST

  Parameters:

  parent

  Required: Yes

  Type: string

  Description: Required. The parent resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.

  Location: path

  Pattern: ^projects/[^/]+/locations/[^/]+/collections/[^/]+/dataStores/[^/]+/branches/[^/]+$

  documentId

  Location: query

  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.

  Type: string

  Description: Creates a Document.

  Scopes: https://www.googleapis.com/auth/cloud-platform

  Parameter Order: parent

  Path: v1alpha/{+parent}/documents