REST Resource: projects.locations.dataAgents

Ressource : DataAgent

Message décrivant l'objet DataAgent.

Représentation JSON 
{
  "name": string,
  "displayName": string,
  "description": string,
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "purgeTime": string,

  // Union field type can be only one of the following:
  "dataAnalyticsAgent": {
    object (DataAnalyticsAgent)
  }
  // End of list of possible types for union field type.
}
Champs
name

string

Facultatif. Identifiant. Nom de ressource unique d'un DataAgent. Format : projects/{project}/locations/{location}/dataAgents/{dataAgentId} {dataAgent} correspond à l'ID de ressource. Il doit contenir 63 caractères au maximum et respecter le format décrit sur la page https://google.aip.dev/122#resource-id-segments.

Exemple : projects/1234567890/locations/us-central1/dataAgents/my-agent.

Nous vous recommandons de ne pas définir ce champ lors de la création de l'agent, car il sera déduit automatiquement et remplacé par {parent}/dataAgents/{dataAgentId}.
displayName

string

Facultatif. Nom à afficher convivial.

  • Il doit comporter entre 1 et 256 caractères.
description

string

Facultatif. Description de l'agent.

  • Elle doit comporter entre 1 et 1 024 caractères.
labels

map (key: string, value: string)

Facultatif. Étiquettes pour aider les utilisateurs à filtrer les agents associés. Par exemple, "ventes", "activité", "etl", etc. Les étiquettes ne sont utilisées que pour le filtrage et non pour les règles. Pour en savoir plus sur l'utilisation des étiquettes, consultez la documentation correspondante.

Objet contenant une liste de paires "key": value. Exemple : { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Uniquement en sortie. Heure de création de l'agent de données.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Uniquement en sortie. Heure de la dernière mise à jour de l'agent de données.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
deleteTime

string (Timestamp format)

Uniquement en sortie. [Uniquement en sortie] Heure à laquelle l'agent de données a été supprimé de façon réversible.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
purgeTime

string (Timestamp format)

Uniquement en sortie. Code temporel en UTC du moment où cet agent de données est considéré comme expiré. Ce code est toujours fourni en sortie, indépendamment de ce qui a été envoyé en entrée.

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
Champ d'union type. Type de l'agent. Il peut s'agir de l'un des types suivants : * Agent d'analyse de données. * Le type Agent d'ingénierie des données ne peut être que l'un des suivants :
dataAnalyticsAgent

object (DataAnalyticsAgent)

Agent d'analyse de données.

DataAnalyticsAgent

Message décrivant un objet DataAnalyticsAgent.

Représentation JSON 
{
  "stagingContext": {
    object (Context)
  },
  "publishedContext": {
    object (Context)
  },
  "lastPublishedContext": {
    object (Context)
  }
}
Champs
stagingContext

object (Context)

Facultatif. Contexte de préproduction de l'agent. Ce contexte permet de tester et de valider les modifications avant de les publier.
publishedContext

object (Context)

Facultatif. Contexte publié pour l'agent. Ce contexte est utilisé par l'API Chat en production.
lastPublishedContext

object (Context)

Uniquement en sortie. Dernier contexte publié pour l'agent. Il s'agit d'un champ de sortie uniquement, renseigné par le système lorsque le contexte publié est mis à jour. Il permet de restaurer l'état précédent de l'agent.

Contexte

Ensemble de contexte à appliquer à cette conversation.

Représentation JSON 
{
  "systemInstruction": string,
  "datasourceReferences": {
    object (DatasourceReferences)
  },
  "options": {
    object (ConversationOptions)
  },
  "exampleQueries": [
    {
      object (ExampleQuery)
    }
  ]
}
Champs
systemInstruction

string

Facultatif. Point d'entrée de base pour les propriétaires de données qui créent des connaissances sur le domaine pour l'agent.

Motif : le jargon d'entreprise (par exemple, "Les revenus depuis le début de l'année sont calculés comme suit…", "L'âge de départ à la retraite est de 65 ans aux États-Unis", etc.) et les instructions système (par exemple, "Réponds comme un pirate") peuvent aider le modèle à mieux comprendre le contexte commercial de la question d'un utilisateur.
datasourceReferences

object (DatasourceReferences)

Obligatoire. Sources de données disponibles pour répondre à la question.
options

object (ConversationOptions)

Facultatif. Options supplémentaires pour la conversation.
exampleQueries[]

object (ExampleQuery)

Facultatif. Liste d'exemples de requêtes SQL courantes et pertinentes, avec éventuellement les requêtes en langage naturel correspondantes. Actuellement utilisé uniquement pour les sources de données BigQuery.

DatasourceReferences

Collection de références à des sources de données.

Représentation JSON 
{

  // Union field references can be only one of the following:
  "bq": {
    object (BigQueryTableReferences)
  },
  "studio": {
    object (StudioDatasourceReferences)
  },
  "looker": {
    object (LookerExploreReferences)
  }
  // End of list of possible types for union field references.
}
Champs
Champ d'union references. Sources de données à utiliser. references ne peut être qu'un des éléments suivants :
bq

object (BigQueryTableReferences)

Références aux tables BigQuery.
studio

object (StudioDatasourceReferences)

Références aux sources de données Looker Studio.
looker

object (LookerExploreReferences)

Références aux explorations Looker.

BigQueryTableReferences

Message représentant les références aux tables BigQuery.

Représentation JSON 
{
  "tableReferences": [
    {
      object (BigQueryTableReference)
    }
  ]
}
Champs
tableReferences[]

object (BigQueryTableReference)

Obligatoire. Références aux tables BigQuery.

BigQueryTableReference

Message représentant une référence à une seule table BigQuery.

Représentation JSON 
{
  "projectId": string,
  "datasetId": string,
  "tableId": string,
  "schema": {
    object (Schema)
  }
}
Champs
projectId

string

Obligatoire. Projet auquel la table appartient.
datasetId

string

Obligatoire. Ensemble de données auquel appartient la table.
tableId

string

Obligatoire. ID de la table.
schema

object (Schema)

Facultatif. Schéma de la source de données.

Schéma

Schéma d'une instance Datasource ou QueryResult.

Représentation JSON 
{
  "fields": [
    {
      object (Field)
    }
  ],
  "description": string,
  "synonyms": [
    string
  ],
  "tags": [
    string
  ],
  "displayName": string,
  "filters": [
    {
      object (DataFilter)
    }
  ]
}
Champs
fields[]

object (Field)

Facultatif. Champs du schéma.
description

string

Facultatif. Description textuelle du contenu et de l'objectif de la table. Par exemple : "Contains information about customer orders in our e-commerce store" (Contient des informations sur les commandes des clients dans notre boutique en ligne). Actuellement utilisé uniquement pour les sources de données BigQuery.
synonyms[]

string

Facultatif. Liste des autres noms ou des synonymes qui peuvent être utilisés pour désigner la table. Par exemple : ["sales", "orders", "purchases"] ("ventes", "commandes", "achats"). Actuellement utilisé uniquement pour les sources de données BigQuery.
tags[]

string

Facultatif. Liste de tags ou de mots clés associés à la table, utilisée pour la catégorisation. Par exemple : ["transaction", "revenue", "customer_data"] ("transaction", "revenus", "données_client"). Actuellement utilisé uniquement pour les sources de données BigQuery.
displayName

string

Facultatif. Nom d'affichage de la table (identique à l'étiquette dans cloud/data_analytics/anarres/data/looker/proto/model_explore.proto). Non obligatoire. Ce champ n'est actuellement disponible que dans Looker.
filters[]

object (DataFilter)

Facultatif. Filtres appliqués aux données sous-jacentes de la source de données. Actuellement utilisé uniquement pour les sources de données Looker.

Champ

Champ d'un schéma.

Représentation JSON 
{
  "name": string,
  "type": string,
  "description": string,
  "mode": string,
  "synonyms": [
    string
  ],
  "tags": [
    string
  ],
  "displayName": string,
  "subfields": [
    {
      object (Field)
    }
  ],
  "category": string,
  "valueFormat": string
}
Champs
name

string

Facultatif. Nom du champ.
type

string

Facultatif. Type du champ.
description

string

Facultatif. Brève description du champ.
mode

string

Facultatif. Mode du champ (par exemple, NULLABLE, REPEATED).
synonyms[]

string

Facultatif. Liste des autres noms ou des synonymes qui peuvent être utilisés pour désigner le champ. Par exemple : ["id", "customerid", "cust_id"] ("id", "idclient", "id_client"). Actuellement utilisé uniquement pour les sources de données BigQuery.
tags[]

string

Facultatif. Liste de tags ou de mots clés associés au champ, utilisée pour la catégorisation. Par exemple : ["identifier", "customer", "pii"] ("identifiant", "client", "informations_personnelles"). Actuellement utilisé uniquement pour les sources de données BigQuery.
displayName

string

Facultatif. Nom à afficher du champ (identique à l'étiquette dans
subfields[]

object (Field)

Facultatif. Propriété récursive pour les structures de schéma imbriquées.
category

string

Facultatif. Catégorie de champ. Non obligatoire. Actuellement utile uniquement pour Looker. Nous utilisons une chaîne pour éviter de dépendre d'un package externe et garder ce package autonome.
valueFormat

string

Facultatif. Looker uniquement. Format de la valeur du champ. Voir : https://cloud.google.com/looker/docs/reference/param-field-value-format

DataFilter

Filtre appliqué aux données sous-jacentes d'une source de données. Documentation sur la syntaxe des filtres : https://cloud.google.com/looker/docs/filter-expressions

Représentation JSON 
{
  "field": string,
  "value": string,
  "type": enum (DataFilterType)
}
Champs
field

string

Facultatif. Champ sur lequel filtrer. Par exemple : ["event_date", "customer_id", "product_category"] ("date_événement", "id_client", "catégorie_produit).
value

string

Facultatif. Valeur par défaut utilisée pour ce filtre s'il n'est pas remplacé dans une requête. Par exemple : ["after 2024-01-01", "123", "-fashion"] ("après le 01/01/2024", "123", "mode-").
type

enum (DataFilterType)

Facultatif. Type de filtre présent dans une source de données, par exemple : ALWAYS_FILTER.

DataFilterType

Type de filtre présent dans une source de données, par exemple : ALWAYS_FILTER.

Enums
DATA_FILTER_TYPE_UNSPECIFIED Le type de filtre n'a pas été spécifié.
ALWAYS_FILTER Filtre configuré par l'utilisateur. Toutes les requêtes envoyées à l'exploration appliqueront toujours ce filtre par défaut. Actuellement utilisé uniquement pour les sources de données Looker.

StudioDatasourceReferences

Message représentant les références aux sources de données Looker Studio.

Représentation JSON 
{
  "studioReferences": [
    {
      object (StudioDatasourceReference)
    }
  ]
}
Champs
studioReferences[]

object (StudioDatasourceReference)

Références aux sources de données Studio.

StudioDatasourceReference

Message représentant une référence à une seule source de données Looker Studio.

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

string

Obligatoire. ID de la source de données.

LookerExploreReferences

Message représentant des références à des explorations Looker.

Représentation JSON 
{
  "exploreReferences": [
    {
      object (LookerExploreReference)
    }
  ],
  "credentials": {
    object (Credentials)
  }
}
Champs
exploreReferences[]

object (LookerExploreReference)

Obligatoire. Références aux explorations Looker.
credentials

object (Credentials)

Facultatif. Identifiants à utiliser lors de l'appel de l'API Looker.

Actuellement compatible avec les identifiants basés sur les jetons OAuth et les clés API, comme décrit dans Authentification avec un SDK.

LookerExploreReference

Message représentant une référence à une seule exploration Looker.

Représentation JSON 
{
  "lookmlModel": string,
  "explore": string,
  "schema": {
    object (Schema)
  },

  // Union field instance can be only one of the following:
  "lookerInstanceUri": string,
  "privateLookerInstanceInfo": {
    object (PrivateLookerInstanceInfo)
  }
  // End of list of possible types for union field instance.
}
Champs
lookmlModel

string

Obligatoire. Modèle Looker, comme indiqué dans Principales structures LookML. Nom du modèle LookML.
explore

string

Obligatoire. Exploration Looker, comme indiquée dans Principales structures LookML. Nom de l'exploration LookML.
schema

object (Schema)

Facultatif. Schéma de la source de données.
Champ d'union instance. Instance de l'exploration Looker. instance ne peut être qu'un des éléments suivants :
lookerInstanceUri

string

Obligatoire. URL de base de l'instance Looker.
privateLookerInstanceInfo

object (PrivateLookerInstanceInfo)

Informations sur l'instance Looker privée.

PrivateLookerInstanceInfo

Message représentant les informations d'une instance Looker privée requises si l'instance Looker se trouve derrière un réseau privé.

Représentation JSON 
{
  "lookerInstanceId": string,
  "serviceDirectoryName": string
}
Champs
lookerInstanceId

string

ID de l'instance Looker.
serviceDirectoryName

string

Nom de l'annuaire des services de l'instance Looker.

Identifiants

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

Représentation JSON 
{

  // Union field kind can be only one of the following:
  "oauth": {
    object (OAuthCredentials)
  }
  // End of list of possible types for union field kind.
}
Champs
Champ d'union kind. Type d'identifiants. } kind ne peut être qu'un des éléments suivants :
oauth

object (OAuthCredentials)

Identifiants OAuth.

OAuthCredentials

Représente les identifiants OAuth.

Représentation JSON 
{

  // Union field kind can be only one of the following:
  "secret": {
    object (SecretBased)
  },
  "token": {
    object (TokenBased)
  }
  // End of list of possible types for union field kind.
}
Champs
Champ d'union kind. Type d'identifiants OAuth. kind ne peut être qu'un des éléments suivants :
secret

object (SecretBased)

Identifiants OAuth basés sur un secret.
token

object (TokenBased)

Identifiants OAuth basés sur un jeton.

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.

ConversationOptions

Options de la conversation.

Représentation JSON 
{
  "chart": {
    object (ChartOptions)
  },
  "analysis": {
    object (AnalysisOptions)
  }
}
Champs
chart

object (ChartOptions)

Facultatif. Options de génération de graphiques.
analysis

object (AnalysisOptions)

Facultatif. Options d'analyse.

ChartOptions

Options de génération de graphiques.

Représentation JSON 
{
  "image": {
    object (ImageOptions)
  }
}
Champs
image

object (ImageOptions)

Facultatif. Si elle est spécifiée, l'agent affichera les graphiques générés au format indiqué. Par défaut, aucune image n'est définie.

ImageOptions

Options de rendu des images des graphiques générés.

Représentation JSON 
{

  // Union field kind can be only one of the following:
  "noImage": {
    object (NoImage)
  },
  "svg": {
    object (SvgOptions)
  }
  // End of list of possible types for union field kind.
}
Champs
Champ d'union kind. Type d'image à afficher. kind ne peut être qu'un des éléments suivants :
noImage

object (NoImage)

Aucune image.
svg

object (SvgOptions)

Format SVG.

NoImage

Ce type ne comporte aucun champ.

Aucune image.

SvgOptions

Ce type ne comporte aucun champ.

Options SVG

AnalysisOptions

Options d'analyse.

Représentation JSON 
{
  "python": {
    object (Python)
  }
}
Champs
python

object (Python)

Facultatif. Options d'analyse Python.

Python

Options d'analyse Python.

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

boolean

Facultatif. Indique si l'analyse Python doit être activée. Valeur par défaut : "false".

ExampleQuery

Exemple de requête SQL courante et pertinente, avec éventuellement les requêtes en langage naturel correspondantes. Actuellement utilisé uniquement pour les sources de données BigQuery.

Représentation JSON 
{
  "naturalLanguageQuestion": string,

  // Union field query can be only one of the following:
  "sqlQuery": string
  // End of list of possible types for union field query.
}
Champs
naturalLanguageQuestion

string

Facultatif. Question en langage naturel qu'un utilisateur peut poser. Par exemple : "Combien de commandes ont été passées le mois dernier ?"
Champ d'union query. Requête SQL ou Looker à générer pour répondre à la requête en langage naturel. query ne peut être qu'un des éléments suivants :
sqlQuery

string

Facultatif. Requête SQL à générer pour répondre à la question en langage naturel. Par exemple : "SELECT COUNT(*) FROM orders WHERE order_date BETWEEN '2024-01-01' AND '2024-01-31'"

Méthodes

create

 Crée un DataAgent dans un projet et un emplacement donnés.

delete

 Supprime un seul DataAgent.

get

 Récupère les détails d'un seul DataAgent.

getIamPolicy

 Obtient la stratégie IAM de la ressource DataAgent.

list

 Liste les DataAgents d'un projet et d'un emplacement donnés.

listAccessible

 Liste les ressources DataAgent accessibles à l'appelant dans un projet et un emplacement donnés.

patch

 Met à jour les paramètres d'un seul DataAgent.

setIamPolicy

 Définit la stratégie IAM pour un DataAgent.