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 normalizzato in base al fuso orario UTC 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 normalizzato in base al fuso orario UTC 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 risposte di 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 alla funzionalità sviluppata da Google.

Query

Definisce una query inserita dall'utente.

Rappresentazione JSON 
{
  "queryId": string,

  // 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.
Campo unione content. Contenuti della query. content può essere solo uno dei seguenti:
text

string

Testo normale.

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.