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

Risorsa: AssistAnswer

Risorsa AssistAnswer, parte principale di AssistResponse.

Rappresentazione JSON 
{
  "name": string,
  "state": enum (State),
  "replies": [
    {
      object (Reply)
    }
  ],
  "assistSkippedReasons": [
    enum (AssistSkippedReason)
  ],
  "customerPolicyEnforcementResult": {
    object (CustomerPolicyEnforcementResult)
  }
}
Campi
name

string

Immutabile. Identificatore. Nome risorsa di AssistAnswer. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}/assistAnswers/{assistAnswer}

Questo campo deve essere una stringa codificata in UTF-8 con un limite di lunghezza di 1024 caratteri.
state

enum (State)

Stato della generazione della risposta.
replies[]

object (Reply)

Risposte dell'assistente.
assistSkippedReasons[]

enum (AssistSkippedReason)

Motivi per cui non rispondere alla chiamata di assistenza.
customerPolicyEnforcementResult

object (CustomerPolicyEnforcementResult)

Facoltativo. Il campo contiene informazioni sui risultati dei vari controlli delle norme, come le frasi vietate o i controlli Model Armor. Questo campo viene compilato solo se la chiamata di assistenza è stata ignorata a causa di una violazione delle norme.

Stato

Stato della generazione della risposta.

Enum
STATE_UNSPECIFIED Sconosciuto.
IN_PROGRESS L'operazione di assistenza è attualmente in corso.
FAILED L'operazione di assistenza non è riuscita.
SUCCEEDED L'operazione di assistenza è riuscita.
SKIPPED L'operazione di assistenza è stata ignorata.

Rispondi

Una parte della risposta in più parti della chiamata di assistenza.

Rappresentazione JSON 
{

  // Union field reply can be only one of the following:
  "groundedContent": {
    object (AssistantGroundedContent)
  }
  // End of list of possible types for union field reply.
}
Campi
Campo unione reply. Alternative per la risposta dell'assistente. reply può essere solo uno dei seguenti:
groundedContent

object (AssistantGroundedContent)

Testo o contenuti multimediali della risposta dell'assistente che potrebbero essere basati su informazioni non aggiornate.

AssistantGroundedContent

Un contenuto ed eventualmente le relative informazioni di base.

Non tutti i contenuti richiedono un grounding. Frasi come "Certo, lo cercherò volentieri per te" non richiedono una base.

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

object (AssistantContent)

I contenuti.
citationMetadata

object (CitationMetadata)

Attribuzione della fonte dei contenuti generati. Vedi anche https://cloud.google.com/vertex-ai/generative-ai/docs/learn/overview#citation_check
contentMetadata

object (ContentMetadata)

(Facoltativo) Metadati per i contenuti. Attualmente utilizzato solo per le risposte degli assistenti alla ricerca.
Campo unione metadata. Metadati di base per varie finestre modali. Per ora supporta solo il testo. metadata può essere solo uno dei seguenti:
textGroundingMetadata

object (TextGroundingMetadata)

Metadati per la contestualizzazione basata su fonti di testo.

TextGroundingMetadata

Dettagli di base per le fonti di testo.

Rappresentazione JSON 
{
  "segments": [
    {
      object (Segment)
    }
  ],
  "references": [
    {
      object (Reference)
    }
  ]
}
Campi
segments[]

object (Segment)

Informazioni di base per parti del testo.
references[]

object (Reference)

Riferimenti per il testo basato su dati reali.

Segmento

Informazioni di base per un segmento del testo.

Rappresentazione JSON 
{
  "startIndex": string,
  "endIndex": string,
  "referenceIndices": [
    integer
  ],
  "groundingScore": number,
  "text": string
}
Campi
startIndex

string (int64 format)

Indice in base zero che indica l'inizio del segmento, misurato in byte di una stringa UTF-8 (ovvero i caratteri codificati su più byte hanno una lunghezza superiore a uno).
endIndex

string (int64 format)

Fine del segmento, esclusa.
referenceIndices[]

integer

Riferimenti per il segmento.
groundingScore

number

Punteggio del segmento.
text

string

Il segmento di testo.

Riferimento

Contenuti a cui viene fatto riferimento e metadati dei documenti correlati.

Rappresentazione JSON 
{
  "content": string,
  "documentMetadata": {
    object (DocumentMetadata)
  }
}
Campi
content

string

Contenuti testuali a cui viene fatto riferimento.
documentMetadata

object (DocumentMetadata)

Metadati del documento.

DocumentMetadata

Metadati del documento.

Rappresentazione JSON 
{
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "domain": string,
  "mimeType": string
}
Campi
document

string

Nome della risorsa del documento.
uri

string

URI del documento. Potrebbe contenere un URL che reindirizza al sito web effettivo.
title

string

Titolo.
pageIdentifier

string

Identificatore della pagina.
domain

string

Nome di dominio dall'URI del documento. Tieni presente che il campo uri potrebbe contenere un URL che reindirizza al sito web effettivo, nel qual caso conterrà il nome di dominio del sito di destinazione.
mimeType

string

Il tipo MIME del documento. https://www.iana.org/assignments/media-types/media-types.xhtml.

AssistantContent

Contenuti multimodali.

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

string

Il produttore dei contenuti. Può essere "model" o "user".
thought

boolean

Facoltativo. Indica se la parte è stata pensata dal modello.
Campo unione data. Dati contenuti. data può essere solo uno dei seguenti:
text

string

Testo in linea.
inlineData

object (Blob)

Dati binari in linea.
file

object (File)

Un file, ad esempio un riepilogo audio.
executableCode

object (ExecutableCode)

codice generato dal modello che deve essere eseguito.
codeExecutionResult

object (CodeExecutionResult)

Risultato dell'esecuzione di un ExecutableCode.

Blob

Blob in linea.

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

string

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

string (bytes format)

Obbligatorio. Byte non elaborati.

Una stringa con codifica Base64.

File

Un file, ad esempio un riepilogo audio.

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

string

Obbligatorio. Il tipo di media (tipo MIME) del file.
fileId

string

Obbligatorio. L'ID file.

ExecutableCode

codice generato dal modello che deve essere eseguito dal modello.

Rappresentazione JSON 
{
  "code": string
}
Campi
code

string

Obbligatorio. Il contenuto del codice. Al momento supporta solo Python.

CodeExecutionResult

Risultato dell'esecuzione di ExecutableCode.

Rappresentazione JSON 
{
  "outcome": enum (Outcome),
  "output": string
}
Campi
outcome

enum (Outcome)

Obbligatorio. Risultato dell'esecuzione del codice.
output

string

Facoltativo. Contiene stdout se l'esecuzione del codice è riuscita, stderr o un'altra descrizione in caso contrario.

Risultato

Enumerazione dei possibili risultati dell'esecuzione del codice.

Enum
OUTCOME_UNSPECIFIED Stato non specificato. Questo valore non deve essere utilizzato.
OUTCOME_OK L'esecuzione del codice è stata completata correttamente.
OUTCOME_FAILED L'esecuzione del codice è terminata, ma con un errore. stderr deve contenere il motivo.
OUTCOME_DEADLINE_EXCEEDED L'esecuzione del codice è durata troppo a lungo ed è stata annullata. Potrebbe essere presente o meno un output parziale.

CitationMetadata

Una raccolta di attribuzioni delle fonti per un contenuto.

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

object (Citation)

Solo output. Elenco delle citazioni.

Citazione

Attribuzioni delle fonti per i contenuti.

Rappresentazione JSON 
{
  "startIndex": integer,
  "endIndex": integer,
  "uri": string,
  "title": string,
  "license": string,
  "publicationDate": {
    object (Date)
  }
}
Campi
startIndex

integer

Solo output. Indice iniziale dei contenuti.
endIndex

integer

Solo output. Indice finale dei contenuti.
uri

string

Solo output. Riferimento URL dell'attribuzione.
title

string

Solo output. Titolo dell'attribuzione.
license

string

Solo output. Licenza dell'attribuzione.
publicationDate

object (Date)

Solo output. La data di pubblicazione dell'attribuzione.

ContentMetadata

metadati dei contenuti.

Rappresentazione JSON 
{
  "contentKind": enum (ContentKind),
  "contentId": string
}
Campi
contentKind

enum (ContentKind)

tipo di contenuti. Mostra a quale parte della risposta dell'assistente alla ricerca appartengono questi contenuti.
contentId

string

ID dei contenuti. Viene utilizzato per collegare le domande di ricerca alle relative risposte. Ad esempio, le parti della risposta a una domanda di ricerca avranno lo stesso contentId della domanda.

ContentKind

Possibili tipi di contenuti. Attualmente utilizzato solo per differenziare le sezioni nella risposta completa di un assistente alla ricerca.

Enum
CONTENT_KIND_UNSPECIFIED Sconosciuto.
RESEARCH_PLAN Piano di ricerca.
RESEARCH_QUESTION Domanda di ricerca.
RESEARCH_ANSWER Risposta della ricerca.
RESEARCH_REPORT Report di ricerca.
RESEARCH_AUDIO_SUMMARY Cerca riepilogo audio.

AssistSkippedReason

Possibili motivi per cui non si risponde a una chiamata di assistenza.

Enum
ASSIST_SKIPPED_REASON_UNSPECIFIED Valore predefinito. Il motivo del salto non è specificato.
NON_ASSIST_SEEKING_QUERY_IGNORED L'assistente ha ignorato la query perché non sembrava essere una domanda.
CUSTOMER_POLICY_VIOLATION L'assistente ha ignorato la query o si è rifiutato di rispondere a causa di una violazione delle norme relative ai clienti (ad esempio, la query o la risposta conteneva una frase vietata).

CustomerPolicyEnforcementResult

Risultati dell'applicazione delle norme relative ai clienti. Contiene i risultati dei vari controlli delle norme, come le frasi vietate o i controlli di Model Armor.

Rappresentazione JSON 
{
  "verdict": enum (Verdict),
  "policyResults": [
    {
      object (PolicyEnforcementResult)
    }
  ]
}
Campi
verdict

enum (Verdict)

Verdetto finale sull'applicazione delle norme per i clienti. Se solo una norma ha bloccato l'elaborazione, il verdetto è BLOCCA.
policyResults[]

object (PolicyEnforcementResult)

Risultati dell'applicazione delle norme relative ai clienti. Compilato solo se la chiamata di assistenza è stata ignorata a causa di una violazione delle norme. Contiene i risultati dei filtri che hanno bloccato l'elaborazione della query.

Verdetto

Il verdetto dell'applicazione delle norme per i clienti.

Enum
UNSPECIFIED Valore sconosciuto.
ALLOW Non è stata rilevata alcuna violazione delle norme.
BLOCK L'elaborazione è stata bloccata dalle norme relative ai clienti.

PolicyEnforcementResult

Risultato dell'applicazione forzata dei criteri del cliente per un singolo tipo di norma.

Rappresentazione 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.
}
Campi
Campo unione enforcement_result. Il risultato specifico del tipo di norma. Può trattarsi di un errore o di informazioni dettagliate sul risultato dell'applicazione delle norme. enforcement_result può essere solo uno dei seguenti:
bannedPhraseEnforcementResult

object (BannedPhraseEnforcementResult)

Il risultato dell'applicazione forzata delle norme per le norme relative alle frasi vietate.
modelArmorEnforcementResult

object (ModelArmorEnforcementResult)

Il risultato dell'applicazione forzata del criterio Model Armor.

BannedPhraseEnforcementResult

Risultato dell'applicazione delle norme per i clienti per le norme relative alle frasi vietate.

Rappresentazione JSON 
{
  "bannedPhrases": [
    string
  ]
}
Campi
bannedPhrases[]

string

Le frasi vietate trovate nella query o nella risposta.

ModelArmorEnforcementResult

Risultato dell'applicazione delle norme relative ai clienti per le norme Model Armor.

Rappresentazione 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.
}
Campi
Campo unione result. Il risultato del criterio Model Armor. result può essere solo uno dei seguenti:
modelArmorViolation

string

La violazione di Model Armor rilevata.
error

object (Status)

L'errore restituito da Model Armor se l'applicazione forzata del criterio non è riuscita per qualche motivo.

Metodi

get

 Riceve un AssistAnswer.