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

Ressource : Session

Définition proto de la session externe.

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

string

Immuable. Nom complet projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*
displayName

string

Facultatif. Nom à afficher de la session.

Ce champ permet d'identifier la session dans l'interface utilisateur. Par défaut, le nom à afficher correspond au texte de la requête du premier tour de la session.
state

enum (State)

État de la session.
userPseudoId

string

Identifiant unique permettant de suivre les utilisateurs.
turns[]

object (Turn)

Tours.
labels[]

string

Facultatif. Libellés de la session. Peut être défini comme filtre dans ListSessionsRequest.
startTime

string (Timestamp format)

Uniquement en sortie. Heure de début de la session.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Uniquement en sortie. Heure de fin de la session.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
isPinned

boolean

Facultatif. Indique si la session est épinglée. Les sessions épinglées s'affichent en haut de la liste des sessions.

État

Énumération de l'état de la session.

Enums
STATE_UNSPECIFIED État non spécifié.
IN_PROGRESS La session est actuellement ouverte.

Tour

Représente un tour, y compris une requête de l'utilisateur et une réponse du service.

Représentation JSON 
{
  "query": {
    object (Query)
  },
  "answer": string,
  "assistAnswer": string,
  "detailedAnswer": {
    object (Answer)
  },
  "detailedAssistAnswer": {
    object (AssistAnswer)
  },
  "queryConfig": {
    string: string,
    ...
  }
}
Champs
query

object (Query)

Facultatif. Requête de l'utilisateur. Peut ne pas être défini si ce tour ne fait que régénérer une réponse à un autre tour.
answer

string

Facultatif. Nom de ressource de la réponse à la requête de l'utilisateur.

N'est défini que si la génération de la réponse (appel d'API /answer) a eu lieu lors de ce tour.
assistAnswer

string

Uniquement en sortie. Nom de ressource de la réponse de l'Assistant à la requête de l'utilisateur.

N'est défini que si un appel d'assistance (appel d'API /assist) a eu lieu lors de ce tour.

Format: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}. Pour obtenir toutes les AssistAnswers d'une session, définissez GetSessionRequest.include_answer_details sur "true". Vous pouvez également utiliser l'API AssistAnswerService.GetAssistAnswer pour obtenir une ressource AssistAnswer individuelle.
detailedAnswer

object (Answer)

Uniquement en sortie. Dans l'API ConversationalSearchService.GetSession, si GetSessionRequest.include_answer_details est défini sur "true", ce champ est renseigné lors de l'obtention de la session de requête de réponse.
detailedAssistAnswer

object (AssistAnswer)

Uniquement en sortie. Dans l'API ConversationalSearchService.GetSession, si GetSessionRequest.include_answer_details est défini sur "true", ce champ est renseigné lors de l'obtention de la session de l'Assistant.
queryConfig

map (key: string, value: string)

Facultatif. Représente les métadonnées liées à la configuration de la requête, par exemple le modèle LLM et la version utilisés, les paramètres du modèle (température, paramètres d'ancrage, etc.). Le préfixe "google." est réservé aux fonctionnalités développées par Google.

Requête

Définit une requête saisie par l'utilisateur.

Représentation 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.
}
Champs
queryId

string

Uniquement en sortie. ID unique de la requête.
Champ d'union content. Contenu de la requête. content ne peut être qu'un des éléments suivants :
text

string

Texte brut.

Méthodes

create

 Crée une session.

delete

 Supprime une session.

get

 Obtient une session.

list

 Liste toutes les sessions par leur parent DataStore.

patch

 Met à jour une session.