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

Ressource : AssistAnswer

Ressource AssistAnswer, partie principale de AssistResponse.

Représentation JSON 
{
  "name": string,
  "state": enum (State),
  "replies": [
    {
      object (Reply)
    }
  ],
  "assistSkippedReasons": [
    enum (AssistSkippedReason)
  ],
  "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.
replies[]

object (Reply)

Réponses de l'assistant.
assistSkippedReasons[]

enum (AssistSkippedReason)

Motifs pour lesquels vous n'avez pas répondu à l'appel d'assistance.
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 L'opération d'assistance a échoué.
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 
{
  "createTime": string,

  // Union field reply can be only one of the following:
  "groundedContent": {
    object (AssistantGroundedContent)
  }
  // End of list of possible types for union field reply.
}
Champs
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".
Champ d'union reply. Alternatives pour la réponse de l'assistant. reply ne peut être qu'un des éléments suivants :
groundedContent

object (AssistantGroundedContent)

Réponse textuelle ou média ancrés possibles de l'assistant.

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 le chercher pour vous." n'ont pas besoin d'ancrage.

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

  // Union field metadata can be only one of the following:
  "textGroundingMetadata": {
    object (TextGroundingMetadata)
  }
  // End of list of possible types for union field metadata.
}
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)

Facultatif. Métadonnées du contenu. Actuellement utilisé uniquement pour les réponses des assistants de recherche.
Champ d'union metadata. Métadonnées d'ancrage pour différents modaux. Pour le moment, il n'accepte que le texte. metadata ne peut être qu'un des éléments suivants :
textGroundingMetadata

object (TextGroundingMetadata)

Métadonnées pour l'ancrage basé sur des sources de texte.

TextGroundingMetadata

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

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

object (Segment)

Informations d'ancrage pour des 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é.

Segment

Informations d'ancrage pour un segment du texte.

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

string (int64 format)

Index basé sur 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 (exclue).
referenceIndices[]

integer

Références pour le segment.
groundingScore

number

Score du segment.
text

string

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)
  }
}
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.

DocumentMetadata

Métadonnées du document.

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

enum (Language)
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 contiendra 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 le moment, il n'est utilisé que pour le code.

Enums
LANGUAGE_UNSPECIFIED
PYTHON
SQL

AssistantContent

Contenu multimodal.

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

  // Union field data can be only one of the following:
  "text": string,
  "inlineData": {
    object (Blob)
  },
  "file": {
    object (File)
  },
  "executableCode": {
    object (ExecutableCode)
  },
  "codeExecutionResult": {
    object (CodeExecutionResult)
  }
  // End of list of possible types for union field data.
}
Champs
role

string

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

boolean

Facultatif. Indique si la partie est issue du modèle.
Champ d'union data. Données contenues. data ne peut être qu'un des éléments suivants :
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.

Blob

Blob intégré.

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

string

Obligatoire. Type de contenu (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 d'ExecutableCode.

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

enum (Outcome)

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

string

Facultatif. Contient stdout lorsque l'exécution du 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 du code.

Enums
OUTCOME_UNSPECIFIED État non spécifié. Cette valeur ne doit pas être utilisée.
OUTCOME_OK L'exécution du code s'est déroulée avec succès.
OUTCOME_FAILED L'exécution du code est terminée, mais a échoué. stderr doit contenir le motif.
OUTCOME_DEADLINE_EXCEEDED L'exécution du code a duré trop longtemps et a été annulée. Il peut y avoir ou non une sortie partielle.

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 du 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

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 de désactivation 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 d'un non-respect des règles concernant les clients (par exemple, la requête ou la réponse contenait une expression interdite).

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)
    }
  ]
}
Champs
verdict

enum (Verdict)

Verdict final concernant l'application des règles relatives aux clients. 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. Renseigné uniquement 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.

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

PolicyEnforcementResult

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

Représentation JSON 
{

  // Union field enforcement_result can be only one of the following:
  "bannedPhraseEnforcementResult": {
    object (BannedPhraseEnforcementResult)
  },
  "modelArmorEnforcementResult": {
    object (ModelArmorEnforcementResult)
  }
  // End of list of possible types for union field enforcement_result.
}
Champs
Champ d'union enforcement_result. 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 du règlement. enforcement_result ne peut être qu'un des éléments suivants :
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.

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 client pour les règles Model Armor.

Représentation JSON 
{

  // Union field result can be only one of the following:
  "modelArmorViolation": string,
  "error": {
    object (Status)
  }
  // End of list of possible types for union field result.
}
Champs
Champ d'union result. Résultat des règles Model Armor. result ne peut être qu'un des éléments suivants :
modelArmorViolation

string

Violation de 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.

Méthodes

get

 Récupère un AssistAnswer.