Package Classes (0.7.8)

This service lets you manage document-links. Document-Links are treated as sub-resources under source documents.

This service lets you manage document-links. Document-Links are treated as sub-resources under source documents.

A pager for iterating through list_linked_sources requests.

This class thinly wraps an initial ListLinkedSourcesResponse object, and provides an __aiter__ method to iterate through its document_links field.

If there are more pages, the __aiter__ method will make additional ListLinkedSources requests and continue to iterate through the document_links field on the corresponding responses.

All the usual ListLinkedSourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_linked_sources requests.

This class thinly wraps an initial ListLinkedSourcesResponse object, and provides an __iter__ method to iterate through its document_links field.

If there are more pages, the __iter__ method will make additional ListLinkedSources requests and continue to iterate through the document_links field on the corresponding responses.

All the usual ListLinkedSourcesResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

This service lets you manage document schema.

This service lets you manage document schema.

A pager for iterating through list_document_schemas requests.

This class thinly wraps an initial ListDocumentSchemasResponse object, and provides an __aiter__ method to iterate through its document_schemas field.

If there are more pages, the __aiter__ method will make additional ListDocumentSchemas requests and continue to iterate through the document_schemas field on the corresponding responses.

All the usual ListDocumentSchemasResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_document_schemas requests.

This class thinly wraps an initial ListDocumentSchemasResponse object, and provides an __iter__ method to iterate through its document_schemas field.

If there are more pages, the __iter__ method will make additional ListDocumentSchemas requests and continue to iterate through the document_schemas field on the corresponding responses.

All the usual ListDocumentSchemasResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

This service lets you manage document.

This service lets you manage document.

A pager for iterating through search_documents requests.

This class thinly wraps an initial SearchDocumentsResponse object, and provides an __aiter__ method to iterate through its matching_documents field.

If there are more pages, the __aiter__ method will make additional SearchDocuments requests and continue to iterate through the matching_documents field on the corresponding responses.

All the usual SearchDocumentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through search_documents requests.

This class thinly wraps an initial SearchDocumentsResponse object, and provides an __iter__ method to iterate through its matching_documents field.

If there are more pages, the __iter__ method will make additional SearchDocuments requests and continue to iterate through the matching_documents field on the corresponding responses.

All the usual SearchDocumentsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

This service lets you manage pipelines.

This service lets you manage pipelines.

Service to manage customer specific RuleSets.

Service to manage customer specific RuleSets.

A pager for iterating through list_rule_sets requests.

This class thinly wraps an initial ListRuleSetsResponse object, and provides an __aiter__ method to iterate through its rule_sets field.

If there are more pages, the __aiter__ method will make additional ListRuleSets requests and continue to iterate through the rule_sets field on the corresponding responses.

All the usual ListRuleSetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_rule_sets requests.

This class thinly wraps an initial ListRuleSetsResponse object, and provides an __iter__ method to iterate through its rule_sets field.

If there are more pages, the __iter__ method will make additional ListRuleSets requests and continue to iterate through the rule_sets field on the corresponding responses.

All the usual ListRuleSetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A Service that manage/custom customer specified SynonymSets.

A Service that manage/custom customer specified SynonymSets.

A pager for iterating through list_synonym_sets requests.

This class thinly wraps an initial ListSynonymSetsResponse object, and provides an __aiter__ method to iterate through its synonym_sets field.

If there are more pages, the __aiter__ method will make additional ListSynonymSets requests and continue to iterate through the synonym_sets field on the corresponding responses.

All the usual ListSynonymSetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

A pager for iterating through list_synonym_sets requests.

This class thinly wraps an initial ListSynonymSetsResponse object, and provides an __iter__ method to iterate through its synonym_sets field.

If there are more pages, the __iter__ method will make additional ListSynonymSets requests and continue to iterate through the synonym_sets field on the corresponding responses.

All the usual ListSynonymSetsResponse attributes are available on the pager. If multiple requests are made, only the most recent response is retained, and thus used for attribute lookup.

Represents the action responsible for access control list management operations.

Type of ACL modification operation.

Access Control Mode.

Represents the action triggered by Rule Engine when the rule is true.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Represents the output of the Action Executor.

Represents the result of executing an action.

Represents execution state of the action.

Represents the action responsible for adding document under a folder.

Request Option for processing Cloud AI Document in CW Document.

The abstract base class for a message.

When a raw document or structured content is supplied, this stores the content category.

Request message for DocumentLinkService.CreateDocumentLink.

Metadata object for CreateDocument request (currently empty).

Request message for DocumentService.CreateDocument.

Response message for DocumentService.CreateDocument.

Request message for DocumentSchemaService.CreateDocumentSchema.

Request message for RuleSetService.CreateRuleSet.

Request message for SynonymSetService.CreateSynonymSet.

To support the custom weighting across document schemas.

Represents the action responsible for properties update operations.

The abstract base class for a message.

Represents the action responsible for data validation operations.

The abstract base class for a message.

Type of database used by the customer

DateTime values.

Configurations for a date time property.

Represents the action responsible for deleting the document.

Request message for DocumentLinkService.DeleteDocumentLink.

Request message for DocumentService.DeleteDocument.

Request message for DocumentSchemaService.DeleteDocumentSchema.

Request message for RuleSetService.DeleteRuleSet.

Request message for SynonymSetService.DeleteSynonymSet.

Defines the structure for content warehouse document proto.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The default role of the document creator.

A document-link between source and target document.

The state of a document-link.

References to the documents.

A document schema used to define document structure.

Enum values.

Configurations for an enum/categorical property.

Represents the string value of the enum field.

The configuration of exporting documents from the Document Warehouse to CDW pipeline.

Request message for DocumentService.FetchAcl

Response message for DocumentService.FetchAcl.

Filter for the specific types of documents returned.

Representation of the types of files.

Float values.

Configurations for a float property.

The configuration of the Cloud Storage Ingestion pipeline.

The configuration of the Cloud Storage Ingestion with DocAI Processors pipeline.

Request message for DocumentService.GetDocument.

Request message for DocumentSchemaService.GetDocumentSchema.

Request message for RuleSetService.GetRuleSet.

Request message for SynonymSetService.GetSynonymSet. Will return synonymSet for a certain context.

The histogram request.

The result of the histogram query count('FilterableProperties') using HISTOGRAM_YAXIS_DOCUMENT will be: invoice_id: 2 address: 1 payment_method: 2 line_item_description: 1

Histogram result that matches HistogramQuery specified in searches.

The abstract base class for a message.

The ingestion pipeline config.

Integer values.

Configurations for an integer property.

A triggered rule that failed the validation check(s) after parsing.

Request message for DocumentSchemaService.ListDocumentSchemas.

Response message for DocumentSchemaService.ListDocumentSchemas.

Response message for DocumentLinkService.ListLinkedSources.

Response message for DocumentLinkService.ListLinkedSources.

Request message for DocumentLinkService.ListLinkedTargets.

Response message for DocumentLinkService.ListLinkedTargets.

Request message for RuleSetService.ListRuleSets.

Response message for RuleSetService.ListRuleSets.

Request message for SynonymSetService.ListSynonymSets. Will return all synonymSets belonging to the customer project.

Response message for SynonymSetService.ListSynonymSets.

Request message for DocumentService.LockDocument.

Map property value. Represents a structured entries of key value pairs, consisting of field names which map to dynamically typed values.

The abstract base class for a message.

Configurations for a Map property.

Options for merging updated fields.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The configuration of processing documents in Document Warehouse with DocAi processors pipeline.

The DocAI processor information.

Property of a document.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Property values.

Defines the metadata for a schema property.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Stores the retrieval importance.

The schema source information.

Configurations for a nested structured data property.

Represents the action responsible for publishing messages to a Pub/Sub topic.

Additional result info for the question-answering feature.

A text span in the search text snippet that represents a highlighted section (answer context, highly relevant sentence, etc.).

When a raw document is supplied, this indicates the file format

Represents the action responsible for remove a document from a specific folder.

Meta information is used to improve the performance of the service.

Additional information returned to client, such as debugging information.

Represents the rule for a content warehouse trigger.

The trigger types for actions.

Represents a rule and outputs of associated actions.

Records the output of Rule Engine including rule evaluation and actions result.

Represents the output of the Rule Evaluator.

Represents a set of rules from a single customer.

Metadata message of RunPipeline method.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

The metadata message for Export-to-CDW pipeline.

The metadata message for GcsIngest pipeline.

The status of processing a document.

The metadata message for Process-with-DocAi pipeline.

Request message for DocumentService.RunPipeline.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Response message of RunPipeline method.

Request message for DocumentService.SearchDocuments.

The total number of matching documents.

Response message for DocumentService.SearchDocuments.

Document entry with metadata inside SearchDocumentsResponse

Request message for DocumentService.SetAcl.

Response message for DocumentService.SetAcl.

Represents a list of synonyms for a given context. For example a context "sales" could contain:

Synonym 1: sale, invoice, bill, order Synonym 2: money, credit, finance, payment Synonym 3: shipping, freight, transport Each SynonymSets should be disjoint

Represents a list of words given by the customer All these words are synonyms of each other.

String/text values.

Configurations for a text property.

Filter on create timestamp or update timestamp of documents.

Time field used in TimeFilter.

Timestamp values.

Configurations for a timestamp property.

Timestamp value type.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Metadata object for UpdateDocument request (currently empty).

Request message for DocumentService.UpdateDocument.

Response message for DocumentService.UpdateDocument.

Request message for DocumentSchemaService.UpdateDocumentSchema.

Options for Update operations.

Request message for RuleSetService.UpdateRuleSet.

Request message for SynonymSetService.UpdateSynonymSet. Removes the SynonymSet for the specified context and replaces it with the SynonymSet in this request.

Update type of the requests.

The user information.

Value represents a dynamically typed value which can be either be a float, a integer, a string, or a datetime value. A producer of value is expected to set one of these variants. Absence of any variant indicates an error.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Specifies the schema property name.

API documentation for contentwarehouse_v1.services.document_link_service.pagers module.

API documentation for contentwarehouse_v1.services.document_schema_service.pagers module.

API documentation for contentwarehouse_v1.services.document_service.pagers module.

API documentation for contentwarehouse_v1.services.rule_set_service.pagers module.

API documentation for contentwarehouse_v1.services.synonym_set_service.pagers module.