Discovery Engine API (discoveryengine:v1alpha)

2024-04-17

5 new methods

Additions

    Methods
  • discoveryengine.projects.get

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}

      HTTP Method: GET

      Parameters:

        name

          Description: Required. Full resource name of a Project, such as `projects/{project_id_or_number}`.

          Pattern: ^projects/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Gets a Project. Returns NOT_FOUND when the project is not yet created.

  • discoveryengine.projects.provision

      Path: v1alpha/{+name}:provision

      Flat Path: v1alpha/projects/{projectsId}:provision

      HTTP Method: POST

      Parameters:

        name

          Description: Required. Full resource name of a Project, such as `projects/{project_id_or_number}`.

          Pattern: ^projects/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: name

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

      Description: Provisions the project resource. During the process, related systems will get prepared and initialized. Caller must read the [Terms for data use](https://cloud.google.com/retail/data-use-terms), and optionally specify in request to provide consent to that service terms.

  • discoveryengine.projects.reportConsentChange

      Path: v1alpha/{+project}:reportConsentChange

      Flat Path: v1alpha/projects/{projectsId}:reportConsentChange

      HTTP Method: POST

      Parameters:

        project

          Description: Required. Full resource name of a Project, such as `projects/{project_id_or_number}`.

          Pattern: ^projects/[^/]+$

          Location: path

          Required: Yes

          Type: string

      Parameter Order: project

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

      Description: Updates service terms for this project. This method can be used to retroactively accept the latest terms. Terms available for update: * [Terms for data use](https://cloud.google.com/retail/data-use-terms)

  • discoveryengine.projects.locations.sampleQuerySets.operations.get

      Path: v1alpha/{+name}

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/sampleQuerySets/{sampleQuerySetsId}/operations/{operationsId}

      HTTP Method: GET

      Parameters:

        name

          Description: The name of the operation resource.

          Pattern: ^projects/[^/]+/locations/[^/]+/sampleQuerySets/[^/]+/operations/[^/]+$

          Location: path

          Required: Yes

          Type: string

      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.

  • discoveryengine.projects.locations.userEvents.write

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

      Flat Path: v1alpha/projects/{projectsId}/locations/{locationsId}/userEvents:write

      HTTP Method: POST

      Parameters:

        parent

          Description: Required. The parent resource name. If the write user event action is applied in DataStore level, the format is: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`. If the write user event action is applied in Location level, for example, the event with Document across multiple DataStore, the format is: `projects/{project}/locations/{location}`.

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: parent

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

      Description: Writes a single user event.