@google-cloud/discoveryengine 1.0.0 → 1.2.0

package/build/protos/google/cloud/discoveryengine/v1/document.proto

@@ -59,8 +59,11 @@ message Document {
 
     // The MIME type of the content. Supported types:
     //
-    // * `application/pdf` (PDF)
+    // * `application/pdf` (PDF, only native PDFs are supported for now)
     // * `text/html` (HTML)
+    // * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX)
+    // * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX)
+    // * `text/plain` (TXT)
     //
     // See https://www.iana.org/assignments/media-types/media-types.xhtml.
     string mime_type = 1;
@@ -72,13 +75,13 @@ message Document {
   // provided otherwise an `INVALID_ARGUMENT` error is thrown.
   oneof data {
     // The structured JSON data for the document. It should conform to the
-    // registered [Schema.schema][google.cloud.discoveryengine.v1.Schema.schema]
-    // or an `INVALID_ARGUMENT` error is thrown.
+    // registered [Schema][google.cloud.discoveryengine.v1.Schema] or an
+    // `INVALID_ARGUMENT` error is thrown.
     google.protobuf.Struct struct_data = 4;
 
     // The JSON string representation of the document. It should conform to the
-    // registered [Schema.schema][google.cloud.discoveryengine.v1.Schema.schema]
-    // or an `INVALID_ARGUMENT` error is thrown.
+    // registered [Schema][google.cloud.discoveryengine.v1.Schema] or an
+    // `INVALID_ARGUMENT` error is thrown.
     string json_data = 5;
   }
 

package/build/protos/google/cloud/discoveryengine/v1/document_service.proto

@@ -187,9 +187,10 @@ message ListDocumentsRequest {
   // Use `default_branch` as the branch ID, to list documents under the default
   // branch.
   //
-  // If the caller does not have permission to list [Documents][]s under this
-  // branch, regardless of whether or not this branch exists, a
-  // `PERMISSION_DENIED` error is returned.
+  // If the caller does not have permission to list
+  // [Document][google.cloud.discoveryengine.v1.Document]s under this branch,
+  // regardless of whether or not this branch exists, a `PERMISSION_DENIED`
+  // error is returned.
   string parent = 1 [
     (google.api.field_behavior) = REQUIRED,
     (google.api.resource_reference) = {

package/build/protos/google/cloud/discoveryengine/v1/import_config.proto

@@ -54,11 +54,15 @@ message GcsSource {
   // document must
   //   have a valid [Document.id][google.cloud.discoveryengine.v1.Document.id].
   // * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by
-  //   `input_uris` will become a document, with the ID set to the first 128
+  //   `input_uris` becomes a document, with the ID set to the first 128
   //   bits of SHA256(URI) encoded as a hex string.
   // * `custom`: One custom data JSON per row in arbitrary format that conforms
-  //   the defined [Schema][google.cloud.discoveryengine.v1.Schema] of the data
-  //   store. This can only be used by the GENERIC Data Store vertical.
+  //   to the defined [Schema][google.cloud.discoveryengine.v1.Schema] of the
+  //   data store. This can only be used by Gen App Builder.
+  // * `csv`: A CSV file with header conforming to the defined
+  // [Schema][google.cloud.discoveryengine.v1.Schema] of the
+  //   data store. Each entry after the header is imported as a Document.
+  //   This can only be used by Gen App Builder.
   //
   // Supported values for user even imports:
   //
@@ -110,9 +114,9 @@ message BigQuerySource {
   //   [Document.json_data][google.cloud.discoveryengine.v1.Document.json_data]
   //   or
   //   [Document.struct_data][google.cloud.discoveryengine.v1.Document.struct_data].
-  // * `custom`: One custom data per row in arbitrary format that conforms the
-  //   defined [Schema][google.cloud.discoveryengine.v1.Schema] of the data
-  //   store. This can only be used by the GENERIC Data Store vertical.
+  // * `custom`: One custom data per row in arbitrary format that conforms to
+  //   the defined [Schema][google.cloud.discoveryengine.v1.Schema] of the data
+  //   store. This can only be used by Gen App Builder.
   string data_schema = 6;
 }
 
@@ -121,7 +125,7 @@ message ImportErrorConfig {
   // Required. Errors destination.
   oneof destination {
     // Cloud Storage prefix for import errors. This must be an empty,
-    // existing Cloud Storage directory. Import errors will be written to
+    // existing Cloud Storage directory. Import errors are written to
     // sharded files in this directory, one per line, as a JSON-encoded
     // `google.rpc.Status` message.
     string gcs_prefix = 1;
@@ -136,16 +140,16 @@ message ImportUserEventsRequest {
     repeated UserEvent user_events = 1 [(google.api.field_behavior) = REQUIRED];
   }
 
-  // The desired input source of the user event data.
+  // Required - The desired input source of the user event data.
   oneof source {
-    // Required. The Inline source for the input content for UserEvents.
-    InlineSource inline_source = 2 [(google.api.field_behavior) = REQUIRED];
+    // The Inline source for the input content for UserEvents.
+    InlineSource inline_source = 2;
 
-    // Required. Cloud Storage location for the input content.
-    GcsSource gcs_source = 3 [(google.api.field_behavior) = REQUIRED];
+    // Cloud Storage location for the input content.
+    GcsSource gcs_source = 3;
 
-    // Required. BigQuery input source.
-    BigQuerySource bigquery_source = 4 [(google.api.field_behavior) = REQUIRED];
+    // BigQuery input source.
+    BigQuerySource bigquery_source = 4;
   }
 
   // Required. Parent DataStore resource name, of the form
@@ -181,7 +185,7 @@ message ImportUserEventsResponse {
   int64 unjoined_events_count = 4;
 }
 
-// Metadata related to the progress of the Import operation. This will be
+// Metadata related to the progress of the Import operation. This is
 // returned by the google.longrunning.Operation.metadata field.
 message ImportUserEventsMetadata {
   // Operation create time.
@@ -198,8 +202,8 @@ message ImportUserEventsMetadata {
   int64 failure_count = 4;
 }
 
-// Metadata related to the progress of the ImportDocuments operation. This will
-// be returned by the google.longrunning.Operation.metadata field.
+// Metadata related to the progress of the ImportDocuments operation. This is
+// returned by the google.longrunning.Operation.metadata field.
 message ImportDocumentsMetadata {
   // Operation create time.
   google.protobuf.Timestamp create_time = 1;
@@ -228,7 +232,7 @@ message ImportDocumentsRequest {
   // Indicates how imported documents are reconciled with the existing documents
   // created or imported before.
   enum ReconciliationMode {
-    // Defaults to INCREMENTAL.
+    // Defaults to `INCREMENTAL`.
     RECONCILIATION_MODE_UNSPECIFIED = 0;
 
     // Inserts new documents or updates existing documents.
@@ -280,7 +284,7 @@ message ImportDocumentsRequest {
   // `false`, [Document.id][google.cloud.discoveryengine.v1.Document.id]s have
   // to be specified using
   // [id_field][google.cloud.discoveryengine.v1.ImportDocumentsRequest.id_field],
-  // otherwises, documents without IDs will fail to be imported.
+  // otherwise, documents without IDs fail to be imported.
   //
   // Only set this field when using
   // [GcsSource][google.cloud.discoveryengine.v1.GcsSource] or
@@ -288,7 +292,7 @@ message ImportDocumentsRequest {
   // [GcsSource.data_schema][google.cloud.discoveryengine.v1.GcsSource.data_schema]
   // or
   // [BigQuerySource.data_schema][google.cloud.discoveryengine.v1.BigQuerySource.data_schema]
-  // is `custom`. Otherwise, an INVALID_ARGUMENT error is thrown.
+  // is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
   bool auto_generate_ids = 8;
 
   // The field in the Cloud Storage and BigQuery sources that indicates the
@@ -299,12 +303,12 @@ message ImportDocumentsRequest {
   // For [BigQuerySource][google.cloud.discoveryengine.v1.BigQuerySource] it is
   // the column name of the BigQuery table where the unique ids are stored.
   //
-  // The values of the JSON field or the BigQuery column will be used as the
+  // The values of the JSON field or the BigQuery column are used as the
   // [Document.id][google.cloud.discoveryengine.v1.Document.id]s. The JSON field
   // or the BigQuery column must be of string type, and the values must be set
   // as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
-  // with 1-63 characters. Otherwise, documents without valid IDs will fail to
-  // be imported.
+  // with 1-63 characters. Otherwise, documents without valid IDs fail to be
+  // imported.
   //
   // Only set this field when using
   // [GcsSource][google.cloud.discoveryengine.v1.GcsSource] or

package/build/protos/google/cloud/discoveryengine/v1/schema.proto

@@ -40,7 +40,7 @@ message Schema {
   // Schema representation. One of
   // [struct_schema][google.cloud.discoveryengine.v1.Schema.struct_schema] or
   // [json_schema][google.cloud.discoveryengine.v1.Schema.json_schema] should be
-  // provided otherwise an INVALID_ARGUMENT error is thrown.
+  // provided otherwise an `INVALID_ARGUMENT` error is thrown.
   oneof schema {
     // The structured representation of the schema.
     google.protobuf.Struct struct_schema = 2;