Method: projects.locations.chat

Risponde a una domanda sui dati generando un flusso di oggetti Message.

Richiesta HTTP

POST https://geminidataanalytics.googleapis.com/v1/{parent=projects/*/locations/*}:chat

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il valore della risorsa padre per la richiesta di chat. Pattern: projects/{project}/locations/{location}

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON
{
  "messages": [
    {
      object (Message)
    }
  ],
  "credentials": {
    object (Credentials)
  },
  "thinkingMode": enum (ThinkingMode),
  "model": enum (Model),

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "inlineContext": {
    object (Context)
  },
  "conversationReference": {
    object (ConversationReference)
  },
  "dataAgentContext": {
    object (DataAgentContext)
  },
  "clientManagedResourceContext": {
    object (ClientManagedResourceContext)
  }
  // End of mutually exclusive fields.

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "lookerSettings": {
    object (LookerSettings)
  }
  // End of mutually exclusive fields.
}
Campi
messages[]

object (Message)

Obbligatorio. Contenuti della conversazione corrente.

credentials

object (Credentials)

Facoltativo. Le credenziali da utilizzare per chiamare le origini dati specificate nel contesto.

Questo campo può essere utilizzato per fornire le credenziali per varie origini dati. Ad esempio, quando ti connetti a Looker, attualmente sono supportate sia le credenziali basate su token OAuth sia quelle basate su chiave API, come descritto in Autenticazione con un SDK.

thinkingMode

enum (ThinkingMode)

Facoltativo. La modalità di pensiero da utilizzare per il loop dell'agente. Se non specificato, il valore predefinito è THINKING_MODE_UNSPECIFIED.

model

enum (Model)

Facoltativo. Il modello da utilizzare per il loop dell'agente durante l'elaborazione della richiesta. Questa impostazione ha effetto solo quando context.options.model non è impostato.

Fornitore di contesto per la richiesta di chat. Può essere: inline_context, ovvero un contesto fornito in linea nella richiesta; data_agent, ovvero un riferimento a una risorsa dell'agente di dati; conversation_reference, ovvero un riferimento a una conversazione e a un contesto persistenti utilizzando conversation_id e agent_id. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
inlineContext

object (Context)

Facoltativo. Contesto incorporato per la richiesta di chat. Utilizzalo per chattare in modalità stateless (senza persistenza della conversazione gestita e senza un agente) passando tutto il contesto in linea.

conversationReference

object (ConversationReference)

Facoltativo. Riferimento a una conversazione persistente e al contesto dell'agente. Utilizzalo per chattare con un agente utilizzando la persistenza della conversazione gestita.

dataAgentContext

object (DataAgentContext)

Facoltativo. Contesto della richiesta di chat. Utilizzalo per chattare con un agente in modalità stateless, senza persistenza della conversazione gestita.

clientManagedResourceContext

object (ClientManagedResourceContext)

Facoltativo. Contesto con risorse gestite dal client. Alcuni clienti potrebbero non utilizzare le risorse gestite da GDA, tra cui conversazioni e agenti, ma creare e gestire le proprie risorse di conversazioni e agenti.

Fine dei campi che si escludono a vicenda.
Impostazioni facoltative per personalizzare il comportamento della richiesta, specifiche per l'origine dati di destinazione. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
lookerSettings

object (LookerSettings)

Facoltativo. Impostazioni specifiche di Looker.

Fine dei campi che si escludono a vicenda.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un flusso di istanze Message.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti OAuth:

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

Per saperne di più, consulta la Authentication Overview.

ConversationReference

Riferimento a una conversazione persistente e al contesto dell'agente.

Rappresentazione JSON
{
  "conversation": string,
  "dataAgentContext": {
    object (DataAgentContext)
  }
}
Campi
conversation

string

Obbligatorio. Nome della risorsa conversazione. Formato: projects/{project}/locations/{location}/conversations/{conversationId}

dataAgentContext

object (DataAgentContext)

Obbligatorio. Contesto della richiesta di chat utilizzando un agente dati.

DataAgentContext

Contesto per la richiesta di chat utilizzando un agente di dati.

Rappresentazione JSON
{
  "dataAgent": string,
  "contextVersion": enum (ContextVersion)
}
Campi
dataAgent

string

Obbligatorio. Il nome della risorsa dell'agente di dati.

contextVersion

enum (ContextVersion)

Facoltativo. Versione del contesto da utilizzare per DCS (ad es. STAGING, PUBLISHED)

ContextVersion

Elenco delle versioni del contesto supportate da DCS. Esistono due versioni del contesto. In questo modo viene mantenuto il controllo delle versioni per l'agente di dati.

Enum
CONTEXT_VERSION_UNSPECIFIED Non specificato o non riconosciuto.
STAGING Con questa versione, DCS utilizzerà l'ultimo contesto di gestione temporanea per l'agente di dati.
PUBLISHED Se utilizzi questa versione, DCS utilizzerà l'ultimo contesto pubblicato per l'agente di dati.

ClientManagedResourceContext

Contesto con risorse gestite dal cliente. Alcuni clienti potrebbero non utilizzare le risorse gestite da GDA, tra cui conversazioni e agenti, ma creare e gestire le proprie risorse di conversazioni e agenti.

Rappresentazione JSON
{
  "inlineContext": {
    object (Context)
  },
  "conversationId": string,
  "agentId": string
}
Campi
inlineContext

object (Context)

Obbligatorio. Contesto della richiesta di chat. Utilizza questo parametro per chattare senza la conversazione gestita dall'API GDA e la persistenza dell'agente passando tutto il contesto inline.

conversationId

string

Facoltativo. L'ID conversazione gestita dal cliente.

agentId

string

Facoltativo. L'ID dell'agente gestito dal client.

LookerSettings

Messaggio per contenere le impostazioni personalizzate specifiche di Looker.

Rappresentazione JSON
{
  "enableDevMode": boolean
}
Campi
enableDevMode

boolean

Facoltativo. Se operare in modalità di sviluppo di Looker. Se impostato su true, la sessione API passerà all'area di lavoro "dev", consentendo l'interazione con le modifiche di LookML nel branch di sviluppo dell'utente. Se viene impostato su False o se non viene configurato, la sessione rimane nello stato predefinito (modalità di produzione). Consulta la pagina https://cloud.google.com/looker/docs/dev-mode-prod-mode.

Credenziali

Rappresenta diverse forme di specifica delle credenziali.

Rappresentazione JSON
{

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

object (OAuthCredentials)

Credenziali OAuth.

Fine dei campi che si escludono a vicenda.

OAuthCredentials

Rappresenta le credenziali OAuth.

Rappresentazione JSON
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "secret": {
    object (SecretBased)
  },
  "token": {
    object (TokenBased)
  }
  // End of mutually exclusive fields.
}
Campi
Il tipo di credenziali OAuth. Di seguito è riportato un elenco di campi che si escludono a vicenda. In una risposta verrà impostato al massimo uno dei campi:
secret

object (SecretBased)

Credenziali OAuth basate sul secret.

token

object (TokenBased)

Credenziali OAuth basate su token.

Fine dei campi che si escludono a vicenda.

SecretBased

Il nome del secret contenente il token di accesso. Rappresenta le credenziali OAuth basate su secret.

Rappresentazione JSON
{
  "clientId": string,
  "clientSecret": string
}
Campi
clientId

string

Obbligatorio. Un ID client OAuth.

clientSecret

string

Obbligatorio. Un client secret OAuth.

TokenBased

Scopri di più sui token di accesso di Looker qui: https://developers.looker.com/api/advanced-usage/looker-api-oauth

Rappresentazione JSON
{
  "accessToken": string
}
Campi
accessToken

string

Obbligatorio. Il nome del secret contenente il token di accesso.

ThinkingMode

Modalità di pensiero dell'agente.

Enum
THINKING_MODE_UNSPECIFIED Il valore predefinito. Per le origini dati BigQuery e Looker, l'agente utilizza FAST. Per tutte le altre origini dati, l'agente utilizza THINKING.
FAST Modalità veloce, risposte rapide.
THINKING Modalità di ragionamento, risolve problemi complessi.

Modello

Selezione del modello per l'agente per gli utenti di BigQuery.

Enum
MODEL_UNSPECIFIED Nessun modello specificato. È possibile utilizzare il modello di anteprima o non di anteprima.
LATEST_GA_MODEL Utilizza il modello non in anteprima più aggiornato. Ciò potrebbe limitare alcune impostazioni a livello di richiesta.