REST Resource: projects.locations.apps.assistantSessions

<p>Ressource : AssistantSession</p>

Une session d'assistant représente une conversation entre un utilisateur et l'agent assistant.

Représentation JSON 
{
  "name": string,
  "requestor": string,
  "messages": [
    {
      object (AssistantMessage)
    }
  ],
  "state": enum (AssistantSessionState),
  "createTime": string,
  "updateTime": string,
  "userResponseSuggestions": {
    object (UserResponseSuggestions)
  },
  "displayName": string,
  "artifacts": [
    {
      object (AssistantSessionArtifact)
    }
  ],
  "sessionCheckpoint": {
    object (SessionCheckpoint)
  },
  "activeTurn": {
    object (ActiveTurnInfo)
  },
  "touchedApps": [
    string
  ]
}
Champs
name

string

Obligatoire. Identifiant. Identifiant unique de la session. Format : projects/{project}/locations/{location}/apps/{app}/assistantSessions/{session}
requestor

string

Uniquement en sortie. Utilisateur à l'origine de la session.
messages[]

object (AssistantMessage)

Facultatif. Historique des messages de la session.
state

enum (AssistantSessionState)

Uniquement en sortie. État de la session de l'assistant.
createTime

string (Timestamp format)

Uniquement en sortie. Heure de création de la session de l'assistant.

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".
updateTime

string (Timestamp format)

Uniquement en sortie. Heure de la dernière mise à jour de la session de l'assistant.

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".
userResponseSuggestions

object (UserResponseSuggestions)

Uniquement en sortie. Réponses suggérées de l'utilisateur par l'agent assistant.
displayName

string

Facultatif. Nom à afficher de la session de l'assistant.
artifacts[]

object (AssistantSessionArtifact)

Uniquement en sortie. Artefacts de document (par exemple, les TDD générés au format Markdown) produits par l'assistant au cours de cette session. Pointeurs uniquement ; le contenu du fichier se trouve dans le bucket Cloud Storage du client.
sessionCheckpoint

object (SessionCheckpoint)

Uniquement en sortie. Point de contrôle de session contenant l'intention utilisateur et un résumé de l'historique glissant.
activeTurn

object (ActiveTurnInfo)

Uniquement en sortie. Informations sur les pièces jointes pour le tour en cours d'exécution de cette session. Non défini lorsqu'aucun tour n'est en cours.
touchedApps[]

string

Uniquement en sortie. Applications que cette session a ciblées ou modifiées (sessions limitées au projet uniquement), pour les tags d'historique. Format : projects/{project}/locations/{location}/apps/{app}

AssistantMessage

Message dans une session d'assistant.

Représentation JSON 
{
  "role": string,
  "chunks": [
    {
      object (AssistantChunk)
    }
  ],
  "eventTime": string,
  "attachedGcsUris": [
    string
  ]
}
Champs
role

string

Obligatoire. Rôle dans la conversation : "user" ou "model".
chunks[]

object (AssistantChunk)

Facultatif. Contenu du message sous forme de fragments.
eventTime

string (Timestamp format)

Obligatoire. Horodatage de l'envoi ou de la réception du message.

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".
attachedGcsUris[]

string

Facultatif. URI Cloud Storage des fichiers importés par l'utilisateur au cours de ce tour. Cela permet de conserver les pièces jointes et de les afficher dans l'UI de l'historique de la session. Exemple : "gs://cxas-transient-uploads/uuid/prd.pdf"

AssistantChunk

Un fragment de données dans un message de l'assistant.

Représentation JSON 
{
  "createTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "thought": string,
  "payload": {
    object
  },
  "typedPayload": {
    object (TypedPayload)
  }
  // End of mutually exclusive fields.
}
Champs
createTime

string (Timestamp format)

Facultatif. Horodatage de la création ou de l'émission du fragment.

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".
Données du fragment. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
text

string

Facultatif. Données textuelles.
thought

string

Facultatif. Raisonnement généré par le modèle.
payload

object (Struct format)

Facultatif. Charge utile contenant des réponses structurées telles que le rapport de qualité, le nom de la version de l'agent, les réponses suggérées, etc.
typedPayload

object (TypedPayload)

Facultatif. Charge utile typée contenant des réponses structurées.
Fin des champs mutuellement exclusifs.

TypedPayload

Charge utile avec un type. Utilisé par l'historique de l'assistant (AssistantChunk) et par l'événement de streaming typedPayload. Se trouve ici, car assistant_service.proto et session_service.proto en ont besoin.

Représentation JSON 
{
  "displayName": string,
  "type": string,
  "value": {
    object
  },
  "metadata": {
    object
  }
}
Champs
displayName

string

Obligatoire. Nom à afficher de la charge utile.
type

string

Obligatoire. Type de la charge utile.
value

object (Struct format)

Obligatoire. Valeur de la charge utile.
metadata

object (Struct format)

Facultatif. Métadonnées de la charge utile.

AssistantSessionState

État de la session de l'assistant.

Enums
ASSISTANT_SESSION_STATE_UNSPECIFIED Valeur par défaut. Cette valeur est utilisée si l'état n'est pas spécifié.
PROCESSING L'agent assistant traite la requête en tant que tâche de longue durée.
IDLE L'agent assistant est inactif et n'a aucune requête ni réponse en attente.
PENDING_REVIEW L'agent assistant a terminé de traiter une tâche de longue durée et dispose d'une réponse prête pour l'utilisateur.

UserResponseSuggestions

Réponses suggérées de l'utilisateur par l'agent assistant.

Représentation JSON 
{
  "suggestions": [
    string
  ]
}
Champs
suggestions[]

string

Obligatoire. L'assistant a suggéré des réponses à l'utilisateur. Il s'agit de suggestions pour l'utilisateur sur la façon d'interagir avec l'assistant.

AssistantSessionArtifact

Artefact de document généré par l'assistant au cours d'une session, stocké sous forme de fichier dans le bucket Cloud Storage du client.

Représentation JSON 
{
  "id": string,
  "displayName": string,
  "gcsUri": string,
  "mimeType": string,
  "createTime": string,
  "turnIndex": integer
}
Champs
id

string

Uniquement en sortie. Identifiant unique de l'artefact dans la session.
displayName

string

Uniquement en sortie. Nom du fichier présenté à l'utilisateur, par exemple "hotel_booking_tdd.md".
gcsUri

string

Uniquement en sortie. Objet Cloud Storage contenant l'artefact. Exemple : "gs://{project}-agent-assist-artifacts/agent-assist-generated/1_tdd.md"
mimeType

string

Uniquement en sortie. Type de média IANA du contenu de l'artefact, par exemple "text/markdown".
createTime

string (Timestamp format)

Uniquement en sortie. Date et heure de persistance de l'artefact.

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".
turnIndex

integer

Uniquement en sortie. Index du message dans [AssistantSession.messages] dont le tour a produit l'artefact, pour placer le chip d'artefact lorsque l'historique est restauré.

SessionCheckpoint

Point de contrôle de session contenant l'intention utilisateur inférée pour le titre de la session et l'UI.

Représentation JSON 
{
  "userIntent": string
}
Champs
userIntent

string

Objectif ou sujet de l'utilisateur déduit pour la session (par exemple, "Créer un agent d'assistance pour l'e-commerce").

ActiveTurnInfo

Informations sur l'association en direct pour un tour de session en cours d'exécution, déconnecté de son client ou mis en attente pour être récupéré par une autre tâche de serveur.

Représentation JSON 
{
  "turnId": string,
  "status": enum (ActiveTurnInfo.Status),
  "startTime": string,
  "lastProgressTime": string,
  "orphanDeadlineTime": string
}
Champs
turnId

string

Identifie le tour de parole ; renvoyé par les instantanés de reprise sur l'API de streaming.
status

enum (ActiveTurnInfo.Status)

État actuel de l'association.
startTime

string (Timestamp format)

Uniquement en sortie. Heure de début du tour.

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".
lastProgressTime

string (Timestamp format)

Uniquement en sortie. Date et heure de la dernière persistance de la progression du tour.

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".
orphanDeadlineTime

string (Timestamp format)

Uniquement en sortie. Date à laquelle le tour sera arrêté si aucun client ne s'y connecte.

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".

ActiveTurnInfo.Status

Comment le tour en cours est actuellement lié aux tâches des clients et du serveur.

Enums
STATUS_UNSPECIFIED Non spécifié.
RUNNING Le tour s'exécute avec au moins un client associé.
DISCONNECTED Le tour s'exécute sans client associé.
RESUMING Le tour est mis en attente pour être récupéré : le prochain rattachement le poursuit.
ABANDONED Le bail du serveur du tour a expiré et aucune tâche ne le gère. La prochaine lecture le scelle dans un partiel validé. Non associable.

Méthodes

cancelAssistantTurn

 Annule le tour en cours de la session de l'assistant, le cas échéant : l'arrêt explicite de l'utilisateur pour un tour s'exécutant de manière détachée de tout flux.

create

 Crée une session d'assistant dans l'application donnée.

delete

 Supprime la session d'assistant spécifiée.

get

 Récupère les détails de la session de l'assistant spécifiée.

list

 Répertorie toutes les sessions de l'assistant dans l'application donnée.

streamChatAiAssistant

 Exécute Arc, l'assistant IA, pour la session d'assistant spécifiée en mode streaming.