Method: projects.locations.apps.runAssistant

Esegue l'agente dell'assistente per la sessione dell'assistente specificata.

Richiesta HTTP

POST https://ces.googleapis.com/v1beta/{app=projects/*/locations/*/apps/*}:runAssistant

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri di percorso

Parametri
app

string

Obbligatorio. L'app per cui eseguire l'assistente. Formato: projects/{project}/locations/{location}/apps/{app}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "assistantSession": string,
  "message": {
    object (AssistantMessage)
  },
  "interactionType": enum (RunAssistantRequest.InteractionType)
}
Campi
assistantSession

string

Obbligatorio. La sessione dell'assistente da utilizzare per eseguire l'assistente. Formato: projects/{project}/locations/{location}/apps/{app}/assistantSessions/{assistantSession}
message

object (AssistantMessage)

Obbligatorio. Il messaggio da inviare all'agente assistente.
interactionType

enum (RunAssistantRequest.InteractionType)

Facoltativo. Diversi tipi di interazione per il messaggio dell'assistente.

Corpo della risposta

Messaggio di risposta per AssistantService.RunAssistant.

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

Rappresentazione JSON 
{
  "output": {
    object (AssistantOutput)
  },
  "state": enum (AssistantSessionState)
}
Campi
output

object (AssistantOutput)

Obbligatorio. L'output dell'agente assistente.
state

enum (AssistantSessionState)

Solo output. Lo stato della sessione dell'assistente.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/ces

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa app:

  • ces.apps.update

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

RunAssistantRequest.InteractionType

Il tipo di interazione per il messaggio inviato all'assistente.

Enum
INTERACTION_TYPE_UNSPECIFIED Il valore predefinito. Questo valore viene utilizzato se il tipo non è specificato.
NEW_MESSAGE Il messaggio è un input utente. L'input dell'utente viene fornito nell'elenco dei segmenti.
POLL Il messaggio serve per eseguire il polling dello stato della sessione dell'assistente.
DISMISS Il messaggio serve a ignorare la sessione dell'assistente in attesa di revisione. In questo modo, lo stato della sessione dell'assistente diventerà inattivo.

AssistantOutput

L'output dell'agente assistente.

Rappresentazione JSON 
{
  "message": {
    object (AssistantMessage)
  },
  "userResponseSuggestions": {
    object (UserResponseSuggestions)
  }
}
Campi
message

object (AssistantMessage)

Obbligatorio. La risposta dell'agente assistente.
userResponseSuggestions

object (UserResponseSuggestions)

Solo output. Risposte utente suggerite dall'agente dell'assistente.