REST Resource: projects.locations.apps.assistantSessions

Ressource: AssistantSession

Eine Assistant-Sitzung stellt eine Unterhaltung zwischen einem Nutzer und dem Assistant-Agenten dar.

JSON-Darstellung 
{
  "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
  ]
}
Felder
name

string

Erforderlich. ID. Die eindeutige Kennung der Sitzung. Format: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{session}
requestor

string

Nur Ausgabe. Der Nutzer, der die Sitzung initiiert hat.
messages[]

object (AssistantMessage)

Optional. Verlauf der Nachrichten in der Sitzung.
state

enum (AssistantSessionState)

Nur Ausgabe. Der Status der Assistentensitzung.
createTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Assistentensitzung erstellt wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
updateTime

string (Timestamp format)

Nur Ausgabe. Der Zeitpunkt, zu dem die Assistentensitzung zuletzt aktualisiert wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
userResponseSuggestions

object (UserResponseSuggestions)

Nur Ausgabe. Vorgeschlagene Nutzerantworten vom Assistant-Agenten.
displayName

string

Optional. Der Anzeigename der Assistant-Sitzung.
artifacts[]

object (AssistantSessionArtifact)

Nur Ausgabe. Dokumentartefakte (z.B. generierte TDDs im Markdown-Format), die vom Assistenten in dieser Sitzung erstellt wurden. Nur Verweise; der Dateiinhalt befindet sich im Cloud Storage-Bucket des Kunden.
sessionCheckpoint

object (SessionCheckpoint)

Nur Ausgabe. Sitzungsprüfpunkt mit Nutzerabsicht und Zusammenfassung des fortlaufenden Verlaufs.
activeTurn

object (ActiveTurnInfo)

Nur Ausgabe. Anhangsinformationen für die aktuell ausgeführte Runde dieser Sitzung. Nicht festgelegt, wenn kein Zug ausgeführt wird.
touchedApps[]

string

Nur Ausgabe. Apps, die in dieser Sitzung als Ziel festgelegt oder geändert wurden (nur Sitzungen auf Projektebene), für Verlaufs-Tags. Format: projects/{project}/locations/{location}/apps/{app}

AssistantMessage

Eine Nachricht in einer Assistant-Sitzung.

JSON-Darstellung 
{
  "role": string,
  "chunks": [
    {
      object (AssistantChunk)
    }
  ],
  "eventTime": string,
  "attachedGcsUris": [
    string
  ]
}
Felder
role

string

Erforderlich. Rolle innerhalb der Unterhaltung: „user“ oder „model“.
chunks[]

object (AssistantChunk)

Optional. Inhalt der Nachricht als Blöcke.
eventTime

string (Timestamp format)

Erforderlich. Zeitstempel für den Versand oder Empfang der Nachricht.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
attachedGcsUris[]

string

Optional. Cloud Storage-URIs für Dateien, die vom Nutzer während dieser Runde hochgeladen wurden. So können Anhänge in der Benutzeroberfläche des Sitzungsverlaufs beibehalten und gerendert werden. Beispiel: „gs://cxas-transient-uploads/uuid/prd.pdf“

AssistantChunk

Ein Datenblock in einer Assistant-Nachricht.

JSON-Darstellung 
{
  "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.
}
Felder
createTime

string (Timestamp format)

Optional. Zeitstempel, zu dem der Chunk erstellt oder ausgegeben wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".
Daten im Block. Im Folgenden finden Sie eine Liste von Feldern, die sich gegenseitig ausschließen. In einer Antwort wird höchstens eines der Felder festgelegt:
text

string

Optional. Textdaten.
thought

string

Optional. Vom Modell generierter Gedanke.
payload

object (Struct format)

Optional. Nutzlast, die strukturierte Antworten wie den Qualitätsbericht, den Namen der Agentenversion, Antwortvorschläge usw. enthält.
typedPayload

object (TypedPayload)

Optional. Eingegebene Nutzlast, die strukturierte Antworten enthält.
Ende der sich gegenseitig ausschließenden Felder.

TypedPayload

Nutzlast mit einem Typ. Wird vom Assistant-Verlauf (AssistantChunk) und vom Streaming-Ereignis typedPayload verwendet. Wird hier gespeichert, da sowohl „assistant_service.proto“ als auch „session_service.proto“ darauf zugreifen müssen.

JSON-Darstellung 
{
  "displayName": string,
  "type": string,
  "value": {
    object
  },
  "metadata": {
    object
  }
}
Felder
displayName

string

Erforderlich. Der Anzeigename der Nutzlast.
type

string

Erforderlich. Der Typ der Nutzlast.
value

object (Struct format)

Erforderlich. Der Wert der Nutzlast.
metadata

object (Struct format)

Optional. Die Metadaten der Nutzlast.

AssistantSessionState

Der Status der Assistentensitzung.

Enums
ASSISTANT_SESSION_STATE_UNSPECIFIED Der Standardwert. Dieser Wert wird verwendet, wenn der Status nicht angegeben ist.
PROCESSING Der Assistant-Agent verarbeitet die Anfrage als lang andauernde Aufgabe.
IDLE Der Assistant-Agent ist inaktiv und hat keine ausstehenden Anfragen oder Antworten.
PENDING_REVIEW Der KI-Assistent hat die Verarbeitung einer langwierigen Aufgabe abgeschlossen und eine Antwort für den Nutzer bereit.

UserResponseSuggestions

Vorgeschlagene Nutzerantworten vom Assistant-Agenten.

JSON-Darstellung 
{
  "suggestions": [
    string
  ]
}
Felder
suggestions[]

string

Erforderlich. Der Assistent hat Nutzerantworten vorgeschlagen. Dies sind Vorschläge für den Nutzer, wie er mit dem Assistenten interagieren kann.

AssistantSessionArtifact

Ein Dokumentartefakt, das vom Assistenten innerhalb einer Sitzung generiert und als Datei im Cloud Storage-Bucket des Kunden gespeichert wird.

JSON-Darstellung 
{
  "id": string,
  "displayName": string,
  "gcsUri": string,
  "mimeType": string,
  "createTime": string,
  "turnIndex": integer
}
Felder
id

string

Nur Ausgabe. Die eindeutige Kennung des Artefakts innerhalb der Sitzung.
displayName

string

Nur Ausgabe. Der Dateiname, der dem Nutzer angezeigt wird, z.B. „hotel_booking_tdd.md“.
gcsUri

string

Nur Ausgabe. Das Cloud Storage-Objekt, das den Artefaktinhalt enthält. Beispiel: „gs://{project}-agent-assist-artifacts/agent-assist-generated/1_tdd.md“
mimeType

string

Nur Ausgabe. Der IANA-Medientyp des Artefaktinhalts, z.B. „text/markdown“.
createTime

string (Timestamp format)

Nur Ausgabe. Wann das Artefakt beibehalten wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
turnIndex

integer

Nur Ausgabe. Index der Nachricht in [AssistantSession.messages], deren Turn das Artefakt erzeugt hat, um den Artefakt-Chip zu platzieren, wenn der Verlauf wiederhergestellt wird.

SessionCheckpoint

Sitzungsprüfpunkt mit abgeleiteter Nutzerabsicht für Sitzungstitel und Benutzeroberfläche.

JSON-Darstellung 
{
  "userIntent": string
}
Felder
userIntent

string

Abgeleitetes Nutzerziel oder Thema für die Sitzung (z.B. „E-Commerce-Support-Agent erstellen“).

ActiveTurnInfo

Informationen zum Live-Anhang für einen Sitzungsdurchlauf, der gerade ausgeführt wird, von seinem Client getrennt ist oder für die Abholung durch eine andere Serveraufgabe geparkt ist.

JSON-Darstellung 
{
  "turnId": string,
  "status": enum (ActiveTurnInfo.Status),
  "startTime": string,
  "lastProgressTime": string,
  "orphanDeadlineTime": string
}
Felder
turnId

string

Identifiziert den Turn; wird von Fortsetzungs-Snapshots in der Streaming API zurückgegeben.
status

enum (ActiveTurnInfo.Status)

Aktueller Anhangsstatus.
startTime

string (Timestamp format)

Nur Ausgabe. Wann der Turn begonnen hat.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
lastProgressTime

string (Timestamp format)

Nur Ausgabe. Wann der Fortschritt der Runde zuletzt gespeichert wurde.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30"
orphanDeadlineTime

string (Timestamp format)

Nur Ausgabe. Wann der Zug beendet wird, wenn kein Client verbunden wird.

Verwendet RFC 3339, wobei die generierte Ausgabe immer Z-normalisiert ist und 0, 3, 6 oder 9 Nachkommastellen verwendet. Andere Offsets als „Z“ werden ebenfalls akzeptiert. Beispiele: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" oder "2014-10-02T15:01:23+05:30".

ActiveTurnInfo.Status

Wie sich die aktuelle Runde auf Clients und Serveraufgaben bezieht.

Enums
STATUS_UNSPECIFIED Nicht angegeben.
RUNNING Der Turn wird mit mindestens einem verbundenen Client ausgeführt.
DISCONNECTED Der Zug wird ohne angehängten Client ausgeführt.
RESUMING Der Zug wird für die Abholung geparkt: Mit dem nächsten Ankoppeln wird er fortgesetzt.
ABANDONED Die Server-Lease des Turns ist abgelaufen und es gibt keine Aufgabe, die ihn steuert. Beim nächsten Lesevorgang wird er zu einem festgeschriebenen Teil-Turn versiegelt. Nicht anhängbar.

Methoden

cancelAssistantTurn

 Bricht die laufende Interaktion der Assistant-Sitzung ab, falls vorhanden: der explizite Nutzerstopp für eine Interaktion, die unabhängig von einem Stream ausgeführt wird.

create

 Erstellt eine neue Assistentensitzung in der angegebenen Anwendung.

delete

 Löscht die angegebene Assistant-Sitzung.

get

 Ruft Details zur angegebenen Assistant-Sitzung ab.

list

 Listet alle Assistentensitzungen in der angegebenen Anwendung auf.

streamChatAiAssistant

 Führt Arc, den KI-Assistenten, für die angegebene Assistentensitzung im Streaming-Modus aus.