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

Instance Methods

close()

Close httplib2 connections.

list(parent, x__xgafv=None)

Returns all questions for a given catalog.

Method Details

close()
Close httplib2 connections.
list(parent, x__xgafv=None)
Returns all questions for a given catalog.

Args:
  parent: string, Required. Resource name of the parent catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog} (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListQuestions method.
  "generativeQuestionConfigs": [ # All the questions for a given catalog.
    { # 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.
    },
  ],
}