REST Resource: projects.locations.collections.dataStores.sessions

Risorsa: Sessione

Definizione del proto della sessione esterna.

Rappresentazione JSON 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "userPseudoId": string,
  "turns": [
    {
      object (Turn)
    }
  ],
  "labels": [
    string
  ],
  "startTime": string,
  "endTime": string,
  "isPinned": boolean
}
Campi
name

string

Immutabile. Nome completo projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
displayName

string

Facoltativo. Il nome visualizzato della sessione.

Questo campo viene utilizzato per identificare la sessione nell'interfaccia utente. Per impostazione predefinita, il nome visualizzato è il testo della prima query del turno nella sessione.
state

enum (State)

Lo stato della sessione.
userPseudoId

string

Un identificatore univoco per il monitoraggio degli utenti.
turns[]

object (Turn)

Turni.
labels[]

string

Facoltativo. Le etichette della sessione. Può essere impostato come filtro in ListSessionsRequest.
startTime

string (Timestamp format)

Solo output. L'ora di inizio della sessione.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Solo output. L'ora in cui è terminata la sessione.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
isPinned

boolean

Facoltativo. Se la sessione è bloccata, verrà visualizzata in cima all'elenco delle sessioni.

Stato

Enumerazione dello stato della sessione.

Enum
STATE_UNSPECIFIED Lo stato non è specificato.
IN_PROGRESS La sessione è attualmente aperta.

Attiva

Rappresenta un turno, inclusa una query dell'utente e una risposta del servizio.

Rappresentazione JSON 
{
  "query": {
    object (Query)
  },
  "answer": string,
  "assistAnswer": string,
  "detailedAnswer": {
    object (Answer)
  },
  "detailedAssistAnswer": {
    object (AssistAnswer)
  },
  "queryConfig": {
    string: string,
    ...
  }
}
Campi
query

object (Query)

Facoltativo. La query dell'utente. Potrebbe non essere impostato se questo turno sta semplicemente rigenerando una risposta a un turno diverso
answer

string

Facoltativo. Il nome risorsa della risposta alla query dell'utente.

Imposta solo se la generazione della risposta (chiamata API /answer) è avvenuta in questo turno.
assistAnswer

string

Solo output. Il nome risorsa della risposta dell'assistente alla query dell'utente.

Imposta solo se in questo turno è stata effettuata una chiamata di assistenza (chiamata API /assist).

Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}. Per ottenere tutte le AssistAnswers per una sessione, imposta GetSessionRequest.include_answer_details su true. In alternativa, per ottenere una singola risorsa AssistAnswer, utilizza l'API AssistAnswerService.GetAssistAnswer.
detailedAnswer

object (Answer)

Solo output. Nell'API ConversationalSearchService.GetSession, se GetSessionRequest.include_answer_details è impostato su true, questo campo verrà compilato quando si ottiene la sessione di query di risposta.
detailedAssistAnswer

object (AssistAnswer)

Solo output. Nell'API ConversationalSearchService.GetSession, se GetSessionRequest.include_answer_details è impostato su true, questo campo verrà compilato quando si ottiene la sessione dell'assistente.
queryConfig

map (key: string, value: string)

Facoltativo. Rappresenta i metadati relativi alla configurazione della query, ad esempio il modello LLM e la versione utilizzati, i parametri del modello (temperatura, parametri di grounding e così via). Il prefisso "google." è riservato alle funzionalità sviluppate da Google.

Query

Definisce una query inserita dall'utente.

Rappresentazione JSON 
{
  "queryId": string,
  "parts": [
    {
      object (QueryPart)
    }
  ],

  // Union field content can be only one of the following:
  "text": string
  // End of list of possible types for union field content.
}
Campi
queryId

string

Solo output. ID univoco della query.
parts[]

object (QueryPart)

Esegui query sulle parti dei contenuti.
Campo unione content. Contenuti della query. content può essere solo uno dei seguenti tipi:
text

string

Testo normale.

QueryPart

Rappresenta una parte o l'intero contenuto, utilizzato per rappresentare una query. Una query può essere composta da più parti.

Rappresentazione JSON 
{
  "mimeType": string,

  // Union field payload can be only one of the following:
  "text": string,
  "uiJsonPayload": string,
  "personReference": {
    object (PersonReference)
  },
  "driveDocumentReference": {
    object (DriveDocumentReference)
  },
  "documentReference": {
    object (DocumentReference)
  }
  // End of list of possible types for union field payload.
}
Campi
mimeType

string

Facoltativo. Il tipo MIME standard IANA dei dati. Consulta https://www.iana.org/assignments/media-types/media-types.xhtml. Questo campo è facoltativo. Se non impostato, il tipo MIME predefinito è "text/plain" per il campo "data".
Campo unione payload. Il payload della parte della query. payload può essere solo uno dei seguenti tipi:
text

string

Contenuto testuale.
uiJsonPayload

string

Questo campo deve essere un messaggio dell'interfaccia utente in formato JSON. A partire dal primo trimestre del 2026, uiJsonPayload è supportato solo per i messaggi A2UI.
personReference

object (PersonReference)

Riferimento a una persona.
driveDocumentReference

object (DriveDocumentReference)

Riferimento a un documento di Google Drive.
documentReference

object (DocumentReference)

Altri riferimenti Document VAIS.

PersonReference

Rappresenta un riferimento a una persona.

Rappresentazione JSON 
{
  "documentName": string,
  "personId": string,
  "email": string,
  "displayName": string,
  "displayPhotoUri": string,
  "destinationUri": string,
  "fileId": string
}
Campi
documentName

string

Il nome completo della risorsa della persona. Formato: projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.
personId

string

L'ID persona della persona.
email

string

L'email della persona.
displayName

string

Il nome visualizzato della persona.
displayPhotoUri

string

L'URL della foto del profilo della persona.
destinationUri

string

L'URI di destinazione della persona.
fileId

string

Solo output. L'ID file dei dati personali memorizzati nei file di contesto della sessione.

DriveDocumentReference

Rappresenta un riferimento a un documento Google Drive.

Rappresentazione JSON 
{
  "driveId": string,
  "documentName": string,
  "displayTitle": string,
  "destinationUri": string,
  "iconUri": string,
  "fileId": string
}
Campi
driveId

string

L'ID Drive del documento.
documentName

string

Il nome completo della risorsa del documento. Formato: projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.
displayTitle

string

Il titolo visualizzato del riferimento.
destinationUri

string

L'URI di destinazione del riferimento.
iconUri

string

L'URI dell'icona del riferimento al documento di Drive.
fileId

string

Solo output. L'ID file dei dati del documento di Drive archiviati nei file di contesto della sessione.

DocumentReference

Rappresenta un riferimento al documento.

Rappresentazione JSON 
{
  "documentName": string,
  "displayTitle": string,
  "destinationUri": string,
  "iconUri": string,
  "fileId": string,
  "urlForConnector": string
}
Campi
documentName

string

Il nome completo della risorsa del documento. Formato: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}.
displayTitle

string

Il titolo visualizzato del riferimento.
destinationUri

string

L'URI di destinazione del riferimento.
iconUri

string

L'URI dell'icona del riferimento.
fileId

string

Solo output. L'ID file dei dati del documento archiviati nei file di contesto della sessione.
urlForConnector

string

Solo input. L'urlForConnector del documento restituito dalla ricerca federata.

Metodi

create

 Crea una sessione.

delete

 Elimina una sessione.

get

 Recupera una sessione.

list

 Elenca tutte le sessioni in base al relativo DataStore principale.

patch

 Aggiorna una sessione.