blob: b212498bbad398b6d0aa22ddec3597c7ae6d280a [file] [log] [blame] [edit]
<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="contactcenterinsights_v1.html">Contact Center AI Insights API</a> . <a href="contactcenterinsights_v1.projects.html">projects</a> . <a href="contactcenterinsights_v1.projects.locations.html">locations</a> . <a href="contactcenterinsights_v1.projects.locations.dashboards.html">dashboards</a> . <a href="contactcenterinsights_v1.projects.locations.dashboards.charts.html">charts</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, chartId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Chart.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a Chart.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a Chart.</p>
<p class="toc_element">
<code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
<p class="firstline">Lists Charts.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a Chart.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, chartId=None, x__xgafv=None)</code>
<pre>Creates a Chart.
Args:
parent: string, Required. The parent resource of the chart. (required)
body: object, The request body.
The object takes the form of:
{ # Configurable dashboard&#x27;s widget that displays data as a chart.
&quot;chartType&quot;: &quot;A String&quot;, # Output only. Chart type.
&quot;chartVisualizationType&quot;: &quot;A String&quot;, # Chart visualization type.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Chart create time.
&quot;dataSource&quot;: { # The request data for visualizing the dataset in the chart.
&quot;generativeInsights&quot;: { # Request that use natural language query to generate the chart. # Use natural language query to generate the chart.
&quot;chartCheckpoint&quot;: { # The current chart checkpoint state. # The chart checkpoint used to generate the chart.
&quot;revisionId&quot;: &quot;A String&quot;, # The revision id of the chart.
&quot;sessionId&quot;: &quot;A String&quot;, # The session id of the chart.
},
&quot;chartConversations&quot;: [ # Output only. The chart conversations used to generate the chart.
{ # The conversation used to generate the chart.
&quot;conversationId&quot;: &quot;A String&quot;, # The conversation id of the chart.
&quot;createTime&quot;: &quot;A String&quot;, # The create time of the conversation.
&quot;messages&quot;: [ # Ordered list of messages, including user inputs and system responses.
{ # The message in the conversation.
&quot;createTime&quot;: &quot;A String&quot;, # For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.
&quot;messageId&quot;: &quot;A String&quot;, # The message id of the message.
&quot;systemMessage&quot;: { # A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system. # A message from the system in response to the user.
&quot;chartSpec&quot;: { # Chart spec from LLM
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;generatedSqlQuery&quot;: &quot;A String&quot;, # Raw SQL from LLM, before templatization
&quot;textOutput&quot;: { # A text output message from the system. # A direct natural language response to the user message.
&quot;texts&quot;: [ # The parts of the message.
&quot;A String&quot;,
],
&quot;type&quot;: &quot;A String&quot;, # The type of the text message.
},
},
&quot;userMessage&quot;: { # The user message. # A message from the user that is interacting with the system.
&quot;text&quot;: &quot;A String&quot;, # A message from the user that is interacting with the system.
},
},
],
&quot;updateTime&quot;: &quot;A String&quot;, # The update time of the conversation.
},
],
&quot;chartSpec&quot;: { # Chart spec for the chart.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;request&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;sqlComparisonKey&quot;: &quot;A String&quot;, # Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset.
&quot;sqlQuery&quot;: &quot;A String&quot;, # SQL query used to generate the chart.
},
&quot;queryMetrics&quot;: { # Request data that use the existing QueryMetrics. # Use the existing QueryMetrics to generate the chart.
&quot;request&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
},
},
&quot;dateRangeConfig&quot;: { # Date range configuration for dashboard charts. # Date range config applied to the chart.
&quot;absoluteDateRange&quot;: { # A time window for querying conversations. # An absolute date range.
&quot;endTime&quot;: &quot;A String&quot;, # Required. The end time of the time window.
&quot;startTime&quot;: &quot;A String&quot;, # Required. The start time of the time window.
},
&quot;relativeDateRange&quot;: { # Relative date range configuration. # A relative date range.
&quot;quantity&quot;: &quot;A String&quot;, # Required. The quantity of units in the past.
&quot;unit&quot;: &quot;A String&quot;, # Required. The unit of time.
},
},
&quot;description&quot;: &quot;A String&quot;, # Chart description
&quot;displayName&quot;: &quot;A String&quot;, # User provided display name of the chart.
&quot;filter&quot;: &quot;A String&quot;, # Filter applied to all charts in the container. Should support scope later.
&quot;height&quot;: 42, # The height of the chart in grid units.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Chart last update time.
&quot;width&quot;: 42, # The width of the chart in grid units.
}
chartId: string, Optional. A unique ID for the new Chart. This ID will become the final component of the Chart&#x27;s resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configurable dashboard&#x27;s widget that displays data as a chart.
&quot;chartType&quot;: &quot;A String&quot;, # Output only. Chart type.
&quot;chartVisualizationType&quot;: &quot;A String&quot;, # Chart visualization type.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Chart create time.
&quot;dataSource&quot;: { # The request data for visualizing the dataset in the chart.
&quot;generativeInsights&quot;: { # Request that use natural language query to generate the chart. # Use natural language query to generate the chart.
&quot;chartCheckpoint&quot;: { # The current chart checkpoint state. # The chart checkpoint used to generate the chart.
&quot;revisionId&quot;: &quot;A String&quot;, # The revision id of the chart.
&quot;sessionId&quot;: &quot;A String&quot;, # The session id of the chart.
},
&quot;chartConversations&quot;: [ # Output only. The chart conversations used to generate the chart.
{ # The conversation used to generate the chart.
&quot;conversationId&quot;: &quot;A String&quot;, # The conversation id of the chart.
&quot;createTime&quot;: &quot;A String&quot;, # The create time of the conversation.
&quot;messages&quot;: [ # Ordered list of messages, including user inputs and system responses.
{ # The message in the conversation.
&quot;createTime&quot;: &quot;A String&quot;, # For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.
&quot;messageId&quot;: &quot;A String&quot;, # The message id of the message.
&quot;systemMessage&quot;: { # A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system. # A message from the system in response to the user.
&quot;chartSpec&quot;: { # Chart spec from LLM
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;generatedSqlQuery&quot;: &quot;A String&quot;, # Raw SQL from LLM, before templatization
&quot;textOutput&quot;: { # A text output message from the system. # A direct natural language response to the user message.
&quot;texts&quot;: [ # The parts of the message.
&quot;A String&quot;,
],
&quot;type&quot;: &quot;A String&quot;, # The type of the text message.
},
},
&quot;userMessage&quot;: { # The user message. # A message from the user that is interacting with the system.
&quot;text&quot;: &quot;A String&quot;, # A message from the user that is interacting with the system.
},
},
],
&quot;updateTime&quot;: &quot;A String&quot;, # The update time of the conversation.
},
],
&quot;chartSpec&quot;: { # Chart spec for the chart.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;request&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;sqlComparisonKey&quot;: &quot;A String&quot;, # Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset.
&quot;sqlQuery&quot;: &quot;A String&quot;, # SQL query used to generate the chart.
},
&quot;queryMetrics&quot;: { # Request data that use the existing QueryMetrics. # Use the existing QueryMetrics to generate the chart.
&quot;request&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
},
},
&quot;dateRangeConfig&quot;: { # Date range configuration for dashboard charts. # Date range config applied to the chart.
&quot;absoluteDateRange&quot;: { # A time window for querying conversations. # An absolute date range.
&quot;endTime&quot;: &quot;A String&quot;, # Required. The end time of the time window.
&quot;startTime&quot;: &quot;A String&quot;, # Required. The start time of the time window.
},
&quot;relativeDateRange&quot;: { # Relative date range configuration. # A relative date range.
&quot;quantity&quot;: &quot;A String&quot;, # Required. The quantity of units in the past.
&quot;unit&quot;: &quot;A String&quot;, # Required. The unit of time.
},
},
&quot;description&quot;: &quot;A String&quot;, # Chart description
&quot;displayName&quot;: &quot;A String&quot;, # User provided display name of the chart.
&quot;filter&quot;: &quot;A String&quot;, # Filter applied to all charts in the container. Should support scope later.
&quot;height&quot;: 42, # The height of the chart in grid units.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Chart last update time.
&quot;width&quot;: 42, # The width of the chart in grid units.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a Chart.
Args:
name: string, Required. The name of the chart to delete. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a Chart.
Args:
name: string, Required. The name of the chart to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configurable dashboard&#x27;s widget that displays data as a chart.
&quot;chartType&quot;: &quot;A String&quot;, # Output only. Chart type.
&quot;chartVisualizationType&quot;: &quot;A String&quot;, # Chart visualization type.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Chart create time.
&quot;dataSource&quot;: { # The request data for visualizing the dataset in the chart.
&quot;generativeInsights&quot;: { # Request that use natural language query to generate the chart. # Use natural language query to generate the chart.
&quot;chartCheckpoint&quot;: { # The current chart checkpoint state. # The chart checkpoint used to generate the chart.
&quot;revisionId&quot;: &quot;A String&quot;, # The revision id of the chart.
&quot;sessionId&quot;: &quot;A String&quot;, # The session id of the chart.
},
&quot;chartConversations&quot;: [ # Output only. The chart conversations used to generate the chart.
{ # The conversation used to generate the chart.
&quot;conversationId&quot;: &quot;A String&quot;, # The conversation id of the chart.
&quot;createTime&quot;: &quot;A String&quot;, # The create time of the conversation.
&quot;messages&quot;: [ # Ordered list of messages, including user inputs and system responses.
{ # The message in the conversation.
&quot;createTime&quot;: &quot;A String&quot;, # For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.
&quot;messageId&quot;: &quot;A String&quot;, # The message id of the message.
&quot;systemMessage&quot;: { # A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system. # A message from the system in response to the user.
&quot;chartSpec&quot;: { # Chart spec from LLM
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;generatedSqlQuery&quot;: &quot;A String&quot;, # Raw SQL from LLM, before templatization
&quot;textOutput&quot;: { # A text output message from the system. # A direct natural language response to the user message.
&quot;texts&quot;: [ # The parts of the message.
&quot;A String&quot;,
],
&quot;type&quot;: &quot;A String&quot;, # The type of the text message.
},
},
&quot;userMessage&quot;: { # The user message. # A message from the user that is interacting with the system.
&quot;text&quot;: &quot;A String&quot;, # A message from the user that is interacting with the system.
},
},
],
&quot;updateTime&quot;: &quot;A String&quot;, # The update time of the conversation.
},
],
&quot;chartSpec&quot;: { # Chart spec for the chart.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;request&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;sqlComparisonKey&quot;: &quot;A String&quot;, # Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset.
&quot;sqlQuery&quot;: &quot;A String&quot;, # SQL query used to generate the chart.
},
&quot;queryMetrics&quot;: { # Request data that use the existing QueryMetrics. # Use the existing QueryMetrics to generate the chart.
&quot;request&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
},
},
&quot;dateRangeConfig&quot;: { # Date range configuration for dashboard charts. # Date range config applied to the chart.
&quot;absoluteDateRange&quot;: { # A time window for querying conversations. # An absolute date range.
&quot;endTime&quot;: &quot;A String&quot;, # Required. The end time of the time window.
&quot;startTime&quot;: &quot;A String&quot;, # Required. The start time of the time window.
},
&quot;relativeDateRange&quot;: { # Relative date range configuration. # A relative date range.
&quot;quantity&quot;: &quot;A String&quot;, # Required. The quantity of units in the past.
&quot;unit&quot;: &quot;A String&quot;, # Required. The unit of time.
},
},
&quot;description&quot;: &quot;A String&quot;, # Chart description
&quot;displayName&quot;: &quot;A String&quot;, # User provided display name of the chart.
&quot;filter&quot;: &quot;A String&quot;, # Filter applied to all charts in the container. Should support scope later.
&quot;height&quot;: 42, # The height of the chart in grid units.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Chart last update time.
&quot;width&quot;: 42, # The width of the chart in grid units.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, x__xgafv=None)</code>
<pre>Lists Charts.
Args:
parent: string, Required. The parent resource of the charts. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response of listing charts.
&quot;charts&quot;: [ # The charts under the parent.
{ # Configurable dashboard&#x27;s widget that displays data as a chart.
&quot;chartType&quot;: &quot;A String&quot;, # Output only. Chart type.
&quot;chartVisualizationType&quot;: &quot;A String&quot;, # Chart visualization type.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Chart create time.
&quot;dataSource&quot;: { # The request data for visualizing the dataset in the chart.
&quot;generativeInsights&quot;: { # Request that use natural language query to generate the chart. # Use natural language query to generate the chart.
&quot;chartCheckpoint&quot;: { # The current chart checkpoint state. # The chart checkpoint used to generate the chart.
&quot;revisionId&quot;: &quot;A String&quot;, # The revision id of the chart.
&quot;sessionId&quot;: &quot;A String&quot;, # The session id of the chart.
},
&quot;chartConversations&quot;: [ # Output only. The chart conversations used to generate the chart.
{ # The conversation used to generate the chart.
&quot;conversationId&quot;: &quot;A String&quot;, # The conversation id of the chart.
&quot;createTime&quot;: &quot;A String&quot;, # The create time of the conversation.
&quot;messages&quot;: [ # Ordered list of messages, including user inputs and system responses.
{ # The message in the conversation.
&quot;createTime&quot;: &quot;A String&quot;, # For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.
&quot;messageId&quot;: &quot;A String&quot;, # The message id of the message.
&quot;systemMessage&quot;: { # A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system. # A message from the system in response to the user.
&quot;chartSpec&quot;: { # Chart spec from LLM
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;generatedSqlQuery&quot;: &quot;A String&quot;, # Raw SQL from LLM, before templatization
&quot;textOutput&quot;: { # A text output message from the system. # A direct natural language response to the user message.
&quot;texts&quot;: [ # The parts of the message.
&quot;A String&quot;,
],
&quot;type&quot;: &quot;A String&quot;, # The type of the text message.
},
},
&quot;userMessage&quot;: { # The user message. # A message from the user that is interacting with the system.
&quot;text&quot;: &quot;A String&quot;, # A message from the user that is interacting with the system.
},
},
],
&quot;updateTime&quot;: &quot;A String&quot;, # The update time of the conversation.
},
],
&quot;chartSpec&quot;: { # Chart spec for the chart.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;request&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;sqlComparisonKey&quot;: &quot;A String&quot;, # Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset.
&quot;sqlQuery&quot;: &quot;A String&quot;, # SQL query used to generate the chart.
},
&quot;queryMetrics&quot;: { # Request data that use the existing QueryMetrics. # Use the existing QueryMetrics to generate the chart.
&quot;request&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
},
},
&quot;dateRangeConfig&quot;: { # Date range configuration for dashboard charts. # Date range config applied to the chart.
&quot;absoluteDateRange&quot;: { # A time window for querying conversations. # An absolute date range.
&quot;endTime&quot;: &quot;A String&quot;, # Required. The end time of the time window.
&quot;startTime&quot;: &quot;A String&quot;, # Required. The start time of the time window.
},
&quot;relativeDateRange&quot;: { # Relative date range configuration. # A relative date range.
&quot;quantity&quot;: &quot;A String&quot;, # Required. The quantity of units in the past.
&quot;unit&quot;: &quot;A String&quot;, # Required. The unit of time.
},
},
&quot;description&quot;: &quot;A String&quot;, # Chart description
&quot;displayName&quot;: &quot;A String&quot;, # User provided display name of the chart.
&quot;filter&quot;: &quot;A String&quot;, # Filter applied to all charts in the container. Should support scope later.
&quot;height&quot;: 42, # The height of the chart in grid units.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Chart last update time.
&quot;width&quot;: 42, # The width of the chart in grid units.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # The value returned by the last `ListChartsResponse`. This value indicates that this is a continuation of a prior `ListCharts` call and that the system should return the next page of data.
}</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a Chart.
Args:
name: string, Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart} (required)
body: object, The request body.
The object takes the form of:
{ # Configurable dashboard&#x27;s widget that displays data as a chart.
&quot;chartType&quot;: &quot;A String&quot;, # Output only. Chart type.
&quot;chartVisualizationType&quot;: &quot;A String&quot;, # Chart visualization type.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Chart create time.
&quot;dataSource&quot;: { # The request data for visualizing the dataset in the chart.
&quot;generativeInsights&quot;: { # Request that use natural language query to generate the chart. # Use natural language query to generate the chart.
&quot;chartCheckpoint&quot;: { # The current chart checkpoint state. # The chart checkpoint used to generate the chart.
&quot;revisionId&quot;: &quot;A String&quot;, # The revision id of the chart.
&quot;sessionId&quot;: &quot;A String&quot;, # The session id of the chart.
},
&quot;chartConversations&quot;: [ # Output only. The chart conversations used to generate the chart.
{ # The conversation used to generate the chart.
&quot;conversationId&quot;: &quot;A String&quot;, # The conversation id of the chart.
&quot;createTime&quot;: &quot;A String&quot;, # The create time of the conversation.
&quot;messages&quot;: [ # Ordered list of messages, including user inputs and system responses.
{ # The message in the conversation.
&quot;createTime&quot;: &quot;A String&quot;, # For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.
&quot;messageId&quot;: &quot;A String&quot;, # The message id of the message.
&quot;systemMessage&quot;: { # A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system. # A message from the system in response to the user.
&quot;chartSpec&quot;: { # Chart spec from LLM
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;generatedSqlQuery&quot;: &quot;A String&quot;, # Raw SQL from LLM, before templatization
&quot;textOutput&quot;: { # A text output message from the system. # A direct natural language response to the user message.
&quot;texts&quot;: [ # The parts of the message.
&quot;A String&quot;,
],
&quot;type&quot;: &quot;A String&quot;, # The type of the text message.
},
},
&quot;userMessage&quot;: { # The user message. # A message from the user that is interacting with the system.
&quot;text&quot;: &quot;A String&quot;, # A message from the user that is interacting with the system.
},
},
],
&quot;updateTime&quot;: &quot;A String&quot;, # The update time of the conversation.
},
],
&quot;chartSpec&quot;: { # Chart spec for the chart.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;request&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;sqlComparisonKey&quot;: &quot;A String&quot;, # Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset.
&quot;sqlQuery&quot;: &quot;A String&quot;, # SQL query used to generate the chart.
},
&quot;queryMetrics&quot;: { # Request data that use the existing QueryMetrics. # Use the existing QueryMetrics to generate the chart.
&quot;request&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
},
},
&quot;dateRangeConfig&quot;: { # Date range configuration for dashboard charts. # Date range config applied to the chart.
&quot;absoluteDateRange&quot;: { # A time window for querying conversations. # An absolute date range.
&quot;endTime&quot;: &quot;A String&quot;, # Required. The end time of the time window.
&quot;startTime&quot;: &quot;A String&quot;, # Required. The start time of the time window.
},
&quot;relativeDateRange&quot;: { # Relative date range configuration. # A relative date range.
&quot;quantity&quot;: &quot;A String&quot;, # Required. The quantity of units in the past.
&quot;unit&quot;: &quot;A String&quot;, # Required. The unit of time.
},
},
&quot;description&quot;: &quot;A String&quot;, # Chart description
&quot;displayName&quot;: &quot;A String&quot;, # User provided display name of the chart.
&quot;filter&quot;: &quot;A String&quot;, # Filter applied to all charts in the container. Should support scope later.
&quot;height&quot;: 42, # The height of the chart in grid units.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Chart last update time.
&quot;width&quot;: 42, # The width of the chart in grid units.
}
updateMask: string, Optional. List of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `display_name`
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Configurable dashboard&#x27;s widget that displays data as a chart.
&quot;chartType&quot;: &quot;A String&quot;, # Output only. Chart type.
&quot;chartVisualizationType&quot;: &quot;A String&quot;, # Chart visualization type.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. Chart create time.
&quot;dataSource&quot;: { # The request data for visualizing the dataset in the chart.
&quot;generativeInsights&quot;: { # Request that use natural language query to generate the chart. # Use natural language query to generate the chart.
&quot;chartCheckpoint&quot;: { # The current chart checkpoint state. # The chart checkpoint used to generate the chart.
&quot;revisionId&quot;: &quot;A String&quot;, # The revision id of the chart.
&quot;sessionId&quot;: &quot;A String&quot;, # The session id of the chart.
},
&quot;chartConversations&quot;: [ # Output only. The chart conversations used to generate the chart.
{ # The conversation used to generate the chart.
&quot;conversationId&quot;: &quot;A String&quot;, # The conversation id of the chart.
&quot;createTime&quot;: &quot;A String&quot;, # The create time of the conversation.
&quot;messages&quot;: [ # Ordered list of messages, including user inputs and system responses.
{ # The message in the conversation.
&quot;createTime&quot;: &quot;A String&quot;, # For user messages, this is the time at which the system received the message. For system messages, this is the time at which the system generated the message.
&quot;messageId&quot;: &quot;A String&quot;, # The message id of the message.
&quot;systemMessage&quot;: { # A message from the system in response to the user. This message can also be a message from the user as historical context for multiturn conversations with the system. # A message from the system in response to the user.
&quot;chartSpec&quot;: { # Chart spec from LLM
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;generatedSqlQuery&quot;: &quot;A String&quot;, # Raw SQL from LLM, before templatization
&quot;textOutput&quot;: { # A text output message from the system. # A direct natural language response to the user message.
&quot;texts&quot;: [ # The parts of the message.
&quot;A String&quot;,
],
&quot;type&quot;: &quot;A String&quot;, # The type of the text message.
},
},
&quot;userMessage&quot;: { # The user message. # A message from the user that is interacting with the system.
&quot;text&quot;: &quot;A String&quot;, # A message from the user that is interacting with the system.
},
},
],
&quot;updateTime&quot;: &quot;A String&quot;, # The update time of the conversation.
},
],
&quot;chartSpec&quot;: { # Chart spec for the chart.
&quot;a_key&quot;: &quot;&quot;, # Properties of the object.
},
&quot;request&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
&quot;sqlComparisonKey&quot;: &quot;A String&quot;, # Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset.
&quot;sqlQuery&quot;: &quot;A String&quot;, # SQL query used to generate the chart.
},
&quot;queryMetrics&quot;: { # Request data that use the existing QueryMetrics. # Use the existing QueryMetrics to generate the chart.
&quot;request&quot;: {
&quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
},
},
},
&quot;dateRangeConfig&quot;: { # Date range configuration for dashboard charts. # Date range config applied to the chart.
&quot;absoluteDateRange&quot;: { # A time window for querying conversations. # An absolute date range.
&quot;endTime&quot;: &quot;A String&quot;, # Required. The end time of the time window.
&quot;startTime&quot;: &quot;A String&quot;, # Required. The start time of the time window.
},
&quot;relativeDateRange&quot;: { # Relative date range configuration. # A relative date range.
&quot;quantity&quot;: &quot;A String&quot;, # Required. The quantity of units in the past.
&quot;unit&quot;: &quot;A String&quot;, # Required. The unit of time.
},
},
&quot;description&quot;: &quot;A String&quot;, # Chart description
&quot;displayName&quot;: &quot;A String&quot;, # User provided display name of the chart.
&quot;filter&quot;: &quot;A String&quot;, # Filter applied to all charts in the container. Should support scope later.
&quot;height&quot;: 42, # The height of the chart in grid units.
&quot;name&quot;: &quot;A String&quot;, # Identifier. Chart resource name. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}
&quot;updateTime&quot;: &quot;A String&quot;, # Output only. Chart last update time.
&quot;width&quot;: 42, # The width of the chart in grid units.
}</pre>
</div>
</body></html>