Method: projects.locations.collections.engines.servingConfigs.streamAnswer

Metodo di query di risposta (streaming).

Accetta un messaggio AnswerQueryRequest e restituisce più messaggi AnswerQueryResponse in uno stream.

Richiesta HTTP

POST https://discoveryengine.googleapis.com/v1/{servingConfig=projects/*/locations/*/collections/*/engines/*/servingConfigs/*}:streamAnswer

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
servingConfig

string

Obbligatorio. Il nome risorsa della configurazione di pubblicazione servingConfigs.search, ad esempio projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_serving_config o projects/*/locations/global/collections/default_collection/dataStores/*/servingConfigs/default_serving_config.

Oppure il nome risorsa della configurazione di pubblicazione del motore dell'agente, ad esempio: projects/*/locations/global/collections/default_collection/engines/*/servingConfigs/default_agent_answer. (da utilizzare quando enableAgentInvocation è impostato su true e hai configurato un motore dell'agente AI_MODE personalizzato)

Questo campo viene utilizzato per identificare il nome della configurazione di pubblicazione, il set di modelli utilizzati per eseguire la ricerca.

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "query": {
    object (Query)
  },
  "session": string,
  "safetySpec": {
    object (SafetySpec)
  },
  "relatedQuestionsSpec": {
    object (RelatedQuestionsSpec)
  },
  "groundingSpec": {
    object (GroundingSpec)
  },
  "answerGenerationSpec": {
    object (AnswerGenerationSpec)
  },
  "searchSpec": {
    object (SearchSpec)
  },
  "queryUnderstandingSpec": {
    object (QueryUnderstandingSpec)
  },
  "asynchronousMode": boolean,
  "userPseudoId": string,
  "userLabels": {
    string: string,
    ...
  },
  "endUserSpec": {
    object (EndUserSpec)
  }
}
Campi
query

object (Query)

Obbligatorio. Query dell'utente corrente.
session

string

Il nome risorsa della sessione. Non obbligatorio.

Quando il campo sessione non è impostato, l'API è in modalità senza sessione.

Supportiamo la modalità di sessione automatica: gli utenti possono utilizzare il carattere jolly - come ID sessione. Un nuovo ID verrà generato e assegnato automaticamente.
safetySpec

object (SafetySpec)

Specifica del modello.
relatedQuestionsSpec

object (RelatedQuestionsSpec)

Specifica delle domande correlate.
groundingSpec

object (GroundingSpec)

Facoltativo. Specifica di messa a terra.
answerGenerationSpec

object (AnswerGenerationSpec)

Specifica di generazione della risposta.
searchSpec

object (SearchSpec)

Specifica servingConfigs.search.
queryUnderstandingSpec

object (QueryUnderstandingSpec)

Specifica di comprensione delle query.
asynchronousMode
(deprecated)

boolean

Deprecato: questo campo è stato deprecato. L'API Streaming Answer sarà supportata.

Controllo della modalità asincrona.

Se questa opzione è abilitata, la risposta verrà restituita con il nome della risorsa risposta/sessione senza la risposta finale. Gli utenti API devono eseguire il polling per ottenere lo stato più recente della risposta/sessione chiamando il metodo ConversationalSearchService.GetAnswer o ConversationalSearchService.GetSession.
userPseudoId

string

Un identificatore univoco per il monitoraggio dei visitatori. Ad esempio, questa operazione potrebbe essere implementata con un cookie HTTP, che dovrebbe essere in grado di identificare in modo univoco un visitatore su un singolo dispositivo. Questo identificatore univoco non deve cambiare se il visitatore esegue l'accesso o la disconnessione dal sito web.

Questo campo NON deve avere un valore fisso come unknown_visitor.

Il campo deve essere una stringa con codifica UTF-8 con un limite di lunghezza di 128 caratteri. In caso contrario, viene restituito un errore INVALID_ARGUMENT.
userLabels

map (key: string, value: string)

Le etichette utente applicate a una risorsa devono soddisfare i seguenti requisiti:

  • Ogni risorsa può avere più etichette, fino a un massimo di 64.
  • Ogni etichetta deve essere una coppia chiave/valore.
  • Le chiavi hanno una lunghezza minima di 1 carattere e una lunghezza massima di 63 caratteri e non possono essere vuote. I valori possono essere vuoti e avere una lunghezza massima di 63 caratteri.
  • Le chiavi e i valori possono contenere solo lettere minuscole, caratteri numerici, trattini bassi e trattini. Tutti i caratteri devono utilizzare la codifica UTF-8; sono consentiti i caratteri internazionali.
  • La parte della chiave di un'etichetta deve essere univoca. Tuttavia, puoi utilizzare la stessa chiave con più risorse.
  • Le chiavi devono iniziare con una lettera minuscola o un carattere internazionale.

Per maggiori dettagli, consulta la documentazione di Google Cloud.
endUserSpec

object (EndUserSpec)

Facoltativo. Specifica dell'utente finale.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene uno stream di istanze AnswerQueryResponse.

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.serving.readwrite

Per saperne di più, consulta la Authentication Overview.

Autorizzazioni IAM

Richiede la seguente autorizzazione IAM per la risorsa servingConfig:

  • discoveryengine.servingConfigs.answer

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