File: retail_v2.projects.locations.catalogs.generativeQuestion.html

package info (click to toggle)
python-googleapi 2.180.0-1
  • links: PTS
  • area: main
  • in suites: forky
  • size: 527,124 kB
  • sloc: python: 11,076; javascript: 249; sh: 114; makefile: 59
file content (142 lines) | stat: -rw-r--r-- 5,023 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<html><body>
<style>

body, h1, h2, h3, div, span, p, pre, a {
  margin: 0;
  padding: 0;
  border: 0;
  font-weight: inherit;
  font-style: inherit;
  font-size: 100%;
  font-family: inherit;
  vertical-align: baseline;
}

body {
  font-size: 13px;
  padding: 1em;
}

h1 {
  font-size: 26px;
  margin-bottom: 1em;
}

h2 {
  font-size: 24px;
  margin-bottom: 1em;
}

h3 {
  font-size: 20px;
  margin-bottom: 1em;
  margin-top: 1em;
}

pre, code {
  line-height: 1.5;
  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}

pre {
  margin-top: 0.5em;
}

h1, h2, h3, p {
  font-family: Arial, sans serif;
}

h1, h2, h3 {
  border-bottom: solid #CCC 1px;
}

.toc_element {
  margin-top: 0.5em;
}

.firstline {
  margin-left: 2 em;
}

.method  {
  margin-top: 1em;
  border: solid 1px #CCC;
  padding: 1em;
  background: #EEE;
}

.details {
  font-weight: bold;
  font-size: 14px;
}

</style>

<h1><a href="retail_v2.html">Vertex AI Search for commerce API</a> . <a href="retail_v2.projects.html">projects</a> . <a href="retail_v2.projects.locations.html">locations</a> . <a href="retail_v2.projects.locations.catalogs.html">catalogs</a> . <a href="retail_v2.projects.locations.catalogs.generativeQuestion.html">generativeQuestion</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
  <code><a href="#batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Allows management of multiple questions.</p>
<p class="toc_element">
  <code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<h3>Method Details</h3>
<div class="method">
    <code class="details" id="batchUpdate">batchUpdate(parent, body=None, x__xgafv=None)</code>
  <pre>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.
  &quot;requests&quot;: [ # Required. The updates question configs.
    { # Request for UpdateGenerativeQuestionConfig method.
      &quot;generativeQuestionConfig&quot;: { # Configuration for a single generated question. # Required. The question to update.
        &quot;allowedInConversation&quot;: True or False, # Optional. Whether the question is asked at serving time.
        &quot;catalog&quot;: &quot;A String&quot;, # Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
        &quot;exampleValues&quot;: [ # Output only. Values that can be used to answer the question.
          &quot;A String&quot;,
        ],
        &quot;facet&quot;: &quot;A String&quot;, # Required. The facet to which the question is associated.
        &quot;finalQuestion&quot;: &quot;A String&quot;, # 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.
        &quot;frequency&quot;: 3.14, # Output only. The ratio of how often a question was asked.
        &quot;generatedQuestion&quot;: &quot;A String&quot;, # Output only. The LLM generated question.
      },
      &quot;updateMask&quot;: &quot;A String&quot;, # 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.
  &quot;generativeQuestionConfigs&quot;: [ # Optional. The updates question configs.
    { # Configuration for a single generated question.
      &quot;allowedInConversation&quot;: True or False, # Optional. Whether the question is asked at serving time.
      &quot;catalog&quot;: &quot;A String&quot;, # Required. Resource name of the catalog. Format: projects/{project}/locations/{location}/catalogs/{catalog}
      &quot;exampleValues&quot;: [ # Output only. Values that can be used to answer the question.
        &quot;A String&quot;,
      ],
      &quot;facet&quot;: &quot;A String&quot;, # Required. The facet to which the question is associated.
      &quot;finalQuestion&quot;: &quot;A String&quot;, # 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.
      &quot;frequency&quot;: 3.14, # Output only. The ratio of how often a question was asked.
      &quot;generatedQuestion&quot;: &quot;A String&quot;, # Output only. The LLM generated question.
    },
  ],
}</pre>
</div>

<div class="method">
    <code class="details" id="close">close()</code>
  <pre>Close httplib2 connections.</pre>
</div>

</body></html>