REST Resource: projects.locations.collections.engines.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,
  "pendingAsyncAssistOperationId": string
}
Campi
name

string

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

string

Facoltativo. Nome visualizzato della sessione.

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

enum (State)

Stato della sessione.
userPseudoId

string

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

object (Turn)

Turni.
labels[]

string

Facoltativo. Etichette per la 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 di fine 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".
isPinned

boolean

Facoltativo. Indica se la sessione è bloccata. Le sessioni bloccate vengono visualizzate nella parte superiore dell'elenco delle sessioni.
pendingAsyncAssistOperationId

string

Solo output. Nome risorsa completo di un'operazione AsyncAssist in corso per questa sessione, ad es. projects/*/locations/*/collections/*/engines/*/sessions/*/operations/*. Viene impostato all'avvio dell'operazione e cancellato al termine.

Metodi

addContextFile

 Carica un file di contesto da utilizzare come origine per le chiamate di assistenza all'interno della sessione.

create

 Crea una sessione.

delete

 Elimina una sessione.

get

 Recupera una sessione.

list

 Elenca tutte le sessioni in base al relativo DataStore principale.

listSessionFileMetadata

 Elenca i metadati di tutti i file nella sessione corrente.

patch

 Aggiorna una sessione.

recommendQuestions

 Recupera le domande consigliate per la sessione specificata.

removeContextFile

 Rimuove un file di contesto da una sessione.

selectContextFiles

 Seleziona i file di contesto da utilizzare in una sessione.

validateUserAuthorization

 Convalida un flusso di consenso di autenticazione downstream A2A 3-legged-OAuth (3LO) dopo che l'utente torna dalla schermata di consenso di terze parti e finalizza le credenziali downstream con Auth Manager.