@google-cloud/discoveryengine 0.6.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (44) hide show
  1. package/CHANGELOG.md +17 -0
  2. package/README.md +38 -22
  3. package/build/protos/google/cloud/discoveryengine/v1/common.proto +100 -0
  4. package/build/protos/google/cloud/discoveryengine/v1/completion_service.proto +116 -0
  5. package/build/protos/google/cloud/discoveryengine/v1/document.proto +118 -0
  6. package/build/protos/google/cloud/discoveryengine/v1/document_service.proto +313 -0
  7. package/build/protos/google/cloud/discoveryengine/v1/import_config.proto +334 -0
  8. package/build/protos/google/cloud/discoveryengine/v1/purge_config.proto +86 -0
  9. package/build/protos/google/cloud/discoveryengine/v1/schema.proto +58 -0
  10. package/build/protos/google/cloud/discoveryengine/v1/schema_service.proto +256 -0
  11. package/build/protos/google/cloud/discoveryengine/v1/search_service.proto +289 -0
  12. package/build/protos/google/cloud/discoveryengine/v1/user_event.proto +458 -0
  13. package/build/protos/google/cloud/discoveryengine/v1/user_event_service.proto +133 -0
  14. package/build/protos/google/cloud/discoveryengine/v1beta/import_config.proto +54 -0
  15. package/build/protos/google/cloud/discoveryengine/v1beta/search_service.proto +29 -4
  16. package/build/protos/protos.d.ts +6589 -0
  17. package/build/protos/protos.js +16050 -1
  18. package/build/protos/protos.json +1807 -0
  19. package/build/src/index.d.ts +18 -19
  20. package/build/src/index.js +9 -9
  21. package/build/src/v1/completion_service_client.d.ts +455 -0
  22. package/build/src/v1/completion_service_client.js +659 -0
  23. package/build/src/v1/completion_service_client_config.json +43 -0
  24. package/build/src/v1/document_service_client.d.ts +995 -0
  25. package/build/src/v1/document_service_client.js +1191 -0
  26. package/build/src/v1/document_service_client_config.json +82 -0
  27. package/build/src/v1/index.d.ts +5 -0
  28. package/build/src/v1/index.js +31 -0
  29. package/build/src/v1/schema_service_client.d.ts +795 -0
  30. package/build/src/v1/schema_service_client.js +1129 -0
  31. package/build/src/v1/schema_service_client_config.json +63 -0
  32. package/build/src/v1/search_service_client.d.ts +857 -0
  33. package/build/src/v1/search_service_client.js +1073 -0
  34. package/build/src/v1/search_service_client_config.json +43 -0
  35. package/build/src/v1/user_event_service_client.d.ts +638 -0
  36. package/build/src/v1/user_event_service_client.js +933 -0
  37. package/build/src/v1/user_event_service_client_config.json +62 -0
  38. package/build/src/v1beta/document_service_client.d.ts +52 -0
  39. package/build/src/v1beta/document_service_client.js +6 -0
  40. package/build/src/v1beta/schema_service_client.js +6 -0
  41. package/build/src/v1beta/search_service_client.d.ts +78 -12
  42. package/build/src/v1beta/search_service_client.js +52 -8
  43. package/build/src/v1beta/user_event_service_client.js +6 -0
  44. package/package.json +2 -2
@@ -382,6 +382,11 @@ message SearchRequest {
382
382
  // If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
383
383
  string order_by = 8;
384
384
 
385
+ // Information about the end user.
386
+ // Highly recommended for analytics. The user_agent string in UserInfo will
387
+ // be used to deduce device_type for analytics.
388
+ UserInfo user_info = 21;
389
+
385
390
  // Facet specifications for faceted search. If empty, no facets are returned.
386
391
  //
387
392
  // A maximum of 100 values are allowed. Otherwise, an `INVALID_ARGUMENT`
@@ -393,16 +398,13 @@ message SearchRequest {
393
398
 
394
399
  // Additional search parameters.
395
400
  //
396
- // For
397
- // [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH]
398
- // vertical, supported values are:
401
+ // For public website search only, supported values are:
399
402
  //
400
403
  // * `user_country_code`: string. Default empty. If set to non-empty, results
401
404
  // are restricted or boosted based on the location provided.
402
405
  // * `search_type`: double. Default empty. Enables non-webpage searching
403
406
  // depending on the value. The only valid non-default value is 1,
404
407
  // which enables image searching.
405
- // This field is ignored for other verticals.
406
408
  map<string, google.protobuf.Value> params = 11;
407
409
 
408
410
  // The query expansion specification that specifies the conditions under which
@@ -432,6 +434,29 @@ message SearchRequest {
432
434
  // The content search spec that configs the desired behavior of content
433
435
  // search.
434
436
  ContentSearchSpec content_search_spec = 24;
437
+
438
+ // Whether to turn on safe search. This is only supported for
439
+ // [ContentConfig.PUBLIC_WEBSITE][].
440
+ bool safe_search = 20;
441
+
442
+ // The user labels applied to a resource must meet the following requirements:
443
+ //
444
+ // * Each resource can have multiple labels, up to a maximum of 64.
445
+ // * Each label must be a key-value pair.
446
+ // * Keys have a minimum length of 1 character and a maximum length of 63
447
+ // characters and cannot be empty. Values can be empty and have a maximum
448
+ // length of 63 characters.
449
+ // * Keys and values can contain only lowercase letters, numeric characters,
450
+ // underscores, and dashes. All characters must use UTF-8 encoding, and
451
+ // international characters are allowed.
452
+ // * The key portion of a label must be unique. However, you can use the same
453
+ // key with multiple resources.
454
+ // * Keys must start with a lowercase letter or international character.
455
+ //
456
+ // See [Google Cloud
457
+ // Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
458
+ // for more details.
459
+ map<string, string> user_labels = 22;
435
460
  }
436
461
 
437
462
  // Response message for