legacy-libs/dialogflow/src/v2beta1/doc/google/cloud/dialogflow/v2beta1/doc_entity_type.js

   1 // Copyright 2019 Google LLC
   2 //
   3 // Licensed under the Apache License, Version 2.0 (the "License");
   4 // you may not use this file except in compliance with the License.
   5 // You may obtain a copy of the License at
   6 //
   7 //     https://www.apache.org/licenses/LICENSE-2.0
   8 //
   9 // Unless required by applicable law or agreed to in writing, software
  10 // distributed under the License is distributed on an "AS IS" BASIS,
  11 // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  12 // See the License for the specific language governing permissions and
  13 // limitations under the License.
  14
  15 // Note: this file is purely for documentation. Any contents are not expected
  16 // to be loaded as the JS file.
  17
  18 /**
  19  * Represents an entity type.
  20  * Entity types serve as a tool for extracting parameter values from natural
  21  * language queries.
  22  *
  23  * @property {string} name
  24  *   Required for all methods except `create` (`create` populates the name
  25  *   automatically.
  26  *   The unique identifier of the entity type. Format:
  27  *   `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
  28  *
  29  * @property {string} displayName
  30  *   Required. The name of the entity.
  31  *
  32  * @property {number} kind
  33  *   Required. Indicates the kind of entity type.
  34  *
  35  *   The number should be among the values of [Kind]{@link google.cloud.dialogflow.v2beta1.Kind}
  36  *
  37  * @property {number} autoExpansionMode
  38  *   Optional. Indicates whether the entity type can be automatically
  39  *   expanded.
  40  *
  41  *   The number should be among the values of [AutoExpansionMode]{@link google.cloud.dialogflow.v2beta1.AutoExpansionMode}
  42  *
  43  * @property {Object[]} entities
  44  *   Optional. The collection of entities associated with the entity type.
  45  *
  46  *   This object should have the same structure as [Entity]{@link google.cloud.dialogflow.v2beta1.Entity}
  47  *
  48  * @typedef EntityType
  49  * @memberof google.cloud.dialogflow.v2beta1
  50  * @see [google.cloud.dialogflow.v2beta1.EntityType definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2beta1/entity_type.proto}
  51  */
  52 const EntityType = {
  53   // This is for documentation. Actual contents will be loaded by gRPC.
  54
  55   /**
  56    * Optional. Represents an entity.
  57    *
  58    * @property {string} value
  59    *   Required.
  60    *   For `KIND_MAP` entity types:
  61    *     A canonical name to be used in place of synonyms.
  62    *   For `KIND_LIST` entity types:
  63    *     A string that can contain references to other entity types (with or
  64    *     without aliases).
  65    *
  66    * @property {string[]} synonyms
  67    *   Required. A collection of synonyms. For `KIND_LIST` entity types this
  68    *   must contain exactly one synonym equal to `value`.
  69    *
  70    * @typedef Entity
  71    * @memberof google.cloud.dialogflow.v2beta1
  72    * @see [google.cloud.dialogflow.v2beta1.EntityType.Entity definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2beta1/entity_type.proto}
  73    */
  74   Entity: {
  75     // This is for documentation. Actual contents will be loaded by gRPC.
  76   },
  77
  78   /**
  79    * Represents different entity type expansion modes. Automated expansion
  80    * allows an agent to recognize values that have not been explicitly listed in
  81    * the entity (for example, new kinds of shopping list items).
  82    *
  83    * @enum {number}
  84    * @memberof google.cloud.dialogflow.v2beta1
  85    */
  86   AutoExpansionMode: {
  87
  88     /**
  89      * Auto expansion disabled for the entity.
  90      */
  91     AUTO_EXPANSION_MODE_UNSPECIFIED: 0,
  92
  93     /**
  94      * Allows an agent to recognize values that have not been explicitly
  95      * listed in the entity.
  96      */
  97     AUTO_EXPANSION_MODE_DEFAULT: 1
  98   },
  99
 100   /**
 101    * Represents kinds of entities.
 102    *
 103    * @enum {number}
 104    * @memberof google.cloud.dialogflow.v2beta1
 105    */
 106   Kind: {
 107
 108     /**
 109      * Not specified. This value should be never used.
 110      */
 111     KIND_UNSPECIFIED: 0,
 112
 113     /**
 114      * Map entity types allow mapping of a group of synonyms to a canonical
 115      * value.
 116      */
 117     KIND_MAP: 1,
 118
 119     /**
 120      * List entity types contain a set of entries that do not map to canonical
 121      * values. However, list entity types can contain references to other entity
 122      * types (with or without aliases).
 123      */
 124     KIND_LIST: 2
 125   }
 126 };
 127
 128 /**
 129  * The request message for
 130  * EntityTypes.ListEntityTypes.
 131  *
 132  * @property {string} parent
 133  *   Required. The agent to list all entity types from.
 134  *   Format: `projects/<Project ID>/agent`.
 135  *
 136  * @property {string} languageCode
 137  *   Optional. The language to list entity synonyms for. If not specified,
 138  *   the agent's default language is used.
 139  *   [More than a dozen
 140  *   languages](https://dialogflow.com/docs/reference/language) are supported.
 141  *   Note: languages must be enabled in the agent, before they can be used.
 142  *
 143  * @property {number} pageSize
 144  *   Optional. The maximum number of items to return in a single page. By
 145  *   default 100 and at most 1000.
 146  *
 147  * @property {string} pageToken
 148  *   Optional. The next_page_token value returned from a previous list request.
 149  *
 150  * @typedef ListEntityTypesRequest
 151  * @memberof google.cloud.dialogflow.v2beta1
 152  * @see [google.cloud.dialogflow.v2beta1.ListEntityTypesRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2beta1/entity_type.proto}
 153  */
 154 const ListEntityTypesRequest = {
 155   // This is for documentation. Actual contents will be loaded by gRPC.
 156 };
 157
 158 /**
 159  * The response message for
 160  * EntityTypes.ListEntityTypes.
 161  *
 162  * @property {Object[]} entityTypes
 163  *   The list of agent entity types. There will be a maximum number of items
 164  *   returned based on the page_size field in the request.
 165  *
 166  *   This object should have the same structure as [EntityType]{@link google.cloud.dialogflow.v2beta1.EntityType}
 167  *
 168  * @property {string} nextPageToken
 169  *   Token to retrieve the next page of results, or empty if there are no
 170  *   more results in the list.
 171  *
 172  * @typedef ListEntityTypesResponse
 173  * @memberof google.cloud.dialogflow.v2beta1
 174  * @see [google.cloud.dialogflow.v2beta1.ListEntityTypesResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2beta1/entity_type.proto}
 175  */
 176 const ListEntityTypesResponse = {
 177   // This is for documentation. Actual contents will be loaded by gRPC.
 178 };
 179
 180 /**
 181  * The request message for
 182  * EntityTypes.GetEntityType.
 183  *
 184  * @property {string} name
 185  *   Required. The name of the entity type.
 186  *   Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
 187  *
 188  * @property {string} languageCode
 189  *   Optional. The language to retrieve entity synonyms for. If not specified,
 190  *   the agent's default language is used.
 191  *   [More than a dozen
 192  *   languages](https://dialogflow.com/docs/reference/language) are supported.
 193  *   Note: languages must be enabled in the agent, before they can be used.
 194  *
 195  * @typedef GetEntityTypeRequest
 196  * @memberof google.cloud.dialogflow.v2beta1
 197  * @see [google.cloud.dialogflow.v2beta1.GetEntityTypeRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2beta1/entity_type.proto}
 198  */
 199 const GetEntityTypeRequest = {
 200   // This is for documentation. Actual contents will be loaded by gRPC.
 201 };
 202
 203 /**
 204  * The request message for
 205  * EntityTypes.CreateEntityType.
 206  *
 207  * @property {string} parent
 208  *   Required. The agent to create a entity type for.
 209  *   Format: `projects/<Project ID>/agent`.
 210  *
 211  * @property {Object} entityType
 212  *   Required. The entity type to create.
 213  *
 214  *   This object should have the same structure as [EntityType]{@link google.cloud.dialogflow.v2beta1.EntityType}
 215  *
 216  * @property {string} languageCode
 217  *   Optional. The language of entity synonyms defined in `entity_type`. If not
 218  *   specified, the agent's default language is used.
 219  *   [More than a dozen
 220  *   languages](https://dialogflow.com/docs/reference/language) are supported.
 221  *   Note: languages must be enabled in the agent, before they can be used.
 222  *
 223  * @typedef CreateEntityTypeRequest
 224  * @memberof google.cloud.dialogflow.v2beta1
 225  * @see [google.cloud.dialogflow.v2beta1.CreateEntityTypeRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2beta1/entity_type.proto}
 226  */
 227 const CreateEntityTypeRequest = {
 228   // This is for documentation. Actual contents will be loaded by gRPC.
 229 };
 230
 231 /**
 232  * The request message for
 233  * EntityTypes.UpdateEntityType.
 234  *
 235  * @property {Object} entityType
 236  *   Required. The entity type to update.
 237  *   Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
 238  *
 239  *   This object should have the same structure as [EntityType]{@link google.cloud.dialogflow.v2beta1.EntityType}
 240  *
 241  * @property {string} languageCode
 242  *   Optional. The language of entity synonyms defined in `entity_type`. If not
 243  *   specified, the agent's default language is used.
 244  *   [More than a dozen
 245  *   languages](https://dialogflow.com/docs/reference/language) are supported.
 246  *   Note: languages must be enabled in the agent, before they can be used.
 247  *
 248  * @property {Object} updateMask
 249  *   Optional. The mask to control which fields get updated.
 250  *
 251  *   This object should have the same structure as [FieldMask]{@link google.protobuf.FieldMask}
 252  *
 253  * @typedef UpdateEntityTypeRequest
 254  * @memberof google.cloud.dialogflow.v2beta1
 255  * @see [google.cloud.dialogflow.v2beta1.UpdateEntityTypeRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2beta1/entity_type.proto}
 256  */
 257 const UpdateEntityTypeRequest = {
 258   // This is for documentation. Actual contents will be loaded by gRPC.
 259 };
 260
 261 /**
 262  * The request message for
 263  * EntityTypes.DeleteEntityType.
 264  *
 265  * @property {string} name
 266  *   Required. The name of the entity type to delete.
 267  *   Format: `projects/<Project ID>/agent/entityTypes/<EntityType ID>`.
 268  *
 269  * @typedef DeleteEntityTypeRequest
 270  * @memberof google.cloud.dialogflow.v2beta1
 271  * @see [google.cloud.dialogflow.v2beta1.DeleteEntityTypeRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2beta1/entity_type.proto}
 272  */
 273 const DeleteEntityTypeRequest = {
 274   // This is for documentation. Actual contents will be loaded by gRPC.
 275 };
 276
 277 /**
 278  * The request message for
 279  * EntityTypes.BatchUpdateEntityTypes.
 280  *
 281  * @property {string} parent
 282  *   Required. The name of the agent to update or create entity types in.
 283  *   Format: `projects/<Project ID>/agent`.
 284  *
 285  * @property {string} entityTypeBatchUri
 286  *   The URI to a Google Cloud Storage file containing entity types to update
 287  *   or create. The file format can either be a serialized proto (of
 288  *   EntityBatch type) or a JSON object. Note: The URI must start with
 289  *   "gs://".
 290  *
 291  * @property {Object} entityTypeBatchInline
 292  *   The collection of entity type to update or create.
 293  *
 294  *   This object should have the same structure as [EntityTypeBatch]{@link google.cloud.dialogflow.v2beta1.EntityTypeBatch}
 295  *
 296  * @property {string} languageCode
 297  *   Optional. The language of entity synonyms defined in `entity_types`. If not
 298  *   specified, the agent's default language is used.
 299  *   [More than a dozen
 300  *   languages](https://dialogflow.com/docs/reference/language) are supported.
 301  *   Note: languages must be enabled in the agent, before they can be used.
 302  *
 303  * @property {Object} updateMask
 304  *   Optional. The mask to control which fields get updated.
 305  *
 306  *   This object should have the same structure as [FieldMask]{@link google.protobuf.FieldMask}
 307  *
 308  * @typedef BatchUpdateEntityTypesRequest
 309  * @memberof google.cloud.dialogflow.v2beta1
 310  * @see [google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2beta1/entity_type.proto}
 311  */
 312 const BatchUpdateEntityTypesRequest = {
 313   // This is for documentation. Actual contents will be loaded by gRPC.
 314 };
 315
 316 /**
 317  * The response message for
 318  * EntityTypes.BatchUpdateEntityTypes.
 319  *
 320  * @property {Object[]} entityTypes
 321  *   The collection of updated or created entity types.
 322  *
 323  *   This object should have the same structure as [EntityType]{@link google.cloud.dialogflow.v2beta1.EntityType}
 324  *
 325  * @typedef BatchUpdateEntityTypesResponse
 326  * @memberof google.cloud.dialogflow.v2beta1
 327  * @see [google.cloud.dialogflow.v2beta1.BatchUpdateEntityTypesResponse definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2beta1/entity_type.proto}
 328  */
 329 const BatchUpdateEntityTypesResponse = {
 330   // This is for documentation. Actual contents will be loaded by gRPC.
 331 };
 332
 333 /**
 334  * The request message for
 335  * EntityTypes.BatchDeleteEntityTypes.
 336  *
 337  * @property {string} parent
 338  *   Required. The name of the agent to delete all entities types for. Format:
 339  *   `projects/<Project ID>/agent`.
 340  *
 341  * @property {string[]} entityTypeNames
 342  *   Required. The names entity types to delete. All names must point to the
 343  *   same agent as `parent`.
 344  *
 345  * @typedef BatchDeleteEntityTypesRequest
 346  * @memberof google.cloud.dialogflow.v2beta1
 347  * @see [google.cloud.dialogflow.v2beta1.BatchDeleteEntityTypesRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2beta1/entity_type.proto}
 348  */
 349 const BatchDeleteEntityTypesRequest = {
 350   // This is for documentation. Actual contents will be loaded by gRPC.
 351 };
 352
 353 /**
 354  * The request message for
 355  * EntityTypes.BatchCreateEntities.
 356  *
 357  * @property {string} parent
 358  *   Required. The name of the entity type to create entities in. Format:
 359  *   `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
 360  *
 361  * @property {Object[]} entities
 362  *   Required. The collection of entities to create.
 363  *
 364  *   This object should have the same structure as [Entity]{@link google.cloud.dialogflow.v2beta1.Entity}
 365  *
 366  * @property {string} languageCode
 367  *   Optional. The language of entity synonyms defined in `entities`. If not
 368  *   specified, the agent's default language is used.
 369  *   [More than a dozen
 370  *   languages](https://dialogflow.com/docs/reference/language) are supported.
 371  *   Note: languages must be enabled in the agent, before they can be used.
 372  *
 373  * @typedef BatchCreateEntitiesRequest
 374  * @memberof google.cloud.dialogflow.v2beta1
 375  * @see [google.cloud.dialogflow.v2beta1.BatchCreateEntitiesRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2beta1/entity_type.proto}
 376  */
 377 const BatchCreateEntitiesRequest = {
 378   // This is for documentation. Actual contents will be loaded by gRPC.
 379 };
 380
 381 /**
 382  * The response message for
 383  * EntityTypes.BatchCreateEntities.
 384  *
 385  * @property {string} parent
 386  *   Required. The name of the entity type to update the entities in. Format:
 387  *   `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
 388  *
 389  * @property {Object[]} entities
 390  *   Required. The collection of new entities to replace the existing entities.
 391  *
 392  *   This object should have the same structure as [Entity]{@link google.cloud.dialogflow.v2beta1.Entity}
 393  *
 394  * @property {string} languageCode
 395  *   Optional. The language of entity synonyms defined in `entities`. If not
 396  *   specified, the agent's default language is used.
 397  *   [More than a dozen
 398  *   languages](https://dialogflow.com/docs/reference/language) are supported.
 399  *   Note: languages must be enabled in the agent, before they can be used.
 400  *
 401  * @property {Object} updateMask
 402  *   Optional. The mask to control which fields get updated.
 403  *
 404  *   This object should have the same structure as [FieldMask]{@link google.protobuf.FieldMask}
 405  *
 406  * @typedef BatchUpdateEntitiesRequest
 407  * @memberof google.cloud.dialogflow.v2beta1
 408  * @see [google.cloud.dialogflow.v2beta1.BatchUpdateEntitiesRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2beta1/entity_type.proto}
 409  */
 410 const BatchUpdateEntitiesRequest = {
 411   // This is for documentation. Actual contents will be loaded by gRPC.
 412 };
 413
 414 /**
 415  * The request message for
 416  * EntityTypes.BatchDeleteEntities.
 417  *
 418  * @property {string} parent
 419  *   Required. The name of the entity type to delete entries for. Format:
 420  *   `projects/<Project ID>/agent/entityTypes/<Entity Type ID>`.
 421  *
 422  * @property {string[]} entityValues
 423  *   Required. The canonical `values` of the entities to delete. Note that
 424  *   these are not fully-qualified names, i.e. they don't start with
 425  *   `projects/<Project ID>`.
 426  *
 427  * @property {string} languageCode
 428  *   Optional. The language of entity synonyms defined in `entities`. If not
 429  *   specified, the agent's default language is used.
 430  *   [More than a dozen
 431  *   languages](https://dialogflow.com/docs/reference/language) are supported.
 432  *   Note: languages must be enabled in the agent, before they can be used.
 433  *
 434  * @typedef BatchDeleteEntitiesRequest
 435  * @memberof google.cloud.dialogflow.v2beta1
 436  * @see [google.cloud.dialogflow.v2beta1.BatchDeleteEntitiesRequest definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2beta1/entity_type.proto}
 437  */
 438 const BatchDeleteEntitiesRequest = {
 439   // This is for documentation. Actual contents will be loaded by gRPC.
 440 };
 441
 442 /**
 443  * This message is a wrapper around a collection of entity types.
 444  *
 445  * @property {Object[]} entityTypes
 446  *   A collection of entity types.
 447  *
 448  *   This object should have the same structure as [EntityType]{@link google.cloud.dialogflow.v2beta1.EntityType}
 449  *
 450  * @typedef EntityTypeBatch
 451  * @memberof google.cloud.dialogflow.v2beta1
 452  * @see [google.cloud.dialogflow.v2beta1.EntityTypeBatch definition in proto format]{@link https://github.com/googleapis/googleapis/blob/master/google/cloud/dialogflow/v2beta1/entity_type.proto}
 453  */
 454 const EntityTypeBatch = {
 455   // This is for documentation. Actual contents will be loaded by gRPC.
 456 };