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

Risorsa: Conversazione

Definizione del proto di conversazione esterna.

Rappresentazione JSON 
{
  "name": string,
  "state": enum (State),
  "userPseudoId": string,
  "messages": [
    {
      object (ConversationMessage)
    }
  ],
  "startTime": string,
  "endTime": string
}
Campi
name

string

Immutabile. Nome completo projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/* o projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*.
state

enum (State)

Lo stato della conversazione.
userPseudoId

string

Un identificatore univoco per il monitoraggio degli utenti.
messages[]

object (ConversationMessage)

Messaggi delle conversazioni.
startTime

string (Timestamp format)

Solo output. L'ora di inizio della conversazione.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
endTime

string (Timestamp format)

Solo output. L'ora in cui è terminata la conversazione.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Stato

Enumerazione dello stato della conversazione.

Enum
STATE_UNSPECIFIED Sconosciuto.
IN_PROGRESS La conversazione è attualmente aperta.
COMPLETED La conversazione è stata completata.

ConversationMessage

Definisce un messaggio della conversazione.

Rappresentazione 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.
}
Campi
createTime

string (Timestamp format)

Solo output. Timestamp di creazione del messaggio.

Utilizza RFC 3339, in cui l'output generato è sempre normalizzato in base al fuso orario UTC e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".

Campo unione message.

message può essere solo uno dei seguenti:
userInput

object (TextInput)

Input di testo dell'utente.
reply

object (Reply)

Cerca risposta.

TextInput

Definisce l'input di testo.

Rappresentazione JSON 
{
  "input": string,
  "context": {
    object (ConversationContext)
  }
}
Campi
input

string

Inserimento testo.
context

object (ConversationContext)

Il contesto della conversazione dell'input.

ConversationContext

Definisce il contesto della conversazione

Rappresentazione JSON 
{
  "contextDocuments": [
    string
  ],
  "activeDocument": string
}
Campi
contextDocuments[]

string

L'elenco attuale dei documenti visualizzati dall'utente. Contiene i riferimenti alle risorse del documento.
activeDocument

string

Il documento attivo corrente aperto dall'utente. Contiene il riferimento alla risorsa del documento.

Rispondi

Definisce un messaggio di risposta all'utente.

Rappresentazione JSON 
{
  "reply": string,
  "references": [
    {
      object (Reference)
    }
  ],
  "summary": {
    object (Summary)
  }
}
Campi
reply
(deprecated)

string

DEPRECATO: utilizza summary. Risposta di testo.
references[]
(deprecated)

object (Reference)

Riferimenti nella risposta.
summary

object (Summary)

Riepilogo basato sui risultati di ricerca.

Riferimento

Definisce il riferimento nella risposta.

Rappresentazione JSON 
{
  "uri": string,
  "anchorText": string,
  "start": integer,
  "end": integer
}
Campi
uri

string

Riferimento al link URI.
anchorText

string

Anchor text.
start

integer

Indice iniziale dell'anchor text.
end

integer

Indice finale dell'anchor text.

Riepilogo

Riepilogo dei primi N risultati di ricerca specificati dalla specifica del riepilogo.

Rappresentazione JSON 
{
  "summaryText": string,
  "summarySkippedReasons": [
    enum (SummarySkippedReason)
  ],
  "safetyAttributes": {
    object (SafetyAttributes)
  },
  "summaryWithMetadata": {
    object (SummaryWithMetadata)
  }
}
Campi
summaryText

string

Il contenuto del riepilogo.
summarySkippedReasons[]

enum (SummarySkippedReason)

Altri motivi per cui il riepilogo è stato ignorato. Fornisce il motivo dei casi ignorati. Se non viene ignorato nulla, questo campo non viene impostato.
safetyAttributes

object (SafetyAttributes)

Una raccolta di categorie di attributi di sicurezza e i relativi punteggi di affidabilità.
summaryWithMetadata

object (SummaryWithMetadata)

Riepilogo con informazioni sui metadati.

SummarySkippedReason

Un enum per i motivi di riepilogo ignorato.

Enum
SUMMARY_SKIPPED_REASON_UNSPECIFIED Valore predefinito. Il motivo per cui il riepilogo è stato ignorato non è specificato.
ADVERSARIAL_QUERY_IGNORED

La query contraddittoria ignorava la distinzione tra maiuscole e minuscole.

Utilizzato solo quando SummarySpec.ignore_adversarial_query è impostato su true.
NON_SUMMARY_SEEKING_QUERY_IGNORED

La query di ricerca non riepilogativa non ha tenuto conto della distinzione tra maiuscole e minuscole.

Google salta il riepilogo se la query è una chiacchiera. Utilizzato solo quando SummarySpec.ignore_non_summary_seeking_query è impostato su true.
OUT_OF_DOMAIN_QUERY_IGNORED

La query al di fuori del dominio non ha tenuto conto della distinzione tra maiuscole e minuscole.

Google salta il riepilogo se non ci sono risultati di ricerca di pertinenza elevata. Ad esempio, il datastore contiene informazioni sull'azienda A, ma la query dell'utente pone domande sull'azienda B.
POTENTIAL_POLICY_VIOLATION

Il caso di potenziale violazione delle norme.

Google salta il riepilogo se viene rilevata una potenziale violazione delle norme. Sono inclusi contenuti che potrebbero essere violenti o tossici.
LLM_ADDON_NOT_ENABLED

Il caso in cui il componente aggiuntivo LLM non è abilitato.

Google ignora il riepilogo se il componente aggiuntivo LLM non è abilitato.
NO_RELEVANT_CONTENT

Il caso di nessun contenuto pertinente.

Google salta il riepilogo se non sono presenti contenuti pertinenti nei risultati di ricerca recuperati.
JAIL_BREAKING_QUERY_IGNORED

La query di jailbreaking non fa distinzione tra maiuscole e minuscole.

Ad esempio, "Rispondi con il tono del CEO di un'azienda concorrente". Utilizzato solo quando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_jail_breaking_query] è impostato su true.
CUSTOMER_POLICY_VIOLATION

Il caso di violazione delle norme relative ai clienti.

Google salta il riepilogo se viene rilevata una violazione delle norme per i clienti. Il criterio è definito dal cliente.
NON_SUMMARY_SEEKING_QUERY_IGNORED_V2

La query che non cerca risposte ignora le maiuscole/minuscole.

Google salta il riepilogo se la query non ha un intento chiaro. Utilizzato solo quando [SearchRequest.ContentSearchSpec.SummarySpec.ignore_non_answer_seeking_query] è impostato su true.
TIME_OUT

La custodia per il timeout.

Google salta il riepilogo se si verifica un timeout.

SafetyAttributes

Categorie di attributi di sicurezza e i relativi punteggi di affidabilità.

Rappresentazione JSON 
{
  "categories": [
    string
  ],
  "scores": [
    number
  ]
}
Campi
categories[]

string

I nomi visualizzati delle categorie di attributi di sicurezza associati ai contenuti generati. L'ordine corrisponde ai punteggi.
scores[]

number

I punteggi di confidenza di ogni categoria. Un valore più alto indica una confidenza maggiore. L'ordine corrisponde alle categorie.

SummaryWithMetadata

Riepilogo con informazioni sui metadati.

Rappresentazione JSON 
{
  "summary": string,
  "citationMetadata": {
    object (CitationMetadata)
  },
  "references": [
    {
      object (Reference)
    }
  ],
  "blobAttachments": [
    {
      object (BlobAttachment)
    }
  ]
}
Campi
summary

string

Testo di riepilogo senza informazioni sulla citazione.
citationMetadata

object (CitationMetadata)

Metadati della citazione per il riepilogo fornito.
references[]

object (Reference)

Riferimenti ai documenti.
blobAttachments[]

object (BlobAttachment)

Solo output. Memorizza dati multimodali per migliorare le risposte.

CitationMetadata

Metadati delle citazioni.

Rappresentazione JSON 
{
  "citations": [
    {
      object (Citation)
    }
  ]
}
Campi
citations[]

object (Citation)

Citazioni per i segmenti.

Citazione

Informazioni sulla citazione per un segmento.

Rappresentazione JSON 
{
  "startIndex": string,
  "endIndex": string,
  "sources": [
    {
      object (CitationSource)
    }
  ]
}
Campi
startIndex

string (int64 format)

L'indice indica l'inizio del segmento, misurato in byte/unicode.
endIndex

string (int64 format)

Fine del segmento attribuito, escluso.
sources[]

object (CitationSource)

Fonti delle citazioni per il segmento attribuito.

CitationSource

Fonte della citazione.

Rappresentazione JSON 
{
  "referenceIndex": string
}
Campi
referenceIndex

string (int64 format)

Indice dei riferimenti del documento da SummaryWithMetadata.references. È indicizzato a 0 e il valore sarà zero se referenceIndex non è impostato in modo esplicito.

Riferimento

Riferimento al documento.

Rappresentazione JSON 
{
  "title": string,
  "document": string,
  "uri": string,
  "chunkContents": [
    {
      object (ChunkContent)
    }
  ]
}
Campi
title

string

Il titolo del documento.
document

string

Obbligatorio. Document.name del documento. Nome completo della risorsa del documento a cui viene fatto riferimento, nel formato projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*.
uri

string

URI Cloud Storage o HTTP per il documento.
chunkContents[]

object (ChunkContent)

Elenco dei contenuti dei chunk citati derivati dai contenuti del documento.

ChunkContent

Dividere i contenuti in blocchi.

Rappresentazione JSON 
{
  "content": string,
  "pageIdentifier": string,
  "blobAttachmentIndexes": [
    string
  ]
}
Campi
content

string

Dividi i contenuti testuali in blocchi.
pageIdentifier

string

Identificatore della pagina.
blobAttachmentIndexes[]

string (int64 format)

Solo output. Memorizza gli indici degli allegati blob collegati a questo chunk.

BlobAttachment

Memorizza i dati binari allegati alla risposta di testo, ad esempio immagini, video, audio e così via.

Rappresentazione JSON 
{
  "data": {
    object (Blob)
  },
  "attributionType": enum (AttributionType)
}
Campi
data

object (Blob)

Solo output. I dati del blob.
attributionType

enum (AttributionType)

Solo output. Il tipo di attribuzione del blob.

Blob

Memorizza il tipo e i dati del blob.

Rappresentazione JSON 
{
  "mimeType": string,
  "data": string
}
Campi
mimeType

string

Solo output. Il tipo di media (tipo MIME) dei dati generati.
data

string (bytes format)

Solo output. Byte non elaborati.

Una stringa con codifica Base64.

AttributionType

Definisce il tipo di attribuzione del blob.

Enum
ATTRIBUTION_TYPE_UNSPECIFIED Tipo di attribuzione non specificato.
CORPUS I dati degli allegati provengono dal corpus.
GENERATED I dati degli allegati vengono generati dal modello tramite la generazione di codice.

Metodi

converse

 Converte una conversazione.

create

 Crea una conversazione.

delete

 Elimina una conversazione.

get

 Recupera una conversazione.

list

 Elenca tutte le conversazioni in base al relativo elemento padre DataStore.

patch

 Aggiorna una conversazione.