GOgoogle
projects

POST /v1/projects/{projectsId}/locations/{locationsId}:generativeInsights

Natural language based Insights which powers the next generation of dashboards in Insights. Next generation of QueryMetrics.

Request

  • Base URL
    https://contactcenterinsights.googleapis.com
  • Auth
    OAuth 2 and OAuth 2
    Implicit: https://accounts.google.com/o/oauth2/auth
    Scopes: https://www.googleapis.com/auth/cloud-platform
    Authorization code: https://accounts.google.com/o/oauth2/auth
    Token URL: https://accounts.google.com/o/oauth2/token scopes: https://www.googleapis.com/auth/cloud-platform

Path parameters

projectsIdstring required
locationsIdstring required

Request body

chartstring

The full name of the chart resource this request corresponds to. Format: projects/{project}/locations/{location}/dashboards/{dashboard}/charts/{chart}

comparisonFilterstring

Optional. Filter for the data that can be specified in addition to the natural language query. This filter is specifically used for charts where comparisons are possible. For example, "compare to last month" or "compare to previous quarter".

filterstring

Filter for the data that can be specified in addition to the natural language query. Users are encouraged to use this field to populate time-windows.

naturalLanguageQuerystring

The natural language query specified by the user. If this field is specified, sql_query will be ignored.

revisionIdstring

Optional. The revision id that maps to the state of the chart state revision. When specified, the backend will reload the chart with the sql and visual spec from that revision.

sessionIdstring

Optional. The session id of the conversation. If the session id is not specified, backend will generate a random session id. If the session id is specified, will associate user-provided user_query with the provided session id.

sqlComparisonKeystring

Optional. For charts with comparison, this key will determine the metric that will be compared between the current and another dataset.

sqlQuerystring

Optional. The SQL query specified by the user. This query must be in BigQuery SQL dialect. The filter field will also be ignored, as it is assumed that any filtering is already included in the SQL query.

timeZonestring

Optional. The time zone name from the IANA Time Zone Database (for example, "America/Los_Angeles") used to group daily time-series results. If empty, or if the name is well-formed but not known to the server, UTC is used. Malformed values are rejected with INVALID_ARGUMENT.

userProvidedChartSpecobject

Optional. The user provided chart spec for the chart. This will be used to override the visual spec generated by the LLM.

Response

Successful response

doneboolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

metadataobject

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

namestring

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

responseobject

The normal, successful response of the operation. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

Changes

No recorded changes to this operation across all 6 revisions of this API.