Method: projects.locations.chat

Répond à une question sur les données en générant un flux d'objets Message.

Requête HTTP

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

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Valeur parente pour la requête de chat. Modèle : projects/{project}/locations/{location}

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation 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.
}
Champs
messages[]

object (Message)

Obligatoire. Contenu de la conversation en cours.
credentials

object (Credentials)

Facultatif. Identifiants à utiliser lors de l'appel de la ou des sources de données spécifiées dans le contexte.

Ce champ peut être utilisé pour fournir des identifiants pour différentes sources de données. Par exemple, lors de la connexion à Looker, il est actuellement compatible avec les identifiants basés sur les jetons OAuth et les clés API, comme décrit dans Authentification avec un SDK.
thinkingMode

enum (ThinkingMode)

Facultatif. Mode de réflexion à utiliser pour la boucle d'agent. La valeur par défaut est THINKING_MODE_UNSPECIFIED si elle n'est pas spécifiée.
model

enum (Model)

Facultatif. Modèle à utiliser pour la boucle de l'agent lors du traitement de la requête. Ce paramètre n'a d'effet que lorsque context.options.model n'est pas défini.
Fournisseur de contexte pour la requête de chat. Il peut s'agir de inline_context (un contexte intégré dans la requête), de data_agent (une référence à une ressource d'agent de données) ou de conversation_reference (une référence à une conversation et à un contexte persistants via un conversation_id et un agent_id). Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
inlineContext

object (Context)

Facultatif. Contexte intégré pour la requête de chat. ll vous permet d'effectuer un chat sans état, c'est-à-dire sans persistance de la conversation gérée ni recours à un agent, en fournissant l'ensemble du contexte directement dans la requête.
conversationReference

object (ConversationReference)

Facultatif. Référence à une conversation et à un contexte d'agent persistants. Cela vous permet de discuter avec un agent à l'aide de la persistance des conversations gérée.
dataAgentContext

object (DataAgentContext)

Facultatif. Contexte de la requête de chat. Il vous permet d'effectuer un chat sans état avec un agent, sans persistance de conversation gérée.
clientManagedResourceContext

object (ClientManagedResourceContext)

Facultatif. Contexte avec des ressources gérées par le client. Certains clients peuvent ne pas utiliser les ressources gérées par GDA, y compris les conversations et les agents. À la place, ils créent et gèrent leurs propres ressources de conversations et d'agents.
Fin des champs mutuellement exclusifs.
Paramètres facultatifs permettant de personnaliser le comportement de la requête, spécifiques à la source de données cible. Voici une liste de champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
lookerSettings

object (LookerSettings)

Facultatif. Paramètres spécifiques à Looker.
Fin des champs qui s'excluent mutuellement.

Corps de la réponse

Si la requête aboutit, le corps de la réponse contient un flux d'instances Message.

Niveaux d'accès des autorisations

Nécessite l'un des niveaux d'accès OAuth suivants :

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

Pour plus d'informations, consultez la Authentication Overview.

ConversationReference

Référence à une conversation et à un contexte d'agent persistants.

Représentation JSON 
{
  "conversation": string,
  "dataAgentContext": {
    object (DataAgentContext)
  }
}
Champs
conversation

string

Obligatoire. Nom de la ressource de conversation. Format : projects/{project}/locations/{location}/conversations/{conversationId}
dataAgentContext

object (DataAgentContext)

Obligatoire. Contexte de la requête de chat à l'aide d'un agent de données.

DataAgentContext

Contexte de la requête de chat à l'aide d'un agent de données.

Représentation JSON 
{
  "dataAgent": string,
  "contextVersion": enum (ContextVersion)
}
Champs
dataAgent

string

Obligatoire. Nom de la ressource de l'agent de données.
contextVersion

enum (ContextVersion)

Facultatif. Version du contexte à utiliser par DCS (par exemple, PRÉPRODUCTION, PUBLIÉ)

ContextVersion

Liste des versions de contexte compatibles avec DCS. Il existe deux versions du contexte. Cela permet d'assurer la gestion des versions de l'agent de données.

Enums
CONTEXT_VERSION_UNSPECIFIED Non spécifié ou non reconnu.
STAGING Avec cette version, DCS utilise le dernier contexte de préproduction pour l'agent de données.
PUBLISHED Avec cette version, DCS utilise le dernier contexte publié pour l'agent de données.

ClientManagedResourceContext

Contexte avec les ressources gérées par le client. Certains clients peuvent ne pas utiliser les ressources gérées par GDA, y compris les conversations et les agents. Ils préfèrent créer et gérer leurs propres ressources de conversations et d'agents.

Représentation JSON 
{
  "inlineContext": {
    object (Context)
  },
  "conversationId": string,
  "agentId": string
}
Champs
inlineContext

object (Context)

Obligatoire. Contexte de la requête de chat. Utilisez cette option pour discuter sans conversation gérée par l'API GDA ni persistance de l'agent en transmettant l'ensemble du contexte directement dans la requête.
conversationId

string

Facultatif. ID de conversation géré par le client.
agentId

string

Facultatif. ID de l'agent géré par le client.

LookerSettings

Message contenant des paramètres personnalisés spécifiques à Looker.

Représentation JSON 
{
  "enableDevMode": boolean
}
Champs
enableDevMode

boolean

Facultatif. Indique si vous souhaitez utiliser le mode Développement de Looker. Si la valeur est "true", la session API sera basculée vers l'espace de travail "dev", ce qui permettra d'interagir avec les modifications LookML dans la branche de développement de l'utilisateur. Si la valeur est "false" ou n'est pas définie, la session reste dans l'état par défaut (mode Production). Consultez https://cloud.google.com/looker/docs/dev-mode-prod-mode.

Identifiants

Représente différentes formes de spécification d'identifiants.

Représentation 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.
}
Champs
Type d'identifiants. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un des champs sera défini dans une réponse :
oauth

object (OAuthCredentials)

Identifiants OAuth.
Fin des champs mutuellement exclusifs.

OAuthCredentials

Représente les identifiants OAuth.

Représentation 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.
}
Champs
Type d'identifiants OAuth. Vous trouverez ci-dessous la liste des champs mutuellement exclusifs. Au maximum, un seul des champs sera défini dans une réponse :
secret

object (SecretBased)

Identifiants OAuth basés sur un secret.
token

object (TokenBased)

Identifiants OAuth basés sur un jeton.
Fin des champs qui s'excluent mutuellement.

SecretBased

Nom du secret contenant le jeton d'accès. Représente les identifiants OAuth basés sur un secret.

Représentation JSON 
{
  "clientId": string,
  "clientSecret": string
}
Champs
clientId

string

Obligatoire. ID client OAuth.
clientSecret

string

Obligatoire. Code secret du client OAuth.

TokenBased

Pour en savoir plus sur les jetons d'accès Looker, consultez https://developers.looker.com/api/advanced-usage/looker-api-oauth.

Représentation JSON 
{
  "accessToken": string
}
Champs
accessToken

string

Obligatoire. Nom du secret contenant le jeton d'accès.

ThinkingMode

Mode de réflexion de l'agent.

Enums
THINKING_MODE_UNSPECIFIED Valeur par défaut. Pour les sources de données BigQuery et Looker, l'agent utilise FAST. Pour toutes les autres sources de données, l'agent utilise THINKING.
FAST Mode rapide, réponses rapides.
THINKING Mode Réflexion, résout des problèmes complexes.

Modèle

Sélection de modèles pour l'agent destiné aux utilisateurs de BigQuery.

Enums
MODEL_UNSPECIFIED Aucun modèle spécifié. Vous pouvez utiliser un modèle en version preview ou non.
LATEST_GA_MODEL Utilisez le modèle hors preview le plus récent. Cela peut limiter certains paramètres au niveau de la requête.