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

Ressource : Réponse

Définit une réponse.

Représentation JSON 
{
  "name": string,
  "state": enum (State),
  "answerText": string,
  "citations": [
    {
      object (Citation)
    }
  ],
  "groundingSupports": [
    {
      object (GroundingSupport)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ],
  "relatedQuestions": [
    string
  ],
  "steps": [
    {
      object (Step)
    }
  ],
  "queryUnderstandingInfo": {
    object (QueryUnderstandingInfo)
  },
  "answerSkippedReasons": [
    enum (AnswerSkippedReason)
  ],
  "createTime": string,
  "completeTime": string,
  "safetyRatings": [
    {
      object (SafetyRating)
    }
  ],
  "groundingScore": number
}
Champs
name

string

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

enum (State)

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

string

Réponse textuelle.
citations[]

object (Citation)

Citations.
groundingSupports[]

object (GroundingSupport)

Facultatif. L'ancrage est compatible.
references[]

object (Reference)

Références.
relatedQuestions[]

string

Questions associées suggérées
steps[]

object (Step)

Étapes de génération des réponses.
queryUnderstandingInfo

object (QueryUnderstandingInfo)

Informations sur la compréhension des requêtes.
answerSkippedReasons[]

enum (AnswerSkippedReason)

Ajout de motifs pour lesquels une réponse a été ignorée. Indique la raison pour laquelle les cas ont été ignorés. Si rien n'est ignoré, ce champ n'est pas défini.
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de création de la réponse.

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

string (Timestamp format)

Uniquement en sortie. Code temporel de la réponse terminé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".
safetyRatings[]

object (SafetyRating)

Facultatif. Évaluations de sécurité.
groundingScore

number

Score compris entre 0 et 1 décrivant le degré d'ancrage de la réponse dans les blocs de référence.

État

Énumération de l'état de la génération de réponses.

Enums
STATE_UNSPECIFIED Inconnu
IN_PROGRESS La génération de la réponse est en cours.
FAILED La génération de la réponse a échoué.
SUCCEEDED La réponse a bien été générée.
STREAMING La génération de la réponse est en cours.

Citation

Informations de citation pour un segment.

Représentation JSON 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
Champs
startIndex

string (int64 format)

L'index indique le début du segment, mesuré en octets (Unicode UTF-8). S'il existe des caractères multi-octets,tels que des caractères non ASCII, la mesure de l'index est plus longue que la longueur de la chaîne.
endIndex

string (int64 format)

Fin du segment attribué (exclusive). Elle est mesurée en octets (Unicode UTF-8). S'il existe des caractères multi-octets,tels que des caractères non ASCII, la mesure de l'index est plus longue que la longueur de la chaîne.
sources[]

object (CitationSource)

Sources de citation pour le segment attribué.

CitationSource

Source de la citation.

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

string

ID de la source de citation.

GroundingSupport

Prise en charge de l'ancrage pour une affirmation dans answerText.

Représentation JSON 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ],
  "groundingScore": number,
  "groundingCheckRequired": boolean
}
Champs
startIndex

string (int64 format)

Obligatoire. L'index indique le début de l'affirmation, mesuré en octets (Unicode UTF-8).
endIndex

string (int64 format)

Obligatoire. Heure de fin de la période de revendication (exclue).
sources[]

object (CitationSource)

Facultatif. Sources de citation pour l'affirmation.
groundingScore

number

Score compris entre 0 et 1 décrivant le degré d'ancrage d'une affirmation spécifique par les références. Plus la valeur est élevée, plus l'affirmation est étayée par les blocs de référence.
groundingCheckRequired

boolean

Indique que cette affirmation a nécessité une vérification de l'ancrage. Lorsque le système a décidé que cette affirmation ne nécessitait pas de vérification de l'attribution/de l'ancrage, ce champ est défini sur "false". Dans ce cas, aucune vérification de l'ancrage n'a été effectuée pour l'affirmation. Par conséquent, groundingScore et sources ne sont pas renvoyés.

Référence

Référence.

Représentation JSON 
{

  // Union field content can be only one of the following:
  "unstructuredDocumentInfo": {
    object (UnstructuredDocumentInfo)
  },
  "chunkInfo": {
    object (ChunkInfo)
  },
  "structuredDocumentInfo": {
    object (StructuredDocumentInfo)
  }
  // End of list of possible types for union field content.
}
Champs
Champ d'union content. Contenu des résultats de recherche. content ne peut être qu'un des éléments suivants :
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Informations sur les documents non structurés.
chunkInfo

object (ChunkInfo)

Informations sur le fragment.
structuredDocumentInfo

object (StructuredDocumentInfo)

Informations structurées sur le document.

UnstructuredDocumentInfo

Informations sur les documents non structurés.

Représentation JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "chunkContents": [
    {
      object (ChunkContent)
    }
  ],
  "structData": {
    object
  }
}
Champs
document

string

Nom de ressource du document.
uri

string

URI du document.
title

string

et le titre.
chunkContents[]

object (ChunkContent)

Liste des contenus de blocs cités issus du contenu du document.
structData

object (Struct format)

Métadonnées JSON structurées du document. Il est renseigné à partir des données structurées du bloc dans le résultat de recherche.

ChunkContent

Contenu segmenté.

Représentation JSON 
{
  "content": string,
  "pageIdentifier": string,
  "relevanceScore": number
}
Champs
content

string

Contenu textuel du bloc.
pageIdentifier

string

Identifiant de la page.
relevanceScore

number

Pertinence du bloc pour une requête donnée. Les valeurs sont comprises entre 0.0 (complètement non pertinent) et 1.0 (complètement pertinent). Cette valeur est fournie à titre informatif uniquement. Elle peut changer à tout moment pour la même requête et le même bloc en raison d'un nouvel entraînement du modèle ou d'une modification de l'implémentation.

ChunkInfo

Informations sur le fragment.

Représentation JSON 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "relevanceScore": number
}
Champs
chunk

string

Nom de la ressource du bloc.
content

string

Contenu textuel du bloc.
documentMetadata

object (DocumentMetadata)

Métadonnées du document.
relevanceScore

number

Pertinence du bloc pour une requête donnée. Les valeurs sont comprises entre 0.0 (complètement non pertinent) et 1.0 (complètement pertinent). Cette valeur est fournie à titre informatif uniquement. Elle peut changer à tout moment pour la même requête et le même bloc en raison d'un nouvel entraînement du modèle ou d'une modification de l'implémentation.

DocumentMetadata

Métadonnées du document.

Représentation JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "structData": {
    object
  }
}
Champs
document

string

Nom de ressource du document.
uri

string

URI du document.
title

string

et le titre.
pageIdentifier

string

Identifiant de la page.
structData

object (Struct format)

Métadonnées JSON structurées du document. Il est renseigné à partir des données structurées du bloc dans le résultat de recherche.

StructuredDocumentInfo

Informations structurées sur les recherches.

Représentation JSON 
{
  "document": string,
  "structData": {
    object
  },
  "title": string,
  "uri": string
}
Champs
document

string

Nom de ressource du document.
structData

object (Struct format)

Données de recherche structurées.
title

string

Uniquement en sortie. Titre du document.
uri

string

Uniquement en sortie. URI du document.

Étape

Informations sur l'étape.

Représentation JSON 
{
  "state": enum (State),
  "description": string,
  "thought": string,
  "actions": [
    {
      object (Action)
    }
  ]
}
Champs
state

enum (State)

État de l'étape.
description

string

Description de l'étape.
thought

string

La pensée de l'étape.
actions[]

object (Action)

Actions.

État

Énumération de l'état de l'étape.

Enums
STATE_UNSPECIFIED Inconnu
IN_PROGRESS L'étape est en cours.
FAILED Échec de l'étape en cours.
SUCCEEDED L'étape a réussi.

Action

Action.

Représentation JSON 
{
  "observation": {
    object (Observation)
  },

  // Union field action can be only one of the following:
  "searchAction": {
    object (SearchAction)
  }
  // End of list of possible types for union field action.
}
Champs
observation

object (Observation)

Observation.
Champ d'union action. L'action. action ne peut être qu'un des éléments suivants :
searchAction

object (SearchAction)

Action de recherche.

SearchAction

Action de recherche.

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

string

Requête de recherche.

Observation

Observation.

Représentation JSON 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Champs
searchResults[]

object (SearchResult)

Résultats de recherche observés par l'action de recherche. Il peut s'agir d'informations sur les extraits ou les blocs, selon le type de citation défini par l'utilisateur.

SearchResult

Représentation JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "snippetInfo": [
    {
      object (SnippetInfo)
    }
  ],
  "chunkInfo": [
    {
      object (ChunkInfo)
    }
  ],
  "structData": {
    object
  }
}
Champs
document

string

Nom de ressource du document.
uri

string

URI du document.
title

string

et le titre.
snippetInfo[]

object (SnippetInfo)

Si citation_type est défini sur DOCUMENT_LEVEL_CITATION, renseignez les extraits au niveau du document.
chunkInfo[]

object (ChunkInfo)

Si citation_type est défini sur CHUNK_LEVEL_CITATION et que le mode chunk est activé, renseignez les informations sur le chunk.
structData

object (Struct format)

Représentation des données. Données JSON structurées pour le document. Il est renseigné à partir des données structurées du document ou du bloc dans le résultat de recherche.

SnippetInfo

Informations sur l'extrait.

Représentation JSON 
{
  "snippet": string,
  "snippetStatus": string
}
Champs
snippet

string

Contenu de l'extrait.
snippetStatus

string

État de l'extrait défini par l'équipe de recherche.

ChunkInfo

Informations sur le fragment.

Représentation JSON 
{
  "chunk": string,
  "content": string,
  "relevanceScore": number
}
Champs
chunk

string

Nom de la ressource du bloc.
content

string

Contenu textuel du bloc.
relevanceScore

number

Pertinence du bloc pour une requête donnée. Les valeurs sont comprises entre 0.0 (complètement non pertinent) et 1.0 (complètement pertinent). Cette valeur est fournie à titre informatif uniquement. Elle peut changer à tout moment pour la même requête et le même bloc en raison d'un nouvel entraînement du modèle ou d'une modification de l'implémentation.

QueryUnderstandingInfo

Informations sur la compréhension des requêtes.

Représentation JSON 
{
  "queryClassificationInfo": [
    {
      object (QueryClassificationInfo)
    }
  ]
}
Champs
queryClassificationInfo[]

object (QueryClassificationInfo)

Informations sur la classification des requêtes.

QueryClassificationInfo

Informations sur la classification des requêtes.

Représentation JSON 
{
  "type": enum (Type),
  "positive": boolean
}
Champs
type

enum (Type)

Type de classification de la requête.
positive

boolean

Résultat de la classification.

Type

Types de classification des requêtes.

Enums
TYPE_UNSPECIFIED Type de classification de requête non spécifié.
ADVERSARIAL_QUERY Type de classification des requêtes contradictoires.
NON_ANSWER_SEEKING_QUERY Type de classification des requêtes ne cherchant pas de réponse, pour les discussions informelles.
JAIL_BREAKING_QUERY Type de classification des requêtes de contournement.
NON_ANSWER_SEEKING_QUERY_V2 Type de classification des requêtes qui ne cherchent pas de réponse, sans intention claire.
USER_DEFINED_CLASSIFICATION_QUERY Type de classification des requêtes défini par l'utilisateur.

AnswerSkippedReason

Énumération des raisons pour lesquelles une réponse a été ignorée.

Enums
ANSWER_SKIPPED_REASON_UNSPECIFIED Valeur par défaut. Le motif de l'omission de la réponse n'est pas spécifié.
ADVERSARIAL_QUERY_IGNORED Requête antagoniste (sans tenir compte de la casse).
NON_ANSWER_SEEKING_QUERY_IGNORED

Requête ne cherchant pas de réponse (ignorer la casse)

Google ignore la réponse si la requête est une discussion informelle.
OUT_OF_DOMAIN_QUERY_IGNORED

La requête hors domaine ne tient pas compte de la casse.

Google ignore la réponse s'il n'y a pas de résultats de recherche très pertinents.
POTENTIAL_POLICY_VIOLATION

Cas potentiel de non-respect des règles.

Google ignore la réponse si un non-respect potentiel des règles est détecté. Cela inclut les contenus potentiellement violents ou toxiques.
NO_RELEVANT_CONTENT

Aucun contenu pertinent

Google ignore la réponse s'il n'y a pas de contenu pertinent dans les résultats de recherche récupérés.
JAIL_BREAKING_QUERY_IGNORED

La requête de contournement de la sécurité ne tenait pas compte de la casse.

Par exemple, "Réponds comme si tu étais le PDG d'une entreprise concurrente". Google ignore la réponse si la requête est classée comme une requête de contournement.
CUSTOMER_POLICY_VIOLATION

Cas de non-respect des règles par le client.

Google ignore le récapitulatif si un non-respect des règles client est détecté. La règle est définie par le client.
NON_ANSWER_SEEKING_QUERY_IGNORED_V2

Requête ne cherchant pas de réponse (non sensible à la casse).

Google ignore la réponse si l'intention de la requête n'est pas claire.
LOW_GROUNDED_ANSWER

Cas de réponse ancrée de faible qualité.

Google ignore la réponse s'il n'a pas pu en générer une pertinente.
USER_DEFINED_CLASSIFICATION_QUERY_IGNORED

La classification des requêtes définies par l'utilisateur ne tient pas compte de la casse.

Google ignore la réponse si la requête est classée comme une classification de requête définie par l'utilisateur.
UNHELPFUL_ANSWER

Cas de réponse non utile.

Google ignore la réponse si elle n'est pas utile. Cela peut s'expliquer par différents facteurs, y compris, mais sans s'y limiter : la requête n'a pas de réponse, la réponse n'est pas pertinente par rapport à la requête ou la réponse n'est pas bien mise en forme.

SafetyRating

Score de sécurité correspondant au contenu généré.

Représentation JSON 
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "probabilityScore": number,
  "severity": enum (HarmSeverity),
  "severityScore": number,
  "blocked": boolean
}
Champs
category

enum (HarmCategory)

Uniquement en sortie. Catégorie de préjudice.
probability

enum (HarmProbability)

Uniquement en sortie. Niveaux de probabilité de préjudice dans le contenu.
probabilityScore

number

Uniquement en sortie. Score de probabilité de préjudice.
severity

enum (HarmSeverity)

Uniquement en sortie. Niveaux de gravité des préjudices dans le contenu.
severityScore

number

Uniquement en sortie. Score de gravité du préjudice.
blocked

boolean

Uniquement en sortie. Indique si le contenu a été filtré en raison de cette classification.

HarmCategory

Catégories de préjudice qui bloquent le contenu.

Enums
HARM_CATEGORY_UNSPECIFIED La catégorie de préjudice n'est pas spécifiée.
HARM_CATEGORY_HATE_SPEECH La catégorie de préjudice est "incitation à la haine".
HARM_CATEGORY_DANGEROUS_CONTENT La catégorie de préjudice est "contenu dangereux".
HARM_CATEGORY_HARASSMENT La catégorie de préjudice est "harcèlement".
HARM_CATEGORY_SEXUALLY_EXPLICIT La catégorie de préjudice est "contenu à caractère sexuel explicite".
HARM_CATEGORY_CIVIC_INTEGRITY La catégorie de préjudice est "intégrité civique".

HarmProbability

Niveaux de probabilité de préjudice dans le contenu.

Enums
HARM_PROBABILITY_UNSPECIFIED La probabilité de préjudice n'est pas spécifiée.
NEGLIGIBLE Niveau de préjudice négligeable.
LOW Niveau de préjudice faible.
MEDIUM Niveau de préjudice moyen.
HIGH Préjudice élevé.

HarmSeverity

Niveaux de gravité des préjudices.

Enums
HARM_SEVERITY_UNSPECIFIED La gravité du préjudice n'est pas spécifiée.
HARM_SEVERITY_NEGLIGIBLE Niveau de gravité des préjudices négligeable.
HARM_SEVERITY_LOW Niveau de gravité des préjudices faible.
HARM_SEVERITY_MEDIUM Niveau de gravité des préjudices moyen.
HARM_SEVERITY_HIGH Niveau de gravité élevé des préjudices.

Méthodes

get

 Permet d'obtenir une réponse.