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

Risorsa: risposta

Definisce una risposta.

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

string

Immutabile. Nome completo projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*/answers/*
state

enum (State)

Lo stato della generazione della risposta.
answerText

string

La risposta testuale.
citations[]

object (Citation)

Citazioni.
groundingSupports[]

object (GroundingSupport)

Facoltativo. Supporta il grounding.
references[]

object (Reference)

Riferimenti.
blobAttachments[]

object (BlobAttachment)

Elenco degli allegati blob nella risposta.
relatedQuestions[]

string

Domande correlate suggerite.
steps[]

object (Step)

Passaggi per la generazione della risposta.
queryUnderstandingInfo

object (QueryUnderstandingInfo)

Informazioni sulla comprensione delle query.
answerSkippedReasons[]

enum (AnswerSkippedReason)

Altri motivi per cui le risposte sono state saltate. Fornisce il motivo dei casi ignorati. Se non viene ignorato nulla, questo campo non viene impostato.
createTime

string (Timestamp format)

Solo output. Timestamp di creazione della risposta.

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

string (Timestamp format)

Solo output. Timestamp del completamento della risposta.

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".
safetyRatings[]

object (SafetyRating)

Facoltativo. Valutazioni della sicurezza.
groundingScore

number

Un punteggio compreso tra 0 e 1 che descrive il livello di fondatezza della risposta in base ai blocchi di riferimento.

Stato

Enumerazione dello stato della generazione della risposta.

Enum
STATE_UNSPECIFIED Sconosciuto.
IN_PROGRESS La generazione della risposta è attualmente in corso.
FAILED Al momento la generazione della risposta non è riuscita.
SUCCEEDED La generazione della risposta è riuscita.
STREAMING La generazione della risposta è attualmente in corso.

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 UTF-8). Se sono presenti caratteri multibyte,ad esempio caratteri non ASCII, la misurazione dell'indice è più lunga della lunghezza della stringa.
endIndex

string (int64 format)

Fine del segmento attribuito, escluso. Misurato in byte (Unicode UTF-8). Se sono presenti caratteri multibyte,ad esempio caratteri non ASCII, la misurazione dell'indice è più lunga della lunghezza della stringa.
sources[]

object (CitationSource)

Fonti delle citazioni per il segmento attribuito.

CitationSource

Fonte della citazione.

Rappresentazione JSON 
{
  "referenceId": string
}
Campi
referenceId

string

ID della fonte della citazione.

GroundingSupport

Supporto del grounding per una rivendicazione in answerText.

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

string (int64 format)

Obbligatorio. L'indice indica l'inizio della rivendicazione, misurata in byte (Unicode UTF-8).
endIndex

string (int64 format)

Obbligatorio. Fine della rivendicazione (valore inserito escluso).
sources[]

object (CitationSource)

Facoltativo. Fonti delle citazioni per la rivendicazione.
groundingScore

number

Un punteggio compreso tra 0 e 1 che descrive il livello di fondatezza di un'affermazione specifica in base ai riferimenti. Un valore più alto indica che l'affermazione è meglio supportata dai chunk di riferimento.
groundingCheckRequired

boolean

Indica che questa rivendicazione richiedeva un controllo della messa a terra. Quando il sistema ha deciso che questa affermazione non richiedeva un controllo di attribuzione/fondatezza, questo campo è impostato su false. In questo caso, non è stato eseguito alcun controllo di fondatezza per la rivendicazione e pertanto non viene restituito groundingScore, sources.

Riferimento

Riferimento.

Rappresentazione 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.
}
Campi
Campo unione content. Contenuti dei risultati di ricerca. content può essere solo uno dei seguenti:
unstructuredDocumentInfo

object (UnstructuredDocumentInfo)

Informazioni sui documenti non strutturati.
chunkInfo

object (ChunkInfo)

Informazioni sui chunk.
structuredDocumentInfo

object (StructuredDocumentInfo)

Informazioni strutturate sui documenti.

UnstructuredDocumentInfo

Informazioni sui documenti non strutturati.

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

string

Nome della risorsa del documento.
uri

string

URI del documento.
title

string

Titolo.
chunkContents[]

object (ChunkContent)

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

object (Struct format)

I metadati JSON strutturati per il documento. Viene compilato con i dati strutturati del blocco nel risultato di ricerca.

ChunkContent

Dividere i contenuti in blocchi.

Rappresentazione JSON 
{
  "content": string,
  "pageIdentifier": string,
  "blobAttachmentIndexes": [
    string
  ],
  "relevanceScore": number
}
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.
relevanceScore

number

La pertinenza del segmento per una determinata query. I valori vanno da 0,0 (completamente irrilevante) a 1,0 (completamente pertinente). Questo valore è fornito unicamente a scopo informativo. Può cambiare per la stessa query e lo stesso blocco in qualsiasi momento a causa di un nuovo addestramento del modello o di una modifica dell'implementazione.

ChunkInfo

Informazioni sui chunk.

Rappresentazione JSON 
{
  "chunk": string,
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  },
  "blobAttachmentIndexes": [
    string
  ],
  "relevanceScore": number
}
Campi
chunk

string

Nome della risorsa del blocco.
content

string

Dividi i contenuti testuali in blocchi.
documentMetadata

object (DocumentMetadata)

Metadati del documento.
blobAttachmentIndexes[]

string (int64 format)

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

number

La pertinenza del segmento per una determinata query. I valori vanno da 0,0 (completamente irrilevante) a 1,0 (completamente pertinente). Questo valore è fornito unicamente a scopo informativo. Può cambiare per la stessa query e lo stesso blocco in qualsiasi momento a causa di un nuovo addestramento del modello o di una modifica dell'implementazione.

DocumentMetadata

Metadati del documento.

Rappresentazione JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "structData": {
    object
  }
}
Campi
document

string

Nome della risorsa del documento.
uri

string

URI del documento.
title

string

Titolo.
pageIdentifier

string

Identificatore della pagina.
structData

object (Struct format)

I metadati JSON strutturati per il documento. Viene compilato con i dati strutturati del blocco nel risultato di ricerca.

StructuredDocumentInfo

Informazioni strutturate sulla ricerca.

Rappresentazione JSON 
{
  "document": string,
  "structData": {
    object
  },
  "title": string,
  "uri": string
}
Campi
document

string

Nome della risorsa del documento.
structData

object (Struct format)

Dati strutturati della ricerca.
title

string

Solo output. Il titolo del documento.
uri

string

Solo output. L'URI del documento.

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. Il tipo MIME e i dati del blob.
attributionType

enum (AttributionType)

Solo output. Il tipo di attribuzione del blob.

Blob

Il tipo di media 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 o recuperati.
data

string (bytes format)

Solo output. Byte non elaborati.

Una stringa con codifica Base64.

AttributionType

L'origine 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.

Passaggio

Informazioni sul passaggio.

Rappresentazione JSON 
{
  "state": enum (State),
  "description": string,
  "thought": string,
  "actions": [
    {
      object (Action)
    }
  ]
}
Campi
state

enum (State)

Lo stato del passaggio.
description

string

La descrizione del passaggio.
thought

string

Il pensiero del passo.
actions[]

object (Action)

Azioni.

Stato

Enumerazione dello stato del passaggio.

Enum
STATE_UNSPECIFIED Sconosciuto.
IN_PROGRESS Il passaggio è attualmente in corso.
FAILED Il passaggio non è riuscito.
SUCCEEDED Il passaggio è riuscito.

Azione

Azione.

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

object (Observation)

Osservazione.
Campo unione action. L'azione. action può essere solo uno dei seguenti:
searchAction

object (SearchAction)

Azione di ricerca.

SearchAction

Azione di ricerca.

Rappresentazione JSON 
{
  "query": string
}
Campi
query

string

La query da cercare.

Osservazione

Osservazione.

Rappresentazione JSON 
{
  "searchResults": [
    {
      object (SearchResult)
    }
  ]
}
Campi
searchResults[]

object (SearchResult)

Risultati di ricerca osservati dall'azione di ricerca. Possono essere informazioni sugli snippet o sui chunk, a seconda del tipo di citazione impostato dall'utente.

SearchResult

Rappresentazione JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "snippetInfo": [
    {
      object (SnippetInfo)
    }
  ],
  "chunkInfo": [
    {
      object (ChunkInfo)
    }
  ],
  "structData": {
    object
  }
}
Campi
document

string

Nome della risorsa del documento.
uri

string

URI del documento.
title

string

Titolo.
snippetInfo[]

object (SnippetInfo)

Se citation_type è DOCUMENT_LEVEL_CITATION, compila gli snippet a livello di documento.
chunkInfo[]

object (ChunkInfo)

Se citation_type è CHUNK_LEVEL_CITATION e la modalità chunk è attiva, compila le informazioni sui chunk.
structData

object (Struct format)

Rappresentazione dei dati. I dati JSON strutturati per il documento. Viene compilato con i dati strutturati del documento o del segmento nel risultato di ricerca.

SnippetInfo

Informazioni sullo snippet.

Rappresentazione JSON 
{
  "snippet": string,
  "snippetStatus": string
}
Campi
snippet

string

Contenuti dello snippet.
snippetStatus

string

Stato dello snippet definito dal team di ricerca.

ChunkInfo

Informazioni sui chunk.

Rappresentazione JSON 
{
  "chunk": string,
  "content": string,
  "relevanceScore": number
}
Campi
chunk

string

Nome della risorsa del blocco.
content

string

Dividi i contenuti testuali in blocchi.
relevanceScore

number

La pertinenza del segmento per una determinata query. I valori vanno da 0,0 (completamente irrilevante) a 1,0 (completamente pertinente). Questo valore è fornito unicamente a scopo informativo. Può cambiare per la stessa query e lo stesso blocco in qualsiasi momento a causa di un nuovo addestramento del modello o di una modifica dell'implementazione.

QueryUnderstandingInfo

Informazioni sulla comprensione delle query.

Rappresentazione JSON 
{
  "queryClassificationInfo": [
    {
      object (QueryClassificationInfo)
    }
  ]
}
Campi
queryClassificationInfo[]

object (QueryClassificationInfo)

Informazioni sulla classificazione delle query.

QueryClassificationInfo

Informazioni sulla classificazione delle query.

Rappresentazione JSON 
{
  "type": enum (Type),
  "positive": boolean
}
Campi
type

enum (Type)

Tipo di classificazione delle query.
positive

boolean

Output della classificazione.

Tipo

Tipi di classificazione delle query.

Enum
TYPE_UNSPECIFIED Tipo di classificazione delle query non specificato.
ADVERSARIAL_QUERY Tipo di classificazione delle query avversative.
NON_ANSWER_SEEKING_QUERY Tipo di classificazione delle query che non cercano risposte, per le conversazioni informali.
JAIL_BREAKING_QUERY Tipo di classificazione delle query di jailbreaking.
NON_ANSWER_SEEKING_QUERY_V2 Tipo di classificazione delle query che non cercano risposte, senza un intento chiaro.
USER_DEFINED_CLASSIFICATION_QUERY Tipo di classificazione delle query definito dall'utente.

AnswerSkippedReason

Un'enumerazione per i motivi per cui è stata saltata una risposta.

Enum
ANSWER_SKIPPED_REASON_UNSPECIFIED Valore predefinito. Il motivo per cui la risposta è stata ignorata non è specificato.
ADVERSARIAL_QUERY_IGNORED La query contraddittoria ignorava la distinzione tra maiuscole e minuscole.
NON_ANSWER_SEEKING_QUERY_IGNORED

La query che non cerca risposte ignora maiuscole/minuscole

Google salta la risposta se la query è una chiacchiera.
OUT_OF_DOMAIN_QUERY_IGNORED

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

Google salta la risposta se non ci sono risultati di ricerca di pertinenza elevata.
POTENTIAL_POLICY_VIOLATION

Il caso di potenziale violazione delle norme.

Google salta la risposta se viene rilevata una potenziale violazione delle norme. Sono inclusi contenuti che potrebbero essere violenti o tossici.
NO_RELEVANT_CONTENT

Il caso di nessun contenuto pertinente.

Google salta la risposta se non ci sono 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". Google salta la risposta se la query viene classificata come query di jailbreak.
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_ANSWER_SEEKING_QUERY_IGNORED_V2

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

Google salta la risposta se la query non ha un intento chiaro.
LOW_GROUNDED_ANSWER

La risposta più semplice.

Google salta la risposta se non è stato possibile generare una risposta ben fondata.
USER_DEFINED_CLASSIFICATION_QUERY_IGNORED

La classificazione delle query definita dall'utente non fa distinzione tra maiuscole e minuscole.

Google ignora la risposta se la query viene classificata come classificazione delle query definita dall'utente.
UNHELPFUL_ANSWER

Lo scenario della risposta non utile.

Google salta la risposta se non è utile. Ciò può essere dovuto a una serie di fattori, tra cui, a titolo esemplificativo: la query non è risolvibile, la risposta non è pertinente alla query o la risposta non è formattata correttamente.

SafetyRating

Classificazione di sicurezza corrispondente ai contenuti generati.

Rappresentazione JSON 
{
  "category": enum (HarmCategory),
  "probability": enum (HarmProbability),
  "probabilityScore": number,
  "severity": enum (HarmSeverity),
  "severityScore": number,
  "blocked": boolean
}
Campi
category

enum (HarmCategory)

Solo output. Categoria del danno.
probability

enum (HarmProbability)

Solo output. Livelli di probabilità di danni nei contenuti.
probabilityScore

number

Solo output. Punteggio di probabilità di danni.
severity

enum (HarmSeverity)

Solo output. Livelli di gravità del danno nei contenuti.
severityScore

number

Solo output. Punteggio di gravità del danno.
blocked

boolean

Solo output. Indica se i contenuti sono stati filtrati a causa di questa classificazione.

HarmCategory

Categorie di danni che bloccheranno i contenuti.

Enum
HARM_CATEGORY_UNSPECIFIED La categoria di danno non è specificata.
HARM_CATEGORY_HATE_SPEECH La categoria del danno è incitamento all'odio.
HARM_CATEGORY_DANGEROUS_CONTENT La categoria di danno è "Contenuti pericolosi".
HARM_CATEGORY_HARASSMENT La categoria del danno è molestie.
HARM_CATEGORY_SEXUALLY_EXPLICIT La categoria di danno è Contenuti sessualmente espliciti.
HARM_CATEGORY_CIVIC_INTEGRITY La categoria di danno è integrità civica.

HarmProbability

Livelli di probabilità di danni nei contenuti.

Enum
HARM_PROBABILITY_UNSPECIFIED Probabilità di danni non specificata.
NEGLIGIBLE Livello di danno trascurabile.
LOW Basso livello di danno.
MEDIUM Danno di impatto medio.
HIGH Alto livello di danno.

HarmSeverity

Livelli di gravità del danno.

Enum
HARM_SEVERITY_UNSPECIFIED Gravità del danno non specificata.
HARM_SEVERITY_NEGLIGIBLE Livello di gravità del danno trascurabile.
HARM_SEVERITY_LOW Basso livello di gravità del danno.
HARM_SEVERITY_MEDIUM Livello medio di gravità del danno.
HARM_SEVERITY_HIGH Elevato livello di gravità del danno.

Metodi

get

 Riceve una risposta.