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

Risorsa: AssistAnswer

Risorsa AssistAnswer, parte principale di AssistResponse.

Rappresentazione JSON 
{
  "name": string,
  "state": enum (State),
  "connectorDisplayNames": {
    string: string,
    ...
  },
  "replies": [
    {
      object (Reply)
    }
  ],
  "diagnosticInfo": {
    object
  },
  "assistSkippedReasons": [
    enum (AssistSkippedReason)
  ],
  "requiredAuthorizations": [
    {
      object (RequiredAuthorization)
    }
  ],
  "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 con codifica UTF-8 con un limite di lunghezza di 1024 caratteri.
state

enum (State)

Stato della generazione della risposta.
connectorDisplayNames

map (key: string, value: string)

Solo output. Mappa un nome di agente connettore interno (l'identificatore della macchina incorporato nei nomi degli strumenti, ad es. custom_mcp_<fingerprint>_agent) al nome visualizzato leggibile del connettore. Viene compilato al momento della pubblicazione per i connettori gateway MCP / agente personalizzati in modo che le interfacce rivolte agli utenti (ad es. il chip di chiamata allo strumento) possano mostrare il nome del connettore anziché il suo identificatore interno. Vuoto se non sono presenti connettori di questo tipo.
replies[]

object (Reply)

Risposte dell'assistente.
diagnosticInfo

object (Struct format)

Facoltativo. Informazioni diagnostiche raccolte durante l'elaborazione della richiesta. È destinato solo ai lettori umani, principalmente per facilitare il debug. La struttura dei dati è soggetta a modifiche senza preavviso.
assistSkippedReasons[]

enum (AssistSkippedReason)

Motivi per cui non rispondere alla chiamata di assistenza.
requiredAuthorizations[]

object (RequiredAuthorization)

Solo output. L'elenco delle autorizzazioni richieste. Viene compilato solo quando l'utente non è autorizzato per un determinato Authorization, ma l'agente richiamato lo richiede.
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.
CANCELLED L'operazione di assistenza è stata annullata (ad es. il client ha chiuso lo stream). Potrebbe contenere una risposta parziale.

Rispondi

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

Rappresentazione JSON 
{
  "replyId": string,
  "createTime": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "groundedContent": {
    object (AssistantGroundedContent)
  }
  // End of mutually exclusive fields.
}
Campi
replyId

string

Solo output. Se impostato, identifica in modo univoco una risposta all'interno della risorsa AssistAnswer. Durante una chiamata AssistantService.StreamAssist, possono verificarsi più messaggi Reply con lo stesso ID all'interno del flusso di risposta (in più messaggi StreamAssistResponse). Questi rappresentano parti di un singolo messaggio Reply nella risorsa AssistAnswer finale.
createTime

string (Timestamp format)

L'ora in cui è stata creata la risposta.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z 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".
Alternative per la risposta dell'assistente. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
groundedContent

object (AssistantGroundedContent)

Testo o contenuti multimediali della risposta dell'assistente, che potrebbero essere basati su informazioni reali.
Fine dei campi che si escludono a vicenda.

AssistantGroundedContent

Un contenuto ed eventualmente le relative informazioni di base.

Non tutti i contenuti devono essere basati su dati reali. Frasi come "Certo, lo cercherò volentieri per te" non richiedono grounding.

Rappresentazione JSON 
{
  "content": {
    object (AssistantContent)
  },
  "citationMetadata": {
    object (CitationMetadata)
  },
  "contentMetadata": {
    object (ContentMetadata)
  },

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "textGroundingMetadata": {
    object (TextGroundingMetadata)
  }
  // End of mutually exclusive fields.
}
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.
Metadati di base per varie finestre modali. Al momento supporta solo il testo. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
textGroundingMetadata

object (TextGroundingMetadata)

Metadati per la fondatezza basati su fonti di testo.
Fine dei campi che si escludono a vicenda.

TextGroundingMetadata

Dettagli di grounding per le fonti di testo.

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

object (Segment)

Informazioni di base per parti del testo.
visualSegments[]

object (VisualSegment)

Informazioni di base per parti dei contenuti visivi.
references[]

object (Reference)

Riferimenti per il testo basato sul contesto.
searchEntryPoints[]

object (SearchEntryPoint)

Facoltativo. Punti di accesso della Ricerca Google per le ricerche web utilizzate per la fondatezza.

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

VisualSegment

Informazioni di base per un segmento visivo.

Rappresentazione JSON 
{
  "referenceIndices": [
    integer
  ],
  "contentId": string
}
Campi
referenceIndices[]

integer

Riferimenti per il segmento visivo.
contentId

string

L'ID Content ID del segmento visivo. Per visualizzare la citazione dell'elemento visivo, questo ContentID deve corrispondere al campo groundedContent.content_metadata.content_id.

Riferimento

Contenuti a cui viene fatto riferimento e metadati del documento correlati.

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

string

Contenuti di testo a cui viene fatto riferimento.
codeSnippet

string

Blocco dello snippet di codice del documento a cui viene fatto riferimento.
documentMetadata

object (DocumentMetadata)

Metadati del documento.
chunkMetadata

object (Struct format)

Solo output. Metadati generici strutturati dei chunk dai connettori delle origini dati upstream.

DocumentMetadata

Metadati del documento.

Rappresentazione JSON 
{
  "language": enum (Language),
  "boundingBoxes": [
    {
      object (BoundingBox)
    }
  ],
  "document": string,
  "uri": string,
  "title": string,
  "pageIdentifier": string,
  "domain": string,
  "mimeType": string
}
Campi
language

enum (Language)
boundingBoxes[]

object (BoundingBox)

Facoltativo. Riquadri di delimitazione per questo riferimento. Ripetuto per supportare i riferimenti che generano più pagine.
document

string

Nome della risorsa del documento.
uri

string

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

Lingua

Lingua dei contenuti a cui viene fatto riferimento. Per ora, viene utilizzato solo per il codice.

Enum
LANGUAGE_UNSPECIFIED
PYTHON
SQL

BoundingBox

Un riquadro di delimitazione che genera una singola pagina.

Rappresentazione JSON 
{
  "pageNumber": string,
  "boundingPoly": {
    object (BoundingPoly)
  }
}
Campi
pageNumber

string
boundingPoly

object (BoundingPoly)

Poligono di delimitazione per i contenuti di testo nel documento.

BoundingPoly

Poligono di delimitazione per i contenuti di testo nel documento.

Rappresentazione JSON 
{
  "normalizedVertices": [
    {
      object (NormalizedVertex)
    }
  ]
}
Campi
normalizedVertices[]

object (NormalizedVertex)

NormalizedVertex

Un vertice rappresenta un punto 2D nell'immagine.

NOTA: le coordinate dei vertici normalizzate sono relative all'immagine originale e vanno da 0 a 1.

Rappresentazione JSON 
{
  "x": number,
  "y": number
}
Campi
x

number

Coordinata X.
y

number

Coordinata Y (a partire dalla parte superiore dell'immagine).

SearchEntryPoint

Punto di accesso della Ricerca Google.

Rappresentazione JSON 
{
  "renderedContent": string
}
Campi
renderedContent

string

Snippet di contenuti web che può essere incorporato in una pagina web o in una webview di un'app.

AssistantContent

Contenuti multimodali.

Rappresentazione JSON 
{
  "role": string,
  "thought": boolean,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "text": string,
  "inlineData": {
    object (Blob)
  },
  "file": {
    object (File)
  },
  "executableCode": {
    object (ExecutableCode)
  },
  "codeExecutionResult": {
    object (CodeExecutionResult)
  }
  // End of mutually exclusive fields.
}
Campi
role

string

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

boolean

Facoltativo. Indica se la parte è stata pensata dal modello.
Dati contenuti. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
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.
Fine dei campi che si escludono a vicenda.

Blob

Blob inline.

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 in 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 quando l'esecuzione del codice va a buon fine, stderr o un'altra descrizione in caso contrario.

Risultato

Enumerazione dei possibili risultati dell'esecuzione di codice.

Enum
OUTCOME_UNSPECIFIED Stato non specificato. Questo valore non deve essere utilizzato.
OUTCOME_OK Esecuzione del codice 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 di 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 nei contenuti.
endIndex

integer

Solo output. Indice finale nei contenuti.
uri

string

Solo output. Riferimento all'URL dell'attribuzione.
title

string

Solo output. Titolo dell'attribuzione.
license

string

Solo output. Licenza dell'attribuzione.
publicationDate

object (Date)

Solo output. Data di pubblicazione dell'attribuzione.

ContentMetadata

metadati per i contenuti.

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

enum (ContentKind)

tipo di contenuti. Mostra a quale parte della risposta dell'assistente di 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 di 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 rispondere 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 es. la query o la risposta conteneva una frase vietata).

RequiredAuthorization

Rappresenta un'autorizzazione necessaria per il funzionamento dell'agente.

Rappresentazione JSON 
{
  "authorization": string,
  "displayName": string,
  "authorizationUri": string,
  "authConfig": {
    object (AuthConfig)
  }
}
Campi
authorization

string

Solo output. Il nome del Authorization.
displayName

string

Solo output. Il nome visualizzato dell'autorizzazione.
authorizationUri

string

Solo output. L'URI che l'utente deve aprire per autorizzare.
authConfig

object (AuthConfig)

Solo output. Configurazione per un'autorizzazione richiesta da un agente di terze parti (ADK). Questo campo viene compilato quando l'autorizzazione ha origine da un agente ADK; in questo caso, il nome della risorsa proprietaria authorization riportato sopra in genere non è impostato.

AuthConfig

Configurazione per l'autorizzazione di terze parti.

Rappresentazione JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "oauth2": {
    object (OAuth2Credential)
  }
  // End of mutually exclusive fields.
}
Campi
Configurazione della credenziale. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
oauth2

object (OAuth2Credential)

Configurazione delle credenziali OAuth2.
Fine dei campi che si escludono a vicenda.

OAuth2Credential

Configurazione per l'autorizzazione OAuth2.

Rappresentazione JSON 
{
  "clientId": string,
  "clientSecret": string,
  "nonce": string,
  "state": string,
  "redirectUri": string,
  "authResponseUri": string,
  "authCode": string,
  "accessToken": string,
  "refreshToken": string,
  "idToken": string,
  "expireTime": string,
  "expireDuration": string,
  "audience": string,
  "codeVerifier": string,
  "codeChallengeMethod": string,
  "tokenEndpointAuthMethod": string
}
Campi
clientId

string

Solo output. L'ID client.
clientSecret

string

Solo output. Il client secret.
nonce

string

Solo output. Il valore nonce.
state

string

Solo output. Il valore dello stato.
redirectUri

string

Solo output. L'URI di reindirizzamento.
authResponseUri

string

Solo output. L'URI di risposta all'autorizzazione.
authCode

string

Solo output. Il codice di autorizzazione.
accessToken

string

Solo output. Il token di accesso.
refreshToken

string

Solo output. Il token di aggiornamento.
idToken

string

Solo output. Il token ID.
expireTime

string (Timestamp format)

Solo output. L'ora di scadenza.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z 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".
expireDuration

string (Duration format)

Solo output. La durata della scadenza.

Una durata in secondi con un massimo di nove cifre frazionarie, che termina con "s". Esempio: "3.5s".
audience

string

Solo output. Il pubblico.
codeVerifier

string

Solo output. Il verificatore del codice.
codeChallengeMethod

string

Solo output. Il metodo di verifica del codice.
tokenEndpointAuthMethod

string

Solo output. Il metodo di autorizzazione dell'endpoint token.

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)
    }
  ],
  "violationSource": enum (ViolationSource)
}
Campi
verdict

enum (Verdict)

Verdetto finale sull'applicazione delle norme per i clienti. Se solo una policy ha bloccato l'elaborazione, l'esito è BLOCK.
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.
violationSource

enum (ViolationSource)

Solo output. L'origine della violazione.

Esito

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 delle norme del cliente per un singolo tipo di norma.

Rappresentazione JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "bannedPhraseEnforcementResult": {
    object (BannedPhraseEnforcementResult)
  },
  "modelArmorEnforcementResult": {
    object (ModelArmorEnforcementResult)
  }
  // End of mutually exclusive fields.
}
Campi
Il risultato specifico del tipo di policy. Può trattarsi di un errore o di informazioni dettagliate sul risultato dell'applicazione del criterio. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
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 della policy Model Armor.
Fine dei campi che si escludono a vicenda.

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 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "modelArmorViolation": string,
  "error": {
    object (Status)
  }
  // End of mutually exclusive fields.
}
Campi
Il risultato della policy Model Armor. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
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.
Fine dei campi che si escludono a vicenda.

ViolationSource

Se la chiamata di assistenza è stata ignorata a causa di una violazione delle norme, questo campo contiene l'origine della violazione.

Enum
VIOLATION_SOURCE_UNSPECIFIED Valore sconosciuto.
SYSTEM Violazione rilevata nella risposta del sistema.
PROMPT Violazione rilevata nel prompt dell'utente.
ATTACHMENT È stata rilevata una violazione nell'allegato dell'utente.

Metodi

get

 Riceve un AssistAnswer.