REST Resource: projects.locations.collections.engines.sessions.assistAnswers

Ressource : AssistAnswer

Ressource AssistAnswer, partie principale de AssistResponse.

Représentation JSON 
{
  "name": string,
  "state": enum (State),
  "connectorDisplayNames": {
    string: string,
    ...
  },
  "replies": [
    {
      object (Reply)
    }
  ],
  "diagnosticInfo": {
    object
  },
  "assistSkippedReasons": [
    enum (AssistSkippedReason)
  ],
  "requiredAuthorizations": [
    {
      object (RequiredAuthorization)
    }
  ],
  "customerPolicyEnforcementResult": {
    object (CustomerPolicyEnforcementResult)
  }
}
Champs
name

string

Immuable. Identifiant. Nom de ressource de AssistAnswer. Format : projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}

Ce champ doit être une chaîne encodée au format UTF-8, dont la longueur ne doit pas dépasser 1 024 caractères.
state

enum (State)

État de la génération de la réponse.
connectorDisplayNames

map (key: string, value: string)

Uniquement en sortie. Mappe un nom d'agent de connecteur interne (l'identifiant machine intégré aux noms d'outils, par exemple custom_mcp_<fingerprint>_agent) au nom à afficher du connecteur, qui est lisible par l'humain. Rempli au moment de la diffusion pour les connecteurs de passerelle MCP / Agent Gateway personnalisés afin que les surfaces visibles par l'utilisateur (par exemple, le chip d'appel d'outil) puissent afficher le nom du connecteur au lieu de son identifiant interne. Vide lorsqu'il n'y a pas de tels connecteurs.
replies[]

object (Reply)

Réponses de l'assistant.
diagnosticInfo

object (Struct format)

Facultatif. Informations de diagnostic collectées lors du traitement de la demande. Cette information est destinée aux lecteurs humains uniquement, principalement pour faciliter le débogage. La structure des données est susceptible d'être modifiée sans préavis.
assistSkippedReasons[]

enum (AssistSkippedReason)

Motifs pour lesquels vous n'avez pas répondu à l'appel d'assistance.
requiredAuthorizations[]

object (RequiredAuthorization)

Uniquement en sortie. Liste des autorisations requises. N'est renseigné que lorsque l'utilisateur n'est pas autorisé pour un Authorization particulier, mais que l'agent appelé le requiert.
customerPolicyEnforcementResult

object (CustomerPolicyEnforcementResult)

Facultatif. Ce champ contient des informations sur les résultats des différentes vérifications des règles, comme les expressions interdites ou les vérifications Model Armor. Ce champ n'est renseigné que si l'appel d'assistance a été ignoré en raison d'un non-respect des règles.

État

État de la génération de la réponse.

Enums
STATE_UNSPECIFIED Inconnu
IN_PROGRESS Une opération d'assistance est en cours.
FAILED Échec de l'opération d'assistance.
SUCCEEDED L'opération d'assistance a réussi.
SKIPPED L'opération d'assistance a été ignorée.
CANCELLED L'opération d'assistance a été annulée (par exemple, le client a fermé le flux). Peut contenir une réponse partielle.

Répondre

Partie de la réponse en plusieurs parties de l'appel d'assistance.

Représentation JSON 
{
  "replyId": string,
  "createTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "groundedContent": {
    object (AssistantGroundedContent)
  }
  // End of mutually exclusive fields.
}
Champs
replyId

string

Uniquement en sortie. Lorsqu'il est défini, il identifie de manière unique une réponse dans la ressource AssistAnswer. Lors d'un appel AssistantService.StreamAssist, plusieurs messages Reply avec le même ID peuvent se produire dans le flux de réponse (dans plusieurs messages StreamAssistResponse). Ils représentent des parties d'un même message Reply dans la ressource AssistAnswer finale.
createTime

string (Timestamp format)

Heure à laquelle la réponse a été créée.

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".
Alternatives pour la réponse de l'assistant. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
groundedContent

object (AssistantGroundedContent)

Texte ou contenu multimédia de réponse potentiellement ancré de l'assistant.
Fin des champs qui s'excluent mutuellement.

AssistantGroundedContent

Un contenu et éventuellement ses informations d'ancrage.

Tous les contenus n'ont pas besoin d'ancrage. Les expressions telles que "Bien sûr, je vais voir ce que je peux faire" n'ont pas besoin d'ancrage.

Représentation JSON 
{
  "content": {
    object (AssistantContent)
  },
  "citationMetadata": {
    object (CitationMetadata)
  },
  "contentMetadata": {
    object (ContentMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "textGroundingMetadata": {
    object (TextGroundingMetadata)
  }
  // End of mutually exclusive fields.
}
Champs
content

object (AssistantContent)

Contenu.
citationMetadata

object (CitationMetadata)

Attribution de la source du contenu généré. Consultez également https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
contentMetadata

object (ContentMetadata)

Métadonnées facultatives pour le contenu. Actuellement utilisé uniquement pour les réponses des assistants de recherche.
Métadonnées d'ancrage pour différents modaux. Pour le moment, il n'accepte que le texte. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
textGroundingMetadata

object (TextGroundingMetadata)

Métadonnées pour l'ancrage basé sur des sources textuelles.
Fin des champs qui s'excluent mutuellement.

TextGroundingMetadata

Détails d'ancrage pour les sources de texte.

Représentation JSON 
{
  "segments": [
    {
      object (Segment)
    }
  ],
  "visualSegments": [
    {
      object (VisualSegment)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "searchEntryPoints": [
    {
      object (SearchEntryPoint)
    }
  ]
}
Champs
segments[]

object (Segment)

Informations d'ancrage pour les parties du texte.
visualSegments[]

object (VisualSegment)

Informations d'ancrage pour les parties du contenu visuel.
references[]

object (Reference)

Références pour le texte ancré.
searchEntryPoints[]

object (SearchEntryPoint)

Facultatif. Points d'entrée de recherche Google pour les recherches sur le Web utilisées pour l'ancrage.

Segment

Informations d'ancrage pour un segment de texte.

Représentation JSON 
{
  "startIndex": string,
  "endIndex": string,
  "referenceIndices": [
    integer
  ],
  "groundingScore": number,
  "text": string
}
Champs
startIndex

string (int64 format)

Index de base zéro indiquant le début du segment, mesuré en octets d'une chaîne UTF-8 (c'est-à-dire que les caractères encodés sur plusieurs octets ont une longueur supérieure à un).
endIndex

string (int64 format)

Fin du segment (exclusif).
referenceIndices[]

integer

Références du segment.
groundingScore

number

Score du segment.
text

string

Le segment de texte lui-même.

VisualSegment

Informations d'ancrage pour un segment visuel.

Représentation JSON 
{
  "referenceIndices": [
    integer
  ],
  "contentId": string
}
Champs
referenceIndices[]

integer

Références pour le segment visuel.
contentId

string

ID de contenu du segment visuel. Pour afficher la citation de l'élément visuel, ce contentId doit correspondre au champ groundedContent.content_metadata.content_id.

Référence

Contenu référencé et métadonnées de document associées.

Représentation JSON 
{
  "content": string,
  "codeSnippet": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "chunkMetadata": {
    object
  }
}
Champs
content

string

Contenu textuel référencé.
codeSnippet

string

Extrait de code du document référencé.
documentMetadata

object (DocumentMetadata)

Métadonnées du document.
chunkMetadata

object (Struct format)

Uniquement en sortie. Métadonnées génériques structurées des blocs provenant des connecteurs de sources de données en amont.

DocumentMetadata

Métadonnées du document.

Représentation JSON 
{
  "language": enum (Language),
  "boundingBoxes": [
    {
      object (BoundingBox)
    }
  ],
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "domain": string,
  "mimeType": string
}
Champs
language

enum (Language)
boundingBoxes[]

object (BoundingBox)

Facultatif. Cadres de délimitation pour cette référence. Répété pour prendre en charge les références s'étendant sur plusieurs pages.
document

string

Nom de ressource du document.
uri

string

URI du document. Elle peut contenir une URL qui redirige vers le site Web en question.
title

string

et le titre.
pageIdentifier

string

Identifiant de la page.
domain

string

Nom de domaine de l'URI du document. Notez que le champ uri peut contenir une URL qui redirige vers le site Web réel. Dans ce cas, il contient le nom de domaine du site cible.
mimeType

string

Type MIME du document. https://www.iana.org/assignments/media-types/media-types.xhtml.

Langue

Langue du contenu référencé. Pour l'instant, il n'est utilisé que pour le code.

Enums
LANGUAGE_UNSPECIFIED
PYTHON
SQL

BoundingBox

Cadre de délimitation qui génère une seule page.

Représentation JSON 
{
  "pageNumber": string,
  "boundingPoly": {
    object (BoundingPoly)
  }
}
Champs
pageNumber

string
boundingPoly

object (BoundingPoly)

Polygone de délimitation pour le contenu textuel du document.

BoundingPoly

Polygone de délimitation pour le contenu textuel du document.

Représentation JSON 
{
  "normalizedVertices": [
    {
      object (NormalizedVertex)
    }
  ]
}
Champs
normalizedVertices[]

object (NormalizedVertex)

NormalizedVertex

Un sommet représente un point 2D dans l'image.

REMARQUE : les coordonnées des sommets normalisés sont comparées aux valeurs de l'image d'origine, et sont comprises entre 0 et 1.

Représentation JSON 
{
  "x": number,
  "y": number
}
Champs
x

number

Coordonnée X.
y

number

Coordonnée Y (commence en haut de l'image).

SearchEntryPoint

Point d'entrée de recherche Google.

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

string

Extrait de contenu Web pouvant être intégré à une page Web ou à une WebView d'application.

AssistantContent

Contenu multimodal.

Représentation JSON 
{
  "role": string,
  "thought": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "inlineData": {
    object (Blob)
  },
  "file": {
    object (File)
  },
  "executableCode": {
    object (ExecutableCode)
  },
  "codeExecutionResult": {
    object (CodeExecutionResult)
  }
  // End of mutually exclusive fields.
}
Champs
role

string

Producteur du contenu. Valeurs possibles : "model" ou "user".
thought

boolean

Facultatif. Indique si la partie est pensée par le modèle.
Données contenues. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
text

string

Texte intégré.
inlineData

object (Blob)

Données binaires intégrées.
file

object (File)

Un fichier, par exemple un résumé audio.
executableCode

object (ExecutableCode)

code généré par le modèle et destiné à être exécuté.
codeExecutionResult

object (CodeExecutionResult)

Résultat de l'exécution d'un ExecutableCode.
Fin des champs qui s'excluent mutuellement.

Blob

Blob intégré.

Représentation JSON 
{
  "mimeType": string,
  "data": string
}
Champs
mimeType

string

Obligatoire. Type de support (type MIME) des données générées.
data

string (bytes format)

Obligatoire. Octets bruts.

Chaîne encodée en base64.

Fichier

Un fichier, par exemple un résumé audio.

Représentation JSON 
{
  "mimeType": string,
  "fileId": string
}
Champs
mimeType

string

Obligatoire. Type de contenu (type MIME) du fichier.
fileId

string

Obligatoire. ID du fichier.

ExecutableCode

code généré par le modèle et destiné à être exécuté par celui-ci.

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

string

Obligatoire. Contenu du code. Actuellement, seul Python est accepté.

CodeExecutionResult

Résultat de l'exécution de ExecutableCode.

Représentation JSON 
{
  "outcome": enum (Outcome),
  "output": string
}
Champs
outcome

enum (Outcome)

Obligatoire. Résultat de l'exécution de code.
output

string

Facultatif. Contient stdout lorsque l'exécution de code est réussie, stderr ou une autre description dans le cas contraire.

Résultat

Énumération des résultats possibles de l'exécution de code.

Enums
OUTCOME_UNSPECIFIED État non spécifié. Cette valeur ne doit pas être utilisée.
OUTCOME_OK L'exécution du code a bien été effectuée.
OUTCOME_FAILED L'exécution du code est terminée, mais a échoué. stderr doit contenir le motif.
OUTCOME_DEADLINE_EXCEEDED L'exécution de code a duré trop longtemps et a été annulée. Une sortie partielle peut être présente ou non.

CitationMetadata

Ensemble d'attributions de sources pour un contenu.

Représentation JSON 
{
  "citations": [
    {
      object (Citation)
    }
  ]
}
Champs
citations[]

object (Citation)

Uniquement en sortie. Liste des citations.

Citation

Attributions de source pour le contenu.

Représentation JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "title": string,
  "license": string,
  "publicationDate": {
    object (Date)
  }
}
Champs
startIndex

integer

Uniquement en sortie. Index de début dans le contenu.
endIndex

integer

Uniquement en sortie. Index de fin du contenu.
uri

string

Sortie uniquement. Référence URL de l'attribution.
title

string

Uniquement en sortie. Titre de l'attribution.
license

string

Uniquement en sortie. Licence de l'attribution.
publicationDate

object (Date)

Uniquement en sortie. Date de publication de l'attribution.

ContentMetadata

les métadonnées du contenu.

Représentation JSON 
{
  "contentKind": enum (ContentKind),
  "contentId": string
}
Champs
contentKind

enum (ContentKind)

type de contenu. Indique à quelle partie de la réponse de l'assistant de recherche appartient ce contenu.
contentId

string

ID du contenu. Il est utilisé pour associer les questions de recherche à leurs réponses. Par exemple, les parties de la réponse à une question de recherche auront le même contentId que la question.

ContentKind

Types de contenus possibles. Actuellement utilisé uniquement pour différencier les sections dans la réponse complète d'un assistant de recherche.

Enums
CONTENT_KIND_UNSPECIFIED Inconnu
RESEARCH_PLAN Plan de recherche.
RESEARCH_QUESTION Question de recherche.
RESEARCH_ANSWER Réponse à la recherche.
RESEARCH_REPORT Research report.
RESEARCH_AUDIO_SUMMARY Résumé audio de la recherche.

AssistSkippedReason

Raisons possibles pour lesquelles vous n'avez pas répondu à un appel d'assistance.

Enums
ASSIST_SKIPPED_REASON_UNSPECIFIED Valeur par défaut. Le motif d'ignorance n'est pas spécifié.
NON_ASSIST_SEEKING_QUERY_IGNORED L'assistant a ignoré la requête, car elle ne semblait pas chercher de réponse.
CUSTOMER_POLICY_VIOLATION L'Assistant a ignoré la requête ou a refusé d'y répondre en raison du non-respect d'une règle concernant les clients (par exemple, la requête ou la réponse contenait une expression interdite).

RequiredAuthorization

Représente une autorisation requise pour le fonctionnement de l'agent.

Représentation JSON 
{
  "authorization": string,
  "displayName": string,
  "authorizationUri": string,
  "authConfig": {
    object (AuthConfig)
  }
}
Champs
authorization

string

Uniquement en sortie. Nom du Authorization.
displayName

string

Uniquement en sortie. Nom à afficher de l'autorisation.
authorizationUri

string

Uniquement en sortie. URI que l'utilisateur doit ouvrir pour autoriser l'accès.
authConfig

object (AuthConfig)

Uniquement en sortie. Configuration d'une autorisation requise par un agent tiers (ADK). Cette valeur est renseignée lorsque l'autorisation provient d'un agent ADK. Dans ce cas, le nom de ressource authorization propriétaire ci-dessus n'est généralement pas défini.

AuthConfig

Configuration pour l'autorisation tierce.

Représentation JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "oauth2": {
    object (OAuth2Credential)
  }
  // End of mutually exclusive fields.
}
Champs
Configuration des identifiants. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
oauth2

object (OAuth2Credential)

Configuration des identifiants OAuth2.
Fin des champs qui s'excluent mutuellement.

OAuth2Credential

Configuration de l'autorisation OAuth2.

Représentation JSON 
{
  "clientId": string,
  "clientSecret": string,
  "nonce": string,
  "state": string,
  "redirectUri": string,
  "authResponseUri": string,
  "authCode": string,
  "accessToken": string,
  "refreshToken": string,
  "idToken": string,
  "expireTime": string,
  "expireDuration": string,
  "audience": string,
  "codeVerifier": string,
  "codeChallengeMethod": string,
  "tokenEndpointAuthMethod": string
}
Champs
clientId

string

Uniquement en sortie. ID client.
clientSecret

string

Uniquement en sortie. Code secret du client.
nonce

string

Uniquement en sortie. Valeur du nonce.
state

string

Uniquement en sortie. Valeur de l'état.
redirectUri

string

Uniquement en sortie. URI de redirection.
authResponseUri

string

Uniquement en sortie. URI de réponse d'autorisation.
authCode

string

Uniquement en sortie. Code d'autorisation.
accessToken

string

Uniquement en sortie. Jeton d'accès.
refreshToken

string

Uniquement en sortie. Jeton d'actualisation.
idToken

string

Uniquement en sortie. Jeton d'identité.
expireTime

string (Timestamp format)

Uniquement en sortie. Date d'expiration.

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

string (Duration format)

Uniquement en sortie. Durée d'expiration.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
audience

string

Uniquement en sortie. L'audience.
codeVerifier

string

Uniquement en sortie. Code verifier
codeChallengeMethod

string

Uniquement en sortie. Méthode de code challenge.
tokenEndpointAuthMethod

string

Uniquement en sortie. Méthode d'autorisation du point de terminaison du jeton.

CustomerPolicyEnforcementResult

Résultats de l'application des règles concernant les clients. Contient les résultats des différentes vérifications des règles, comme les expressions interdites ou les vérifications Model Armor.

Représentation JSON 
{
  "verdict": enum (Verdict),
  "policyResults": [
    {
      object (PolicyEnforcementResult)
    }
  ],
  "violationSource": enum (ViolationSource)
}
Champs
verdict

enum (Verdict)

Verdict final concernant l'application du règlement client. Si une seule règle a bloqué le traitement, le verdict est BLOCK.
policyResults[]

object (PolicyEnforcementResult)

Résultats de l'application des règles concernant les clients. Cette valeur n'est renseignée que si l'appel d'assistance a été ignoré en raison d'un non-respect des règles. Il contient les résultats des filtres qui ont bloqué le traitement de la requête.
violationSource

enum (ViolationSource)

Uniquement en sortie. Source de l'infraction.

Verdict

Verdict concernant l'application des règles relatives aux clients.

Enums
UNSPECIFIED Valeur inconnue.
ALLOW Aucune règle n'a été enfreinte.
BLOCK Le traitement a été bloqué par le règlement relatif aux clients.

PolicyEnforcementResult

Résultat de l'application des règles client pour un seul type de règle.

Représentation JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "bannedPhraseEnforcementResult": {
    object (BannedPhraseEnforcementResult)
  },
  "modelArmorEnforcementResult": {
    object (ModelArmorEnforcementResult)
  }
  // End of mutually exclusive fields.
}
Champs
Résultat spécifique au type de règlement. Il peut s'agir d'une erreur ou d'informations détaillées sur le résultat de l'application des règles. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

Résultat de l'application des règles concernant les expressions interdites.
modelArmorEnforcementResult

object (ModelArmorEnforcementResult)

Résultat de l'application des règles Model Armor.
Fin des champs qui s'excluent mutuellement.

BannedPhraseEnforcementResult

Résultat de l'application des règles client concernant les expressions interdites.

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

string

Expressions interdites trouvées dans la requête ou la réponse.

ModelArmorEnforcementResult

Résultat de l'application des règles relatives aux clients pour le règlement Model Armor.

Représentation JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "modelArmorViolation": string,
  "error": {
    object (Status)
  }
  // End of mutually exclusive fields.
}
Champs
Résultat des règles Model Armor. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
modelArmorViolation

string

Violation Model Armor détectée.
error

object (Status)

Erreur renvoyée par Model Armor si l'application de la règle a échoué pour une raison quelconque.
Fin des champs qui s'excluent mutuellement.

ViolationSource

Si l'appel d'assistance a été ignoré en raison d'un non-respect des règles, cette colonne indique la source de l'infraction.

Enums
VIOLATION_SOURCE_UNSPECIFIED Valeur inconnue.
SYSTEM Non-respect détecté dans la réponse du système.
PROMPT Nous avons détecté une infraction dans la requête utilisateur.
ATTACHMENT Nous avons détecté une infraction dans la pièce jointe de l'utilisateur.

Méthodes

get

 Récupère un AssistAnswer.