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

Aiuta l'utente con una query.

Richiesta HTTP

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

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,
  "assistSkippingMode": enum (AssistSkippingMode),
  "fileIds": [
    string
  ],
  "userMetadata": {
    object (AssistUserMetadata)
  }
}
Campi
query

object (Query)

Facoltativo. Query 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 viene lasciato vuoto, viene creata una nuova sessione con un ID generato automaticamente.

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

enum (AssistSkippingMode)

Facoltativo. Determina i casi in cui l'assistente non risponderà alla query. Se la risposta viene ignorata, i motivi verranno elencati in AssistAnswer.assist_skipped_reasons entro AssistResponse.answer.
fileIds[]

string

Facoltativo. Gli ID dei file da utilizzare per rispondere alla richiesta. Quando carichi un file, il suo ID viene restituito in AddContextFileResponse.file_id.
userMetadata

object (AssistUserMetadata)

Facoltativo. Informazioni sull'utente che avvia la query.

Corpo della risposta

Risposta per il metodo AssistantService.Assist.

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
}
Campi
answer

object (AssistAnswer)

La risorsa AssistAnswer generata in risposta alla query.
sessionInfo

object (SessionInfo)

Informazioni sulla sessione.
assistToken

string

Un ID univoco globale che identifica la coppia richiesta-risposta corrente. Utilizzato per feedback e assistenza.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per ulteriori informazioni, consulta 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.

AssistSkippingMode

Comportamenti di salto disponibili per le richieste di assistenza.

Enum
ASSIST_SKIPPING_MODE_UNSPECIFIED Valore predefinito. La risposta può essere ignorata se la query non richiede assistenza.
REQUEST_ASSIST Richiedi la risposta dell'assistente. La risposta può comunque essere ignorata se la query non supera i controlli delle norme.

SessionInfo

Informazioni sulla sessione.

Rappresentazione JSON 
{
  "session": string,
  "queryId": string
}
Campi
session

string

Nome della sessione appena generata o continuata.

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

string

ID query corrispondente a questa chiamata API Assist. Una sessione può avere più turni, ognuno con un ID query univoco.

Se specifichi il nome della sessione e questo ID query nella chiamata API assistants.assist, la richiesta di assistenza viene eseguita nel contesto dei risultati di ricerca di questa chiamata di ricerca.