Vertex AI Search for Retail API (retail:v2beta)

2024-09-24

5 new methods

Additions

    Methods
  • retail.projects.locations.catalogs.updateGenerativeQuestionFeature

      Path: v2beta/{+catalog}/generativeQuestionFeature

      Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestionFeature

      HTTP Method: PATCH

      Parameters:

        catalog

          Description: Required. Resource name of the affected catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}

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

          Location: path

          Required: Yes

          Type: string

        updateMask

          Description: Optional. Indicates which fields in the provided GenerativeQuestionsFeatureConfig to update. If not set or empty, all supported fields are updated.

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: catalog

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

      Description: Manages overal generative question feature state -- enables toggling feature on and off.

  • retail.projects.locations.catalogs.getGenerativeQuestionFeature

      Path: v2beta/{+catalog}/generativeQuestionFeature

      Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestionFeature

      HTTP Method: GET

      Parameters:

        catalog

          Description: Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: catalog

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

      Description: Manages overal generative question feature state -- enables toggling feature on and off.

  • retail.projects.locations.catalogs.updateGenerativeQuestion

      Path: v2beta/{+catalog}/generativeQuestion

      Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestion

      HTTP Method: PATCH

      Parameters:

        catalog

          Description: Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}

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

          Location: path

          Required: Yes

          Type: string

        updateMask

          Description: Optional. Indicates which fields in the provided GenerativeQuestionConfig to update. The following are NOT supported: * GenerativeQuestionConfig.frequency If not set or empty, all supported fields are updated.

          Location: query

          Type: string

          Format: google-fieldmask

      Parameter Order: catalog

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

      Description: Allows management of individual questions.

  • retail.projects.locations.catalogs.generativeQuestions.list

      Path: v2beta/{+parent}/generativeQuestions

      Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestions

      HTTP Method: GET

      Parameters:

        parent

          Description: Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: parent

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

      Description: Returns all questions for a given catalog.

  • retail.projects.locations.catalogs.generativeQuestion.batchUpdate

      Path: v2beta/{+parent}/generativeQuestion:batchUpdate

      Flat Path: v2beta/projects/{projectsId}/locations/{locationsId}/catalogs/{catalogsId}/generativeQuestion:batchUpdate

      HTTP Method: POST

      Parameters:

        parent

          Description: Optional. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}

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

          Location: path

          Required: Yes

          Type: string

      Parameter Order: parent

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

      Description: Allows management of multiple questions.