Console
    Start free

    SessionEvent

    An event represents a message from either the user or agent.

    Fields
    name string

    Identifier. The resource name of the event. Format: projects/{project}/locations/{location}/reasoningEngines/{reasoningEngine}/sessions/{session}/events/{event} .

    author string

    Required. The name of the agent that sent the event, or user.

    content object ( Content )

    Optional. Content of the event provided by the author.

    invocationId string

    Required. The invocation id of the event, multiple events can have the same invocation id.

    actions object ( EventActions )

    Optional. Actions executed by the agent.

    timestamp string ( Timestamp format)

    Required. timestamp when the event was created on client side.

    Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z" , "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30" .

    errorCode string

    Optional. Error code if the response is an error. code varies by model.

    errorMessage string

    Optional. Error message if the response is an error.

    eventMetadata object ( EventMetadata )

    Optional. metadata relating to this event.

    JSON representation 
     { 
 "name" 
 : 
 string 
 , 
 "author" 
 : 
 string 
 , 
 "content" 
 : 
 { 
 object (  Content 
 
) 
 } 
 , 
 "invocationId" 
 : 
 string 
 , 
 "actions" 
 : 
 { 
 object (  EventActions 
 
) 
 } 
 , 
 "timestamp" 
 : 
 string 
 , 
 "errorCode" 
 : 
 string 
 , 
 "errorMessage" 
 : 
 string 
 , 
 "eventMetadata" 
 : 
 { 
 object (  EventMetadata 
 
) 
 } 
 }

    EventActions

    Actions are parts of events that are executed by the agent.

    Fields
    skipSummarization boolean

    Optional. If true, it won't call model to summarize function response. Only used for functionResponse event.

    stateDelta object ( Struct format)

    Optional. Indicates that the event is updating the state with the given delta.

    artifactDelta map (key: string, value: integer)

    Optional. Indicates that the event is updating an artifact. key is the filename, value is the version.

    escalate boolean

    Optional. The agent is escalating to a higher level agent.

    requestedAuthConfigs object ( Struct format)

    Optional. Will only be set by a tool response indicating tool request euc. Struct key is the function call id since one function call response (from model) could correspond to multiple function calls. Struct value is the required auth config, which can be another struct.

    transferAgent string

    Optional. If set, the event transfers to the specified agent.

    JSON representation 
     { 
 "skipSummarization" 
 : 
 boolean 
 , 
 "stateDelta" 
 : 
 { 
 object 
 } 
 , 
 "artifactDelta" 
 : 
 { 
 string 
 : 
 integer 
 , 
 ... 
 } 
 , 
 "escalate" 
 : 
 boolean 
 , 
 "requestedAuthConfigs" 
 : 
 { 
 object 
 } 
 , 
 "transferAgent" 
 : 
 string 
 }

    EventMetadata

    metadata relating to a LLM response event.

    Fields
    groundingMetadata object ( GroundingMetadata )

    Optional. metadata returned to client when grounding is enabled.

    partial boolean

    Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text.

    turnComplete boolean

    Optional. Indicates whether the response from the model is complete. Only used for streaming mode.

    interrupted boolean

    Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming.

    longRunningToolIds[] string

    Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event.

    branch string

    Optional. The branch of the event. The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3. Branch is used when multiple child agents shouldn't see their siblings' conversation history.

    customMetadata object ( Struct format)

    The custom metadata of the LlmResponse.

    JSON representation 
     { 
 "groundingMetadata" 
 : 
 { 
 object (  GroundingMetadata 
 
) 
 } 
 , 
 "partial" 
 : 
 boolean 
 , 
 "turnComplete" 
 : 
 boolean 
 , 
 "interrupted" 
 : 
 boolean 
 , 
 "longRunningToolIds" 
 : 
 [ 
 string 
 ] 
 , 
 "branch" 
 : 
 string 
 , 
 "customMetadata" 
 : 
 { 
 object 
 } 
 }

    GroundingMetadata

    Information about the sources that support the content of a response.

    When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources.

    Fields
    webSearchQueries[] string

    Optional. The web search queries that were used to generate the content. This field is populated only when the grounding source is Google Search.

    retrievalQueries[] string

    Optional. The queries that were executed by the retrieval tools. This field is populated only when the grounding source is a retrieval tool, such as Vertex AI Search.

    groundingChunks[] object ( GroundingChunk )

    A list of supporting references retrieved from the grounding source. This field is populated when the grounding source is Google Search, Vertex AI Search, or Google Maps.

    groundingSupports[] object ( GroundingSupport )

    Optional. A list of grounding supports that connect the generated content to the grounding chunks. This field is populated when the grounding source is Google Search or Vertex AI Search.

    sourceFlaggingUris[] object ( SourceFlaggingUri )

    Optional. Output only. A list of URIs that can be used to flag a place or review for inappropriate content. This field is populated only when the grounding source is Google Maps.

    searchEntryPoint object ( SearchEntryPoint )

    Optional. A web search entry point that can be used to display search results. This field is populated only when the grounding source is Google Search.

    retrievalMetadata object ( RetrievalMetadata )

    Optional. Output only. metadata related to the retrieval grounding source.

    googleMapsWidgetContextToken string

    Optional. Output only. A token that can be used to render a Google Maps widget with the contextual data. This field is populated only when the grounding source is Google Maps.

    JSON representation 
     { 
 "webSearchQueries" 
 : 
 [ 
 string 
 ] 
 , 
 "retrievalQueries" 
 : 
 [ 
 string 
 ] 
 , 
 "groundingChunks" 
 : 
 [ 
 { 
 object (  GroundingChunk 
 
) 
 } 
 ] 
 , 
 "groundingSupports" 
 : 
 [ 
 { 
 object (  GroundingSupport 
 
) 
 } 
 ] 
 , 
 "sourceFlaggingUris" 
 : 
 [ 
 { 
 object (  SourceFlaggingUri 
 
) 
 } 
 ] 
 , 
 "searchEntryPoint" 
 : 
 { 
 object (  SearchEntryPoint 
 
) 
 } 
 , 
 "retrievalMetadata" 
 : 
 { 
 object (  RetrievalMetadata 
 
) 
 } 
 , 
 "googleMapsWidgetContextToken" 
 : 
 string 
 }

    SearchEntryPoint

    An entry point for displaying Google Search results.

    A SearchEntryPoint is populated when the grounding source for a model's response is Google Search. It provides information that you can use to display the search results in your application.

    Fields
    renderedContent string

    Optional. An HTML snippet that can be embedded in a web page or an application's webview. This snippet displays a search result, including the title, URL, and a brief description of the search result.

    sdkBlob string ( bytes format)

    Optional. A base64-encoded JSON object that contains a list of search queries and their corresponding search URLs. This information can be used to build a custom search UI.

    A base64-encoded string.

    JSON representation 
     { 
 "renderedContent" 
 : 
 string 
 , 
 "sdkBlob" 
 : 
 string 
 }

    GroundingChunk

    A piece of evidence that supports a claim made by the model.

    This is used to show a citation for a claim made by the model. When grounding is enabled, the model returns a GroundingChunk that contains a reference to the source of the information.

    Fields
    chunk_type Union type
    The source of the grounding chunk, which can be from Google Search, Vertex AI Search, or Google Maps. chunk_type can be only one of the following:
    web object ( Web )

    A grounding chunk from a web page, typically from Google Search. See the Web message for details.

    retrievedContext object ( RetrievedContext )

    A grounding chunk from a data source retrieved by a retrieval tool, such as Vertex AI Search. See the RetrievedContext message for details

    maps object ( Maps )

    A grounding chunk from Google Maps. See the Maps message for details.

    JSON representation 
     { 
 // chunk_type 
 "web" 
 : 
 { 
 object (  Web 
 
) 
 } 
 , 
 "retrievedContext" 
 : 
 { 
 object (  RetrievedContext 
 
) 
 } 
 , 
 "maps" 
 : 
 { 
 object (  Maps 
 
) 
 } 
 // Union type 
 }

    Web

    A Web chunk is a piece of evidence that comes from a web page. It contains the URI of the web page, the title of the page, and the domain of the page. This is used to provide the user with a link to the source of the information.

    Fields
    uri string

    The URI of the web page that contains the evidence.

    title string

    The title of the web page that contains the evidence.

    domain string

    The domain of the web page that contains the evidence. This can be used to filter out low-quality sources.

    JSON representation 
     { 
 "uri" 
 : 
 string 
 , 
 "title" 
 : 
 string 
 , 
 "domain" 
 : 
 string 
 }

    RetrievedContext

    Context retrieved from a data source to ground the model's response. This is used when a retrieval tool fetches information from a user-provided corpus or a public dataset.

    Fields
    context_details Union type
    Provides tool-specific details about the retrieved context. This allows for different types of retrieval tools to return their own specific metadata. context_details can be only one of the following:
    ragChunk object ( RagChunk )

    Additional context for a Retrieval-Augmented Generation (RAG) retrieval result. This is populated only when the RAG retrieval tool is used.

    uri string

    The URI of the retrieved data source.

    title string

    The title of the retrieved data source.

    text string

    The content of the retrieved data source.

    documentName string

    Output only. The full resource name of the referenced Vertex AI Search document. This is used to identify the specific document that was retrieved. The format is projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document} .

    JSON representation 
     { 
 // context_details 
 "ragChunk" 
 : 
 { 
 object (  RagChunk 
 
) 
 } 
 // Union type 
 "uri" 
 : 
 string 
 , 
 "title" 
 : 
 string 
 , 
 "text" 
 : 
 string 
 , 
 "documentName" 
 : 
 string 
 }

    Maps

    A Maps chunk is a piece of evidence that comes from Google Maps. It contains information about a place, such as its name, address, and reviews. This is used to provide the user with rich, location-based information.

    Fields
    placeAnswerSources object ( PlaceAnswerSources )

    The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.

    uri string

    The URI of the place.

    title string

    The title of the place.

    text string

    The text of the place answer.

    placeId string

    This Place's resource name, in places/{placeId} format. This can be used to look up the place in the Google Maps API.

    JSON representation 
     { 
 "placeAnswerSources" 
 : 
 { 
 object (  PlaceAnswerSources 
 
) 
 } 
 , 
 "uri" 
 : 
 string 
 , 
 "title" 
 : 
 string 
 , 
 "text" 
 : 
 string 
 , 
 "placeId" 
 : 
 string 
 }

    PlaceAnswerSources

    The sources that were used to generate the place answer. This includes review snippets and photos that were used to generate the answer, as well as URIs to flag content.

    Fields
    reviewSnippets[] object ( ReviewSnippet )

    Snippets of reviews that were used to generate the answer.

    JSON representation 
     { 
 "reviewSnippets" 
 : 
 [ 
 { 
 object (  ReviewSnippet 
 
) 
 } 
 ] 
 }

    ReviewSnippet

    A review snippet that is used to generate the answer.

    Fields
    reviewId string

    The id of the review that is being referenced.

    googleMapsUri string

    A link to show the review on Google Maps.

    title string

    The title of the review.

    JSON representation 
     { 
 "reviewId" 
 : 
 string 
 , 
 "googleMapsUri" 
 : 
 string 
 , 
 "title" 
 : 
 string 
 }

    GroundingSupport

    A collection of supporting references for a segment of the model's response.

    Fields
    groundingChunkIndices[] integer

    A list of indices into the groundingChunks field of the GroundingMetadata message. These indices specify which grounding chunks support the claim made in the content segment.

    For example, if this field has the values [1, 3] , it means that groundingChunks[1] and groundingChunks[3] are the sources for the claim in the content segment.

    confidenceScores[] number

    The confidence scores for the support references. This list is parallel to the groundingChunkIndices list. A score is a value between 0.0 and 1.0, with a higher score indicating a higher confidence that the reference supports the claim.

    For Gemini 2.0 and before, this list has the same size as groundingChunkIndices . For Gemini 2.5 and later, this list is empty and should be ignored.

    segment object ( Segment )

    The content segment that this support message applies to.

    JSON representation 
     { 
 "groundingChunkIndices" 
 : 
 [ 
 integer 
 ] 
 , 
 "confidenceScores" 
 : 
 [ 
 number 
 ] 
 , 
 "segment" 
 : 
 { 
 object (  Segment 
 
) 
 } 
 }

    Segment

    A segment of the content.

    Fields
    partIndex integer

    Output only. The index of the Part object that this segment belongs to. This is useful for associating the segment with a specific part of the content.

    startIndex integer

    Output only. The start index of the segment in the Part , measured in bytes. This marks the beginning of the segment and is inclusive, meaning the byte at this index is the first byte of the segment.

    endIndex integer

    Output only. The end index of the segment in the Part , measured in bytes. This marks the end of the segment and is exclusive, meaning the segment includes content up to, but not including, the byte at this index.

    text string

    Output only. The text of the segment.

    JSON representation 
     { 
 "partIndex" 
 : 
 integer 
 , 
 "startIndex" 
 : 
 integer 
 , 
 "endIndex" 
 : 
 integer 
 , 
 "text" 
 : 
 string 
 }

    RetrievalMetadata

    metadata related to the retrieval grounding source. This is part of the GroundingMetadata returned when grounding is enabled.

    Fields
    googleSearchDynamicRetrievalScore number

    Optional. A score indicating how likely it is that a Google Search query could help answer the prompt. The score is in the range of [0, 1] . A score of 1 means the model is confident that a search will be helpful, and 0 means it is not. This score is populated only when Google Search grounding and dynamic retrieval are enabled. The score is used to determine whether to trigger a search.

    JSON representation 
     { 
 "googleSearchDynamicRetrievalScore" 
 : 
 number 
 }

    SourceFlaggingUri

    A URI that can be used to flag a place or review for inappropriate content. This is populated only when the grounding source is Google Maps.

    Fields
    sourceId string

    The id of the place or review.

    flagContentUri string

    The URI that can be used to flag the content.

    JSON representation 
     { 
 "sourceId" 
 : 
 string 
 , 
 "flagContentUri" 
 : 
 string 
 }
    Design a Mobile Site
    View Site in Mobile | Classic
    Share by: