googleapis · parthea · Sep 2, 2025 · Sep 2, 2025 · Sep 2, 2025 · Sep 2, 2025
@@ -1213,7 +1213,7 @@ async def sample_set_acl():
                 ``>``, and ``>=`` where the left of the operator is
                 ``DocumentSchemaId`` or property name and the right of
                 the operator is a number or a quoted string. You must
-                escape backslash (\) and quote (") characters.
+                escape backslash (\\) and quote (") characters.
 
                 Boolean expressions (AND/OR) are supported up to 3
                 levels of nesting (for example, "((A AND B AND C) OR D)

@@ -1648,7 +1648,7 @@ def sample_set_acl():
                 ``>``, and ``>=`` where the left of the operator is
                 ``DocumentSchemaId`` or property name and the right of
                 the operator is a number or a quoted string. You must
-                escape backslash (\) and quote (") characters.
+                escape backslash (\\) and quote (") characters.
 
                 Boolean expressions (AND/OR) are supported up to 3
                 levels of nesting (for example, "((A AND B AND C) OR D)

@@ -286,48 +286,47 @@ class SearchDocumentsRequest(proto.Message):
 
             Supported options are:
 
-            -  ``"relevance desc"``: By relevance descending, as
-               determined by the API algorithms.
-            -  ``"upload_date desc"``: By upload date descending.
-            -  ``"upload_date"``: By upload date ascending.
-            -  ``"update_date desc"``: By last updated date descending.
-            -  ``"update_date"``: By last updated date ascending.
-            -  ``"retrieval_importance desc"``: By retrieval importance
-               of properties descending. This feature is still under
-               development, please do not use unless otherwise
-               instructed to do so.
+            - ``"relevance desc"``: By relevance descending, as
+              determined by the API algorithms.
+            - ``"upload_date desc"``: By upload date descending.
+            - ``"upload_date"``: By upload date ascending.
+            - ``"update_date desc"``: By last updated date descending.
+            - ``"update_date"``: By last updated date ascending.
+            - ``"retrieval_importance desc"``: By retrieval importance
+              of properties descending. This feature is still under
+              development, please do not use unless otherwise instructed
+              to do so.
         histogram_queries (MutableSequence[google.cloud.contentwarehouse_v1.types.HistogramQuery]):
             An expression specifying a histogram request against
             matching documents. Expression syntax is an aggregation
             function call with histogram facets and other options.
 
             The following aggregation functions are supported:
 
-            -  ``count(string_histogram_facet)``: Count the number of
-               matching entities for each distinct attribute value.
+            - ``count(string_histogram_facet)``: Count the number of
+              matching entities for each distinct attribute value.
 
             Data types:
 
-            -  Histogram facet (aka filterable properties): Facet names
-               with format <schema id>.<facet>. Facets will have the
-               format of: ``[a-zA-Z][a-zA-Z0-9_:/-.]``. If the facet is
-               a child facet, then the parent hierarchy needs to be
-               specified separated by dots in the prefix after the
-               schema id. Thus, the format for a multi- level facet is:
-               <schema id>.<parent facet name>. <child facet name>.
-               Example:
-               schema123.root_parent_facet.middle_facet.child_facet
-            -  DocumentSchemaId: (with no schema id prefix) to get
-               histograms for each document type (returns the schema id
-               path, e.g.
-               projects/12345/locations/us-west/documentSchemas/abc123).
+            - Histogram facet (aka filterable properties): Facet names
+              with format <schema id>.<facet>. Facets will have the
+              format of: ``[a-zA-Z][a-zA-Z0-9_:/-.]``. If the facet is a
+              child facet, then the parent hierarchy needs to be
+              specified separated by dots in the prefix after the schema
+              id. Thus, the format for a multi- level facet is: <schema
+              id>.<parent facet name>. <child facet name>. Example:
+              schema123.root_parent_facet.middle_facet.child_facet
+            - DocumentSchemaId: (with no schema id prefix) to get
+              histograms for each document type (returns the schema id
+              path, e.g.
+              projects/12345/locations/us-west/documentSchemas/abc123).
 
             Example expression:
 
-            -  Document type counts: count('DocumentSchemaId')
+            - Document type counts: count('DocumentSchemaId')
 
-            -  For schema id, abc123, get the counts for MORTGAGE_TYPE:
-               count('abc123.MORTGAGE_TYPE')
+            - For schema id, abc123, get the counts for MORTGAGE_TYPE:
+              count('abc123.MORTGAGE_TYPE')
         require_total_size (bool):
             Controls if the search document request requires the return
             of a total size of matched documents. See
@@ -504,7 +503,7 @@ class SetAclRequest(proto.Message):
             ``>``, and ``>=`` where the left of the operator is
             ``DocumentSchemaId`` or property name and the right of the
             operator is a number or a quoted string. You must escape
-            backslash (\) and quote (") characters.
+            backslash (\\) and quote (") characters.
 
             Boolean expressions (AND/OR) are supported up to 3 levels of
             nesting (for example, "((A AND B AND C) OR D) AND E"), a

@@ -102,7 +102,7 @@ class DocumentQuery(proto.Message):
             Supported operators are: ``=``, ``!=``, ``<``, ``<=``,
             ``>``, and ``>=`` where the left of the operator is a
             property name and the right of the operator is a number or a
-            quoted string. You must escape backslash (\) and quote (")
+            quoted string. You must escape backslash (\\) and quote (")
             characters. Supported functions are
             ``LOWER([property_name])`` to perform a case insensitive
             match and ``EMPTY([property_name])`` to filter on the
@@ -294,8 +294,8 @@ class PropertyFilter(proto.Message):
             Supported operators are: ``=``, ``!=``, ``<``, ``<=``,
             ``>``, ``>=``, and ``~~`` where the left of the operator is
             a property name and the right of the operator is a number or
-            a quoted string. You must escape backslash (\) and quote (")
-            characters.
+            a quoted string. You must escape backslash (\\) and quote
+            (") characters.
 
             ``~~`` is the LIKE operator. The right of the operator must
             be a string. The only supported property data type for LIKE
@@ -331,8 +331,8 @@ class PropertyFilter(proto.Message):
 
             CMEK compliant deployment only supports:
 
-            -  Operators: ``=``, ``<``, ``<=``, ``>``, and ``>=``.
-            -  Boolean expressions: AND and OR.
+            - Operators: ``=``, ``<``, ``<=``, ``>``, and ``>=``.
+            - Boolean expressions: AND and OR.
     """
 
     document_schema_name: str = proto.Field(

@@ -142,7 +142,7 @@ class HistogramQueryResult(proto.Message):
 
             The key format is:
 
-            -  (for string histogram) string values stored in the field.
+            - (for string histogram) string values stored in the field.
     """
 
     histogram_query: str = proto.Field(

@@ -253,17 +253,17 @@ class IngestPipelineConfig(proto.Message):
             The following roles are supported for document level acl
             control:
 
-            -  roles/contentwarehouse.documentAdmin
-            -  roles/contentwarehouse.documentEditor
-            -  roles/contentwarehouse.documentViewer
+            - roles/contentwarehouse.documentAdmin
+            - roles/contentwarehouse.documentEditor
+            - roles/contentwarehouse.documentViewer
 
             The following members are supported for document level acl
             control:
 
-            -  user:user-email@example.com
-            -  group:group-email@example.com Note that for documents
-               searched with LLM, only single level user or group acl
-               check is supported.
+            - user:user-email@example.com
+            - group:group-email@example.com Note that for documents
+              searched with LLM, only single level user or group acl
+              check is supported.
         enable_document_text_extraction (bool):
             The document text extraction enabled flag.
             If the flag is set to true, DWH will perform
@@ -282,25 +282,25 @@ class IngestPipelineConfig(proto.Message):
             ``https://{region}-{project_id}.cloudfunctions.net/{cloud_function}``
             The following keys are available the request json payload.
 
-            -  display_name
-            -  properties
-            -  plain_text
-            -  reference_id
-            -  document_schema_name
-            -  raw_document_path
-            -  raw_document_file_type
+            - display_name
+            - properties
+            - plain_text
+            - reference_id
+            - document_schema_name
+            - raw_document_path
+            - raw_document_file_type
 
             The following keys from the cloud function json response
             payload will be ingested to the Document AI Warehouse as
             part of Document proto content and/or related information.
             The original values will be overridden if any key is present
             in the response.
 
-            -  display_name
-            -  properties
-            -  plain_text
-            -  document_acl_policy
-            -  folder
+            - display_name
+            - properties
+            - plain_text
+            - document_acl_policy
+            - folder
     """
 
     document_acl_policy: policy_pb2.Policy = proto.Field(

@@ -365,9 +365,10 @@ def docs(session):
         "-T",  # show full traceback on exception
         "-N",  # no colors
         "-b",
-        "html",
+        "html",  # builder
         "-d",
-        os.path.join("docs", "_build", "doctrees", ""),
+        os.path.join("docs", "_build", "doctrees", ""),  # cache directory
+        # paths to build:
         os.path.join("docs", ""),
         os.path.join("docs", "_build", "html", ""),
     )

@@ -365,9 +365,10 @@ def docs(session):
         "-T",  # show full traceback on exception
         "-N",  # no colors
         "-b",
-        "html",
+        "html",  # builder
         "-d",
-        os.path.join("docs", "_build", "doctrees", ""),
+        os.path.join("docs", "_build", "doctrees", ""),  # cache directory
+        # paths to build:
         os.path.join("docs", ""),
         os.path.join("docs", "_build", "html", ""),
     )

@@ -39,9 +39,9 @@ class AnnotatedString(proto.Message):
 
     Table Data:
 
-    -  "country" - dimension
-    -  "population" - metric
-    -  "Africa" - value in the "continent" column
+    - "country" - dimension
+    - "population" - metric
+    - "Africa" - value in the "continent" column
 
     text_formatted = ``"top countries by population in Africa"``
 

@@ -365,9 +365,10 @@ def docs(session):
         "-T",  # show full traceback on exception
         "-N",  # no colors
         "-b",
-        "html",
+        "html",  # builder
         "-d",
-        os.path.join("docs", "_build", "doctrees", ""),
+        os.path.join("docs", "_build", "doctrees", ""),  # cache directory
+        # paths to build:
         os.path.join("docs", ""),
         os.path.join("docs", "_build", "html", ""),
     )

@@ -1229,9 +1229,9 @@ class Origin(proto.Message):
             must match the project and location of the lineage resource
             being created. Examples:
 
-            -  ``{source_type: COMPOSER, name: "projects/foo/locations/us/environments/bar"}``
-            -  ``{source_type: BIGQUERY, name: "projects/foo/locations/eu"}``
-            -  ``{source_type: CUSTOM, name: "myCustomIntegration"}``
+            - ``{source_type: COMPOSER, name: "projects/foo/locations/us/environments/bar"}``
+            - ``{source_type: BIGQUERY, name: "projects/foo/locations/eu"}``
+            - ``{source_type: CUSTOM,   name: "myCustomIntegration"}``
     """
 
     class SourceType(proto.Enum):

@@ -365,9 +365,10 @@ def docs(session):
         "-T",  # show full traceback on exception
         "-N",  # no colors
         "-b",
-        "html",
+        "html",  # builder
         "-d",
-        os.path.join("docs", "_build", "doctrees", ""),
+        os.path.join("docs", "_build", "doctrees", ""),  # cache directory
+        # paths to build:
         os.path.join("docs", ""),
         os.path.join("docs", "_build", "html", ""),
     )