Discovery Engine API (discoveryengine:v1)

2024-08-14

4 new methods

Additions

    Methods
  • discoveryengine.projects.locations.collections.dataStores.trainCustomModel

      Path : v1/{+dataStore}:trainCustomModel

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}:trainCustomModel

      HTTP Method : POST

      Parameters :

        dataStore

          Description : Required. The resource name of the Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to train the models.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : dataStore

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

      Description : Trains a custom model.

  • discoveryengine.projects.locations.collections.dataStores.branches.batchGetDocumentsMetadata

      Path : v1/{+parent}/batchGetDocumentsMetadata

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

      HTTP Method : GET

      Parameters :

        parent

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

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

          Location : path

          Required : Yes

          Type : string

        matcher.urisMatcher.uris

          Description : The exact URIs to match by.

          Location : query

          Repeated : Yes

          Type : string

      Parameter Order : parent

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

      Description : Gets index freshness metadata for Documents. Supported for website search only.

  • discoveryengine.projects.locations.collections.dataStores.customModels.list

      Path : v1/{+dataStore}/customModels

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/collections/{collectionsId}/dataStores/{dataStoresId}/customModels

      HTTP Method : GET

      Parameters :

        dataStore

          Description : Required. The resource name of the parent Data Store, such as `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`. This field is used to identify the data store where to fetch the models from.

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

          Location : path

          Required : Yes

          Type : string

      Parameter Order : dataStore

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

      Description : Gets a list of all the custom models.

  • discoveryengine.projects.locations.dataStores.branches.batchGetDocumentsMetadata

      Path : v1/{+parent}/batchGetDocumentsMetadata

      Flat Path : v1/projects/{projectsId}/locations/{locationsId}/dataStores/{dataStoresId}/branches/{branchesId}/batchGetDocumentsMetadata

      HTTP Method : GET

      Parameters :

        parent

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

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

          Location : path

          Required : Yes

          Type : string

        matcher.urisMatcher.uris

          Description : The exact URIs to match by.

          Location : query

          Repeated : Yes

          Type : string

      Parameter Order : parent

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

      Description : Gets index freshness metadata for Documents. Supported for website search only.