Vertex AI Search for Retail API . projects . locations . catalogs . generativeQuestion

batchUpdate(parent, body=None, x__xgafv=None)

Allows management of multiple questions.

Args:
  parent: string, Optional. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog} (required)
  body: object, The request body.
    The object takes the form of:

{ # Request for BatchUpdateGenerativeQuestionConfig method.
  "requests": [ # Required. The updates question configs.
    { # Request for UpdateGenerativeQuestionConfig method.
      "generativeQuestionConfig": { # Configuration for a single generated question. # Required. The question to update.
        "allowedInConversation": True or False, # Optional. Whether the question is asked at serving time.
        "catalog": "A String", # Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
        "exampleValues": [ # Output only. Values that can be used to answer the question.
          "A String",
        ],
        "facet": "A String", # Required. The facet to which the question is associated.
        "finalQuestion": "A String", # Optional. The question that will be used at serving time. Question can have a max length of 300 bytes. When not populated, generated_question should be used.
        "frequency": 3.14, # Output only. The ratio of how often a question was asked.
        "generatedQuestion": "A String", # Output only. The LLM generated question.
      },
      "updateMask": "A String", # 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.
    },
  ],
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Aggregated response for UpdateGenerativeQuestionConfig method.
  "generativeQuestionConfigs": [ # Optional. The updates question configs.
    { # Configuration for a single generated question.
      "allowedInConversation": True or False, # Optional. Whether the question is asked at serving time.
      "catalog": "A String", # Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
      "exampleValues": [ # Output only. Values that can be used to answer the question.
        "A String",
      ],
      "facet": "A String", # Required. The facet to which the question is associated.
      "finalQuestion": "A String", # Optional. The question that will be used at serving time. Question can have a max length of 300 bytes. When not populated, generated_question should be used.
      "frequency": 3.14, # Output only. The ratio of how often a question was asked.
      "generatedQuestion": "A String", # Output only. The LLM generated question.
    },
  ],
}

close()

Close httplib2 connections.