Method: projects.locations.collections.engines.assistants.streamAssist

Aiuta l'utente con una query in modalità di streaming.

Richiesta HTTP

POST https://discoveryengine.googleapis.com/v1beta/{name=projects/*/locations/*/collections/*/engines/*/assistants/*}:streamAssist

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
name

string

Obbligatorio. Il nome della risorsa di Assistant. Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/assistants/{assistant}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "query": {
    object (Query)
  },
  "session": string,
  "userMetadata": {
    object (AssistUserMetadata)
  },
  "agentsSpec": {
    object (AgentsSpec)
  },
  "toolsSpec": {
    object (ToolsSpec)
  },
  "generationSpec": {
    object (GenerationSpec)
  }
}
Campi
query

object (Query)

Facoltativo. Query dell'utente corrente.

La query vuota è supportata solo se vengono forniti fileIds. In questo caso, la risposta verrà generata in base a questi file di contesto.
session

string

Facoltativo. La sessione da utilizzare per la richiesta. Se specificato, l'assistente ha accesso alla cronologia della sessione e la query e la risposta vengono memorizzate.

Se - viene specificato come ID sessione o se il campo viene lasciato vuoto, viene creata una nuova sessione con un ID generato automaticamente.

Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}
userMetadata

object (AssistUserMetadata)

Facoltativo. Informazioni sull'utente che avvia la query.
agentsSpec

object (AgentsSpec)

Facoltativo. Specifica degli agenti utilizzati per gestire la richiesta.
toolsSpec

object (ToolsSpec)

Facoltativo. Specifica degli strumenti utilizzati per gestire la richiesta.
generationSpec

object (GenerationSpec)

Facoltativo. Specifica della configurazione di generazione per la richiesta.

Corpo della risposta

Risposta per il metodo AssistantService.StreamAssist.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "answer": {
    object (AssistAnswer)
  },
  "sessionInfo": {
    object (SessionInfo)
  },
  "assistToken": string,
  "invocationTools": [
    string
  ],
  "invokedSkills": [
    {
      object (InvokedSkill)
    }
  ],
  "connectorAuthErrors": [
    {
      object (ConnectorAuthError)
    }
  ]
}
Campi
answer

object (AssistAnswer)

assistants.assist answer resource object contenente parti della risposta finale dell'assistente alla query dell'utente.

Non presente se la risposta attuale non aggiunge nulla a AssistAnswer.replies inviato in precedenza.

Osserva AssistAnswer.state per vedere se sono previste altre parti. Mentre lo stato è IN_PROGRESS, il campo AssistAnswer.replies di ogni risposta conterrà le risposte (frammenti di risposta) da aggiungere a quelle ricevute nelle risposte precedenti. AssistAnswer.name non verrà compilato.

Se lo stato è SUCCEEDED, FAILED o SKIPPED, la risposta è l'ultima risposta e AssistAnswer.name avrà un valore.
sessionInfo

object (SessionInfo)

Informazioni sulla sessione. Incluso solo nella risposta StreamAssistResponse finale del flusso di risposte.
assistToken

string

Un ID univoco globale che identifica la coppia corrente di richiesta e flusso di risposte. Utilizzato per feedback e assistenza.
invocationTools[]

string

I nomi degli strumenti richiamati.
invokedSkills[]

object (InvokedSkill)

Le abilità eseguite durante il turno.
connectorAuthErrors[]

object (ConnectorAuthError)

Errori di autenticazione per connettore riscontrati durante la richiesta. Presente quando l'autenticazione di uno o più connettori non è riuscita, ma la richiesta è proseguita con i connettori rimanenti.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.assist.readwrite
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa name:

  • discoveryengine.assistants.assist

Per saperne di più, consulta la documentazione di IAM.

AgentsSpec

Specifica degli agenti utilizzati per gestire la richiesta.

Rappresentazione JSON 
{
  "agentSpecs": [
    {
      object (AgentSpec)
    }
  ]
}
Campi
agentSpecs[]

object (AgentSpec)

Facoltativo. Specifica degli agenti utilizzati per gestire la richiesta.

AgentSpec

Specifica di un agente.

Rappresentazione JSON 
{
  "agentId": string,
  "inputVariables": {
    object
  }
}
Campi
agentId

string

Obbligatorio. ID per identificare la risorsa agente che gestisce la richiesta.

Questo campo deve essere conforme a RFC-1034 e avere una lunghezza massima di 63 caratteri.
inputVariables

object (Struct format)

Facoltativo. Variabili di input fornite al momento della chiamata per un WorkflowAgent. Le chiavi sono i nomi delle variabili di input dichiarate, mentre i valori sono quelli forniti dall'utente o dal chiamante. Esposto ai nodi downstream come input globali.

ToolsSpec

Specifica degli strumenti utilizzati per gestire la richiesta.

Rappresentazione JSON 
{
  "vertexAiSearchSpec": {
    object (VertexAiSearchSpec)
  },
  "webGroundingSpec": {
    object (WebGroundingSpec)
  },
  "imageGenerationSpec": {
    object (ImageGenerationSpec)
  },
  "videoGenerationSpec": {
    object (VideoGenerationSpec)
  }
}
Campi
vertexAiSearchSpec

object (VertexAiSearchSpec)

Facoltativo. Specifica dello strumento Vertex AI Search.
webGroundingSpec

object (WebGroundingSpec)

Facoltativo. Specifica dello strumento di grounding web. Se il campo è presente, abilita il grounding con la ricerca web. Funziona solo se Assistant.web_grounding_type è WEB_GROUNDING_TYPE_GOOGLE_SEARCH o WEB_GROUNDING_TYPE_ENTERPRISE_WEB_SEARCH.
imageGenerationSpec

object (ImageGenerationSpec)

Facoltativo. Specifica dello strumento di generazione di immagini.
videoGenerationSpec

object (VideoGenerationSpec)

Facoltativo. Specifica dello strumento di generazione video.

VertexAiSearchSpec

Specifica dello strumento Vertex AI Search.

Rappresentazione JSON 
{
  "dataStoreSpecs": [
    {
      object (DataStoreSpec)
    }
  ],
  "filter": string
}
Campi
dataStoreSpecs[]

object (DataStoreSpec)

Facoltativo. Specifiche che definiscono i DataStore su cui filtrare in una chiamata di ricerca e le configurazioni per questi datastore. Questo viene preso in considerazione solo per i Engine con più datastore.
filter

string

Facoltativo. La sintassi del filtro è costituita da un linguaggio di espressione per costruire un predicato da uno o più campi dei documenti filtrati. L'espressione di filtro è sensibile alle maiuscole.

Se questo campo non è riconoscibile, viene restituito un INVALID_ARGUMENT.

Il filtro in Vertex AI Search viene eseguito mappando la chiave del filtro LHS a una proprietà chiave definita nel backend di Vertex AI Search. Questa mappatura viene definita dal cliente nello schema. Ad esempio, un cliente del settore dei media potrebbe avere un campo "nome" nel proprio schema. In questo caso, il filtro sarà simile al seguente: filter --> name:'ANY("king kong")'

Per saperne di più sul filtraggio, inclusi sintassi e operatori di filtro, consulta Filtro.

WebGroundingSpec

Questo tipo non contiene campi.

Specifica dello strumento di grounding web.

ImageGenerationSpec

Questo tipo non contiene campi.

Specifica dello strumento di generazione di immagini.

VideoGenerationSpec

Questo tipo non contiene campi.

Specifica dello strumento di generazione video.

GenerationSpec

Specifica di generazione dell'assistente per la richiesta. Ciò consente di ignorare la configurazione di generazione predefinita a livello di motore.

Rappresentazione JSON 
{
  "modelId": string
}
Campi
modelId

string

Facoltativo. L'ID modello Vertex AI utilizzato per il modello generativo. Se non viene impostato, verrà utilizzato il modello dell'assistente predefinito.

SessionInfo

Informazioni sulla sessione.

Rappresentazione JSON 
{
  "session": string
}
Campi
session

string

Nome della sessione appena generata o continuata.

Formato: projects/{project}/locations/{location}/collections/{collection}/engines/{engine}/sessions/{session}.

InvokedSkill

Rappresenta una competenza utilizzata durante la chiamata di assistenza.

Rappresentazione JSON 
{
  "name": string,
  "displayName": string
}
Campi
name

string

Il nome della risorsa dell'abilità.
displayName

string

Il nome visualizzato della skill.

ConnectorAuthError

Descrive un errore di autenticazione per un connettore dati specifico.

Rappresentazione JSON 
{
  "dataConnector": string,
  "errorMessage": string
}
Campi
dataConnector

string

Nome risorsa del connettore dati per cui l'autenticazione non è riuscita.
errorMessage

string

Messaggio di errore leggibile che descrive l'errore di autenticazione.