Console
    Start free

    Google Cloud Gemini Data Analytics V1beta Client - Class SystemMessage (0.11.0)

    Reference documentation and code samples for the Google Cloud Gemini Data Analytics V1beta Client class SystemMessage.

    A message from the system in response to the user. This message can also be a message from the user as historical context for multi-turn conversations with the system.

    Generated from protobuf message google.cloud.geminidataanalytics.v1beta.SystemMessage

    Namespace

    Google \ Cloud \ GeminiDataAnalytics \ V1beta

    Methods

    __construct

    Constructor.

    Parameters
    Name
    Description
    data
    array

    Optional. Data for populating the Message object.

    ↳ text
    TextMessage

    A direct natural language response to the user message.

    ↳ schema
    SchemaMessage

    A message produced during schema resolution.

    ↳ data
    DataMessage

    A message produced during data retrieval.

    ↳ analysis
    AnalysisMessage

    A message produced during analysis.

    ↳ chart
    ChartMessage

    A message produced during chart generation.

    ↳ error
    ErrorMessage

    An error message.

    ↳ example_queries
    ExampleQueries

    Optional. A message containing example queries.

    ↳ clarification
    ClarificationMessage

    Optional. Deprecated: Use TextMessage with TextType.FINAL_RESPONSE instead. A message containing clarification questions.

    ↳ group_id
    int

    Identifies the group that the event belongs to. Similar events are deemed to be logically relevant to each other and should be shown together in the UI.

    ↳ citation
    Citation

    Output only. Citation information for the system message.

    getText

    A direct natural language response to the user message.

    Returns
    Type
    Description
    TextMessage |null

    hasText

    setText

    A direct natural language response to the user message.

    Parameter
    Name
    Description
    var
    TextMessage
    Returns
    Type
    Description
    $this

    getSchema

    A message produced during schema resolution.

    Returns
    Type
    Description
    SchemaMessage |null

    hasSchema

    setSchema

    A message produced during schema resolution.

    Parameter
    Name
    Description
    var
    SchemaMessage
    Returns
    Type
    Description
    $this

    getData

    A message produced during data retrieval.

    Returns
    Type
    Description
    DataMessage |null

    hasData

    setData

    A message produced during data retrieval.

    Parameter
    Name
    Description
    var
    DataMessage
    Returns
    Type
    Description
    $this

    getAnalysis

    A message produced during analysis.

    Returns
    Type
    Description
    AnalysisMessage |null

    hasAnalysis

    setAnalysis

    A message produced during analysis.

    Parameter
    Name
    Description
    var
    AnalysisMessage
    Returns
    Type
    Description
    $this

    getChart

    A message produced during chart generation.

    Returns
    Type
    Description
    ChartMessage |null

    hasChart

    setChart

    A message produced during chart generation.

    Parameter
    Name
    Description
    var
    ChartMessage
    Returns
    Type
    Description
    $this

    getError

    An error message.

    Returns
    Type
    Description
    ErrorMessage |null

    hasError

    setError

    An error message.

    Parameter
    Name
    Description
    var
    ErrorMessage
    Returns
    Type
    Description
    $this

    getExampleQueries

    Optional. A message containing example queries.

    Returns
    Type
    Description
    ExampleQueries |null

    hasExampleQueries

    setExampleQueries

    Optional. A message containing example queries.

    Parameter
    Name
    Description
    var
    ExampleQueries
    Returns
    Type
    Description
    $this

    getClarification

    Optional. Deprecated: Use TextMessage with TextType.FINAL_RESPONSE instead. A message containing clarification questions.

    Returns
    Type
    Description
    ClarificationMessage |null

    hasClarification

    setClarification

    Optional. Deprecated: Use TextMessage with TextType.FINAL_RESPONSE instead. A message containing clarification questions.

    Parameter
    Name
    Description
    var
    ClarificationMessage
    Returns
    Type
    Description
    $this

    getGroupId

    Identifies the group that the event belongs to. Similar events are deemed to be logically relevant to each other and should be shown together in the UI.

    Returns
    Type
    Description
    int

    hasGroupId

    clearGroupId

    setGroupId

    Identifies the group that the event belongs to. Similar events are deemed to be logically relevant to each other and should be shown together in the UI.

    Parameter
    Name
    Description
    var
    int
    Returns
    Type
    Description
    $this

    getCitation

    Output only. Citation information for the system message.

    Returns
    Type
    Description
    Citation |null

    hasCitation

    clearCitation

    setCitation

    Output only. Citation information for the system message.

    Parameter
    Name
    Description
    var
    Citation
    Returns
    Type
    Description
    $this

    getKind

    Returns
    Type
    Description
    string
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: