REST Resource: projects.locations.collections.dataStores.conversations

Ressource : Conversation

Définition du proto de conversation externe.

Représentation JSON 
{
  "name": string,
  "state": enum (State),
  "userPseudoId": string,
  "messages": [
    {
      object (ConversationMessage)
    }
  ],
  "startTime": string,
  "endTime": string
}
Champs
name

string

Immuable. Nom complet projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/* ou projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*.
state

enum (State)

État de la conversation.
userPseudoId

string

Identifiant unique permettant de suivre les utilisateurs.
messages[]

object (ConversationMessage)

Messages de conversation.
startTime

string (Timestamp format)

Uniquement en sortie. Heure de début de la conversation.

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

string (Timestamp format)

Uniquement en sortie. Heure à laquelle la conversation s'est 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".

État

Énumération de l'état de la conversation.

Enums
STATE_UNSPECIFIED Inconnu
IN_PROGRESS La conversation est actuellement ouverte.
COMPLETED La conversation est terminée.

ConversationMessage

Définit un message de conversation.

Représentation JSON 
{
  "createTime": string,

  // Union field message can be only one of the following:
  "userInput": {
    object (TextInput)
  },
  "reply": {
    object (Reply)
  }
  // End of list of possible types for union field message.
}
Champs
createTime

string (Timestamp format)

Uniquement en sortie. Code temporel de création 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".

Champ d'union message.

message ne peut être qu'un des éléments suivants :
userInput

object (TextInput)

Entrée de texte de l'utilisateur.
reply

object (Reply)

Réponse à la recherche.

TextInput

Définit la saisie de texte.

Représentation JSON 
{
  "input": string,
  "context": {
    object (ConversationContext)
  }
}
Champs
input

string

Saisie de texte.
context

object (ConversationContext)

Contexte de conversation de l'entrée.

ConversationContext

Définit le contexte de la conversation

Représentation JSON 
{
  "contextDocuments": [
    string
  ],
  "activeDocument": string
}
Champs
contextDocuments[]

string

Liste actuelle des documents que l'utilisateur voit. Il contient les références aux ressources du document.
activeDocument

string

Document actif actuellement ouvert par l'utilisateur. Il contient la référence de la ressource du document.

Répondre

Définit un message de réponse à l'utilisateur.

Représentation JSON 
{
  "reply": string,
  "references": [
    {
      object (Reference)
    }
  ],
  "summary": {
    object (Summary)
  }
}
Champs
reply
(deprecated)

string

OBSOLÈTE : utilisez plutôt summary. Réponse textuelle.
references[]
(deprecated)

object (Reference)

Références dans la réponse.
summary

object (Summary)

Résumé basé sur les résultats de recherche.

Référence

Définit la référence dans la réponse.

Représentation JSON 
{
  "uri": string,
  "anchorText": string,
  "start": integer,
  "end": integer
}
Champs
uri

string

Référence de lien URI.
anchorText

string

Texte d'ancrage.
start

integer

Index de début du texte d'ancrage.
end

integer

Index de fin du texte d'ancrage.

Résumé

Résumé des N premiers résultats de recherche spécifiés par la spécification du résumé.

Représentation JSON 
{
  "summaryText": string,
  "summarySkippedReasons": [
    enum (SummarySkippedReason)
  ],
  "safetyAttributes": {
    object (SafetyAttributes)
  },
  "summaryWithMetadata": {
    object (SummaryWithMetadata)
  }
}
Champs
summaryText

string

Contenu du résumé.
summarySkippedReasons[]

enum (SummarySkippedReason)

Autres raisons pour lesquelles le résumé a été ignoré. Indique la raison pour laquelle les cas ont été ignorés. Si rien n'est ignoré, ce champ n'est pas défini.
safetyAttributes

object (SafetyAttributes)

Ensemble de catégories d'attributs de sécurité et de leurs scores de confiance associés.
summaryWithMetadata

object (SummaryWithMetadata)

Résumé avec des informations sur les métadonnées.

SummarySkippedReason

Énumération des raisons pour lesquelles le résumé a été ignoré.

Enums
SUMMARY_SKIPPED_REASON_UNSPECIFIED Valeur par défaut. Le motif d'omission du résumé n'est pas spécifié.
ADVERSARIAL_QUERY_IGNORED

Requête antagoniste (sans tenir compte de la casse).

Utilisé uniquement lorsque SummarySpec.ignore_adversarial_query est défini sur true.
NON_SUMMARY_SEEKING_QUERY_IGNORED

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

Google ignore le résumé si la requête est une discussion informelle. Utilisé uniquement lorsque SummarySpec.ignore_non_summary_seeking_query est défini sur true.
OUT_OF_DOMAIN_QUERY_IGNORED

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

Google ignore le résumé s'il n'y a pas de résultats de recherche très pertinents. Par exemple, le data store contient des informations sur l'entreprise A, mais la requête de l'utilisateur porte sur l'entreprise B.
POTENTIAL_POLICY_VIOLATION

Cas potentiel de non-respect des règles.

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

Le module complémentaire LLM n'est pas activé.

Google ignore le résumé si le module complémentaire LLM n'est pas activé.
NO_RELEVANT_CONTENT

Aucun contenu pertinent

Google ignore le résumé 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". Utilisé uniquement lorsque [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] est défini sur true.
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_SUMMARY_SEEKING_QUERY_IGNORED_V2

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

Google ignore le résumé si l'intention de la requête n'est pas claire. Utilisé uniquement lorsque [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] est défini sur true.
TIME_OUT

Le cas de délai d'attente dépassé.

Google ignore le résumé si le délai est dépassé.

SafetyAttributes

Catégories d'attributs de sécurité et leurs scores de confiance associés.

Représentation JSON 
{
  "categories": [
    string
  ],
  "scores": [
    number
  ]
}
Champs
categories[]

string

Noms à afficher des catégories d'attributs de sécurité associées au contenu généré. L'ordre correspond aux scores.
scores[]

number

Les scores de confiance de chaque catégorie, une valeur supérieure, signifie une confiance plus élevée. L'ordre correspond aux catégories.

SummaryWithMetadata

Résumé avec des informations sur les métadonnées.

Représentation JSON 
{
  "summary": string,
  "citationMetadata": {
    object (CitationMetadata)
  },
  "references": [
    {
      object (Reference)
    }
  ],
  "blobAttachments": [
    {
      object (BlobAttachment)
    }
  ]
}
Champs
summary

string

Texte récapitulatif sans informations de citation.
citationMetadata

object (CitationMetadata)

Métadonnées de citation pour le résumé donné.
references[]

object (Reference)

Références aux documents.
blobAttachments[]

object (BlobAttachment)

Uniquement en sortie. Stocker des données multimodales pour améliorer les réponses.

CitationMetadata

Métadonnées de citation.

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

object (Citation)

Citations pour les segments.

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

string (int64 format)

Fin du segment attribué (exclusive).
sources[]

object (CitationSource)

Sources de citation pour le segment attribué.

CitationSource

Source de la citation.

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

string (int64 format)

Index de référence du document à partir de SummaryWithMetadata.references. Il est indexé à partir de 0 et la valeur sera nulle si referenceIndex n'est pas défini explicitement.

Référence

Référence au document.

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

string

Titre du document.
document

string

Obligatoire. Document.name du document. Nom complet de la ressource du document référencé, au format projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.
uri

string

URI Cloud Storage ou HTTP pour le document.
chunkContents[]

object (ChunkContent)

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

ChunkContent

Contenu segmenté.

Représentation JSON 
{
  "content": string,
  "pageIdentifier": string,
  "blobAttachmentIndexes": [
    string
  ]
}
Champs
content

string

Contenu textuel du bloc.
pageIdentifier

string

Identifiant de la page.
blobAttachmentIndexes[]

string (int64 format)

Uniquement en sortie. Stocke les index des blobattachments associés à ce bloc.

BlobAttachment

Stocke les données binaires associées à la réponse textuelle (image, vidéo, audio, etc.).

Représentation JSON 
{
  "data": {
    object (Blob)
  },
  "attributionType": enum (AttributionType)
}
Champs
data

object (Blob)

Uniquement en sortie. Données blob.
attributionType

enum (AttributionType)

Uniquement en sortie. Type d'attribution du blob.

Blob

Stocke le type et les données du blob.

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

string

Uniquement en sortie. Type de contenu (type MIME) des données générées.
data

string (bytes format)

Uniquement en sortie. Octets bruts.

Chaîne encodée en base64.

AttributionType

Définit le type d'attribution du blob.

Enums
ATTRIBUTION_TYPE_UNSPECIFIED Type d'attribution non spécifié.
CORPUS Les données des pièces jointes proviennent du corpus.
GENERATED Les données de pièces jointes sont générées par le modèle via la génération de code.

Méthodes

converse

 Converses a conversation.

create

 Crée une conversation.

delete

 Supprime une conversation.

get

 Obtient une conversation.

list

 Liste toutes les conversations par DataStore parent.

patch

 Met à jour une conversation.